Example Queries: Link Search Service

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

Use Case #1

A user would like to list all of the full banner links from all advertisers selling consumer electronics. The user would like see the records sorted by advertiser ID 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).

websiteId

Your Web site ID (PID), which much match the Web site PID you used to register your developer key (Required).

category

consumer electronics

linkType

banner

sortBy

advertiserId

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:searchLinks>

         <api:developerKey></api:developerKey>

         <api:token></api:token>

         <api:websiteId>12345</api:websiteId>

         <api:advertiserIds></api:advertiserIds>

         <api:keywords></api:keywords>

         <api:category>consumer electronics</api:category>

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

         <api:linkSize></api:linkSize>

         <api:language></api:language>

         <api:serviceableArea></api:serviceableArea>

         <api:promotionType></api:promotionType>

         <api:startDate></api:startDate>

         <api:endDate></api:endDate>

         <api:sortBy>advertiserId</api:sortBy>

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

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

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

      </api:searchLinks>

   </soapenv:Body>

</soapenv:Envelope>

Response

<LinkDetail>

                  <advertiserId>22901</advertiserId>

                  <advertiserName>IN THE HOLE! GOLF</advertiserName>

                  <category>consumer electronics</category>

                  <clickCommission />

                  <creativeHeight>125</creativeHeight>

                  <creativeWidth>125</creativeWidth>

                  <language>en</language>

                  <leadCommission />

                  <linkCodeHTML>&lt;a href="http://www.tkqlhce.com/click-1610923-10469356">

&lt;img src="http://www.tqlkg.com/image-1610923-10469356" width="125" height="125" alt="null" border="0"/>&lt;/a></linkCodeHTML>

                  <linkCodeJavascript>&lt;form name="CJ10469356X1" method="POST" style="margin:0px;display:inline" action="http://www.kqzyfj.com/click">

&lt;input type="hidden" name="aid" value="10469356"/>

&lt;input type="hidden" name="pid" value="1610923"/>

&lt;input type="image" src="http://www.ftjcfx.com/image-1610923-10469356" width="125" height="125" alt="null" border="0"/>

&lt;/form></linkCodeJavascript>

                  <linkDescription>IN THE HOLE! Golf - Golf Equipment &amp; Training Aids</linkDescription>

                  <linkDestination>http://www.intheholegolf.com</linkDestination>

                  <linkId>109356</linkId>

                  <linkName>IN THE HOLE! Golf</linkName>

                  <linkType>Banner</linkType>

                  <networkRank />

                  <performanceIncentives />

                  <promotionEndDate/>

                  <promotionStartDate/>

                  <promotionType>product</promotionType>

                  <relationshipStatus>notjoined</relationshipStatus>

                  <saleCommission />

                  <sevenDayEPC />

                  <threeMonthEPC />

               </LinkDetail>

Use Case #2

A user would like to list all text links from joined advertisers selling consumer electronics, and target the United States. The user would like to see the records sorted by advertiser name in ascending 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).

websiteId

Your Web site ID (PID), which much match the Web site PID you used to register your developer key (Required).

advertiserIds

joined

category

consumer electronics

targetedArea

US

linkType

text link

sortBy

advertiserName

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:searchLinks>

         <api:developerKey></api:developerKey>

         <api:token></api:token>

         <api:websiteId>12345</api:websiteId>

         <api:advertiserIds>joined</api:advertiserIds>

         <api:keywords></api:keywords>

         <api:category>consumer electronics</api:category>

         <api:linkType>text link</api:linkType>

         <api:linkSize></api:linkSize>

         <api:language></api:language>

         <api:serviceableArea>US</api:serviceableArea>

         <api:promotionType></api:promotionType>

         <api:startDate></api:startDate>

         <api:endDate></api:endDate>

         <api:sortBy>advertiserName</api:sortBy>

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

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

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

      </api:searchLinks>

   </soapenv:Body>

</soapenv:Envelope>

Response

 <LinkDetail>

                  <advertiserId>123456</advertiserId>

                  <advertiserName>Electronics50.com</advertiserName>

                  <category>consumer electronics</category>

                  <clickCommission>0.0</clickCommission>

                  <creativeHeight>600</creativeHeight>

                  <creativeWidth>120</creativeWidth>

                  <language>en</language>

                  <leadCommission>0.0</leadCommission>

                  <linkCodeHTML>&lt;a href="http://www.dpbolvw.net/click-1610923-10304531">

&lt;img src="http://www.lduhtrp.net/image-1610923-10304531" width="120" height="600" alt="null" border="0"/>&lt;/a></linkCodeHTML>

                  <linkCodeJavascript>&lt;form name="CJ10304531X1" method="POST" style="margin:0px;display:inline" action="http://www.tkqlhce.com/click">

&lt;input type="hidden" name="aid" value="10304531"/>

&lt;input type="hidden" name="pid" value="1610923"/>

&lt;input type="image" src="http://www.lduhtrp.net/image-1610923-10304531" width="120" height="600" alt="null" border="0"/>

&lt;/form></linkCodeJavascript>

                  <linkDescription>Electronics50.com discount electronics text link</linkDescription>

                  <linkDestination>http://www.electronics50.com</linkDestination>

                  <linkId>103531</linkId>

                  <linkName>discount electronics</linkName>

                  <linkType>text link</linkType>

                  <networkRank xsi:nil="true"/>

                  <performanceIncentives>false</performanceIncentives>

                  <promotionEndDate/>

                  <promotionStartDate/>

                  <promotionType/>

                  <relationshipStatus>joined</relationshipStatus>

                  <saleCommission>0.0 - 0.0</saleCommission>

                  <sevenDayEPC>-9999999.0</sevenDayEPC>

                  <threeMonthEPC>0.0</threeMonthEPC>

               </LinkDetail>

Use Case #3

I would like to list all free shipping promotional links with an ongoing promotional date from all advertisers that sell consumer electronics and that target the United States. The user would like to see the records sorted by advertiser name 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).

websiteId

Your Web site ID (PID), which much match the Web site PID you used to register your developer key (Required).

advertiserIds

joined

category

consumer electronics

targetedArea

US

promotionType

free shipping

promotionEnddate

ongoing

sortBy

advertiserName

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:searchLinks>

         <api:developerKey></api:developerKey>

         <api:token></api:token>

         <api:websiteId>12345</api:websiteId>

         <api:advertiserIds>joined</api:advertiserIds>

         <api:keywords></api:keywords>

         <api:category>consumer electronics</api:category>

         <api:linkType></api:linkType>

         <api:linkSize></api:linkSize>

         <api:language></api:language>

         <api:serviceableArea>US</api:serviceableArea>

         <api:promotionType>free shipping</api:promotionType>

         <api:startDate></api:startDate>

         <api:endDate>ongoing</api:endDate>

         <api:sortBy>advertiserName</api:sortBy>

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

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

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

      </api:searchLinks>

   </soapenv:Body>

</soapenv:Envelope>

Response

<LinkDetail>

                  <advertiserId>4557</advertiserId>

                  <advertiserName>Online Sports</advertiserName>

                  <category>consumer electronics</category>

                  <clickCommission>0.0</clickCommission>

                  <creativeHeight>0</creativeHeight>

                  <creativeWidth>0</creativeWidth>

                  <language>en</language>

                  <leadCommission>0.0</leadCommission>

                  <linkCodeHTML>&lt;a href="http://www.electronics50.net/click-1610923-10465758">FREE SHIPPING&lt;/a> on All hard drives for a limited time only!  NBA and NFL!

&lt;img src="http://www.tqlkg.com/image-1610923-10465758" width="1" height="1" border="0"/></linkCodeHTML>

                  <linkCodeJavascript>&lt;form name="CJ10465758X1" method="POST" style="margin:0px;display:inline" action="http://www.tkqlhce.com/click">

&lt;input type="hidden" name="aid" value="10465758"/>

&lt;input type="hidden" name="pid" value="1610923"/>

&lt;a href="javascript:CJ10465758X1.submit();">FREE SHIPPING&lt;/a>

&lt;/form> on All hard drives for a limited time only!

&lt;img src="http://www.awltovhc.com/image-1610923-10465758" width="1" height="1" border="0"/></linkCodeJavascript>

                  <linkDescription>Free Shipping on all hard drives - wide selection of sizes!  All brands!</linkDescription>

                  <linkDestination>http://www.electronicsbigtime.com/cgi-bin/newsearch.cgi?tti=harddrive</linkDestination>

                  <linkId>104658</linkId>

                  <linkName>Free Shipping On All hard drives</linkName>

                  <linkType>Text Link</linkType>

                  <networkRank xsi:nil="true"/>

                  <performanceIncentives>true</performanceIncentives>

                  <promotionEndDate/>

                  <promotionStartDate/>

                  <promotionType>free shipping</promotionType>

                  <relationshipStatus>joined</relationshipStatus>

                  <saleCommission>0.0 - 0.0</saleCommission>

                  <sevenDayEPC />

                  <threeMonthEPC />

               </LinkDetail>