Publisher Resource

advertiser/publisher

The publisher resource allows an advertiser to pull publisher information, as well as manage publisher relationship status and term..
 

GET
Request Parameters
Parameter	Description	Possible Values	Default	Required?
id	The id, or comma-separated list of ids, of the publisher(s) you want to retrieve. If one id is provided, the resource object will be returned. If a comma-separated list of ids are provided, a list of objects will be returned.	* 987 OR 123,456,789	N/A	No
requestDate	The date the publisher requested to join the advertiser A valid date string in the ISO 8601 date format; any timestamp information that is present will be ignored	yyyy-mm-dd	N/A	No
joinDate	The date the publisher was joined to the advertiser A valid date string in the ISO 8601 date format; any timestamp information that is present will be ignored	yyyy-mm-dd	N/A	No
firstName	The first name, or comma-separated list of first names, of the publisher(s) you want to filter by	* Any generic string	N/A	No
lastName	The last name, or comma-separated list of last names, of the publisher(s) you want to filter by	* Any generic string	N/A	No
company	The company, or comma-separated list of companies, of the publisher(s) you want to filter by	* Any generic string	N/A	No
website	The website URL, or comma-separated list of website URLs, of the publisher(s) you want to filter by	* Any generic string	N/A	No
status	The status, or comma-separated list of statuses, of the publisher(s) you want to retrieve	no_relationship, joined, revoked_by_advertiser, applied,  declined_by_advertiser, invited, revoked_by_publisher,  declined_by_publisher	N/A	No
termId	The term id, or comma-separated list of term ids, of the publisher(s) you want to retrieve  Used in advertiser/term	* 987 OR 123,456,789	N/A	No
categoryId	The category id, or comma-separated list of category ids, of the publisher(s) you want to retrieve  Used in advertiser/publisher/category	* 987 OR 123,456,789	N/A	No
promotionalMethodId	The promotional method id, or comma-separated list of promotional method ids, of the publisher(s) you want to retrieve  Used in advertiser/publisher/promotional-method	* 987 OR 123,456,789	N/A	No
transparency	The transparency, or comma-separated list of transparencies, of the publisher(s) you want to retrieve	0,1,2,3,4,5	N/A	No
groupId	The group id, or comma-separated list of group ids, of the publisher(s) you want to retrieve  Used in advertiser/group	* 987 OR 123,456,789	N/A	No
keywords	Keywords, or comma-separated list of keywords, of the publisher(s) you want to retrieve	* Any generic string	N/A	No
country	2 character country code, or comma-separated list of country codes, of the publisher(s) you want to retrieve	* US, GM, SZ, LR, BD, etc...	N/A	No
state	State code, or comma-separated list of state codes, of the publisher(s) you want to retrieve	* PA, NSW, CYL, MT, OH, WY, etc...	N/A	No
premier	Show only premier publishers	1,true	N/A	No
Response Fields
Field	Description	Notes
transparency	Publisher transparency
id	Publisher id
first_name	Publisher first name
last_name	Publisher last name
company	Publisher company
state	Publisher state	The returned value depends on if the publisher status is Joined or Applied.
country	Publisher country	The returned value depends on if the publisher status is Joined or Applied.
website	Publisher website URL
primary_promo_method	Publisher primary promotional method name
status	Publisher status
request_date	Date the publisher requested to join the advertiser
join_date	Date the publisher joined the advertiser
term	An array of the publisher term information	Will display in response if the publisher is assigned to a term.
term[n][id]	Id of the publisher's term
term[n][name]	Name of the publisher's term
group	An array of the publisher group information	Will display in response if the publisher belongs to one or more groups.
group[n][id]	Id of the group the publisher is in
group[n][name]	Name of the group the publisher is in
category	An array of the category information	Will display in response when using the categoryId parameter and if the publisher belongs to one or more categories.
category[n][id]	Id of the category the publisher is in
category[n][name]	Name of the category the publisher is in
promotional_method	An array of the promotional method information	Will display in response when using the promotionalMethodId parameter and if the publisher has one or more promotional methods.
promotional_method[n][id]	Id of the promotional method the publisher is in
promotional_method[n][name]	Name of the promotional method the publisher is in

POST

Not Available

PUT
Request Parameters
Parameter	Description	Possible Values	Default	Required?
id	The id of the publisher being updated	* 123	N/A	Yes
Put Parameters
Parameter	Description	Possible Values	Default	Required?
status	The relationship status being assigned to the publisher being updated	invite, term, reinvite, accept, revoke, decline		Yes
term_id	The id of the term being assigned to the publisher being updated PLEASE NOTE:  This parameter is required when using statuses invite, term, reinvite, accept	* 123		Dependant
term_change_date	The date the program term will take effect PLEASE NOTE:  A valid date string in the ISO 8601 date format; any timestamp information that is present will be ignored This parameter is optional when using status term or invite	yyyy-mm-dd		No
term_early_accept	Allows the publisher to accept the program term early PLEASE NOTE:  This parameter is optional when using status term and the publisher is already joined to the advertiser program	1,true		No
Response Fields
Field	Description	Notes
N/A

DELETE

Not Available

* Values shown are placeholder values. Please replace with actual data.