Example Queries: Advertiser Search Service

The Advertiser Search Service is a SOAP (Simple Object Access Protocol)-based API that enables developers to find advertisers in the Commission Junction network based on desired criteria. Refer to the following use cases for examples of this service.

Use Case #1

The user would like to list all advertisers selling shoes using banner ads targeting the United States. The user would like to see the records sorted by 3 month EPC (Earnings Per Click) in descending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

category

shoes

targetedArea

us

linkType

banner

sortBy

ThreeMonthEPC

sortOrder

desc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="https://linksearch.api.cj.com">

   <soapenv:Header/>

   <soapenv:Body>

      <api:search>

         <api:developerKey></api:developerKey>

         <api:token></api:token>

         <api:keywords></api:keywords>

         <api:category>shoes</api:category>

         <api:linkType>banner</api:linkType>

         <api:linkSize></api:linkSize>

         <api:language></api:language>

         <api:serviceableArea>us</api:serviceableArea>

         <api:sortBy>ThreeMonthEPC</api:sortBy>

         <api:sortOrder>desc</api:sortOrder>

         <api:startAt>0</api:startAt>

         <api:maxResults>100</api:maxResults>

      </api:search>

   </soapenv:Body>

</soapenv:Envelope>

Response

<advertisers>

               <advertisers>

                  <cid >176925</cid>

                  <clickCommission>0.0</clickCommission>

                  <leadCommission />

                  <linkTypes>

                     <linkTypes >Banner</linkTypes>

                     <linkTypes>Text Link</linkTypes>

                     <linkTypes >Keyword Link</linkTypes>

                  </linkTypes>

                  <name >shoesandstuff.com</name>

                  <networkRank >6</networkRank>

                  <performanceIncentives>false</performanceIncentives>

                  <primaryCategoryId>305</primaryCategoryId>

                  <primaryCategoryName />

                  <relationshipStatus />

                  <saleCommission>0.1%</saleCommission>

                  <sevenDayEPC>9999999.0</sevenDayEPC>

                  <threeMonthEPC>9999999.0</threeMonthEPC>

               </advertisers>