The Publisher Lookup Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to access information regarding publishers within the Commission Junction network. This service enables retrieval of the same publisher information available within the CJ Account Manager. Refer to the following sections of this topic for more specific information.
Note: Refer to https://publookup.api.cj.com for the most recent version of the Publisher Lookup Search Service WSDL. The WSDL provides all the programmatic information you need to use this API. The hand-edited version provides the information in a readable format; however, to ensure maximum compatibility with the system, use the AXIS version when developing your application.
Refer to the following table for a list of the required request parameters. All parameter names and values are case sensitive.
|
Parameter Name |
Value |
Req? |
Description |
|
developerKey |
String |
Yes |
Your developer key obtained from the Web Services Developer Site. |
|
token |
String |
Yes |
The Authentication Key from a successful publisher login. The Commission Junction authentication process generates this key and provides the developer with it. For example, after a publisher authenticates themselves with the Branded Login Service, the system appends the key to the specified redirect URL. |
The response includes information about the publisher necessary for advertisers or developers to complete a number of tasks, including: creating links, personalizing content and identifying the publisher with their program. All parameter names and values are case sensitive.
The response includes one instance of each of the following fields.
|
Field Name |
Value |
Description |
|
cid |
Long |
The publisher’s CID. |
|
country |
String |
The publisher’s country. |
|
currency |
String |
The publisher’s functional currency. |
|
joinDate |
dateTime |
The date on which the publisher joined the advertiser’s program (i.e., the current program terms). |
|
networkRating |
Long |
The publisher's rating in the Commission Junction marketplace. |
|
programName |
String |
The publisher’s program name. |
|
programTermName |
String |
The name of the active program terms between the advertiser and the publisher. |
|
programTermStatus |
String |
The status of the program terms between the advertiser and the publisher. This value may be either available or archived. |
|
promotionalMethods |
String |
The publisher’s promotional methods. Multiple promotional methods are concatenated into a single string. |
|
sevenDayEPC |
Double |
The publisher’s 7-Day EPC. |
|
threeMonthEPC |
Double |
The publisher’s 3-Month EPC. |
|
webSites |
Array |
An array of the publisher’s Web sites. Refer to the Per Record (Web Site) table below for the fields returned for each Web site record. |
The response includes the following fields for each record (i.e., Web site).
|
Field Name |
Value |
Description |
|
name |
String |
The Web site name. |
|
pid |
Long |
The Web site ID (PID). |
|
url |
String |
The Web site URL. |
|
Error |
Description |
|
Not Authenticated |
The system could not authenticate your developer key. |