Requires authorization
Retrieves data for all publishers that the requesting advertiser/publisher has access to. Try it now.
Request
HTTP request
GET https://www.googleapis.com/gan/v1beta1/role/roleId/publishers
Parameters
Parameter name | Value | Description |
---|---|---|
Required parameters | ||
role |
string |
The role of the requester. Valid values: 'advertisers' or 'publishers'.
Acceptable values are:
|
roleId |
string |
The ID of the requesting advertiser or publisher. If the request is made with role 'publishers', then the roleId must be 0. A roleID of 0 will return the list of all publishers controlled by the authenticated Google account. |
Optional parameters | ||
maxResults |
unsigned integer |
Max number of items to return in this page. Optional. Defaults to 20.
Acceptable values are 0 to 100 , inclusive.
|
minNinetyDayEpc |
double |
Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional. |
minPayoutRank |
integer |
A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.
Acceptable values are 1 to 4 , inclusive.
|
minSevenDayEpc |
double |
Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional. |
pageToken |
string |
The value of 'nextPageToken' from the previous page. Optional. |
publisherCategory |
string |
Caret(^) delimted list of publisher categories. Valid categories: (unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|network|search_specialist|comparison_shopping|email). Filters out all publishers not in one of the given advertiser categories. Optional. |
relationshipStatus |
string |
Filters out all publishers for which do not have the given relationship status with the requesting publisher.
Acceptable values are:
|
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/gan.readonly |
https://www.googleapis.com/auth/gan |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "gan#publishers", "nextPageToken": string, "items": [ { "kind": "gan#publisher", "id": long, "status": string, "name": string, "joinDate": datetime, "classification": string, "epcSevenDayAverage": { "amount": double, "currencyCode": string }, "epcNinetyDayAverage": { "amount": double, "currencyCode": string }, "payoutRank": string, "sites": [ string ] } ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
The kind for a page of entities. | |
nextPageToken |
string |
The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve. | |
items[] |
list |
The entity list. | |
items[].kind |
string |
The kind for a publisher. | |
items[].id |
long |
The ID of this publisher. | |
items[].status |
string |
The status of the requesting advertiser's relationship with this publisher. | |
items[].name |
string |
The name of this publisher. | |
items[].joinDate |
datetime |
Date that this publisher was approved as a Google Affiliate Network publisher. | |
items[].classification |
string |
Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4 | |
items[].epcSevenDayAverage |
nested object |
The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes. | |
items[].epcSevenDayAverage.amount |
double |
The amount of money. | |
items[].epcSevenDayAverage.currencyCode |
string |
The 3-letter code of the currency in question. | |
items[].epcNinetyDayAverage |
nested object |
The sum of fees paid to this publisher divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes. | |
items[].epcNinetyDayAverage.amount |
double |
The amount of money. | |
items[].epcNinetyDayAverage.currencyCode |
string |
The 3-letter code of the currency in question. | |
items[].payoutRank |
string |
A rank based on commissions paid to this publisher over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid). | |
items[].sites[] |
list |
Websites that this publisher uses to advertise. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.