Advertisers: list

Requires authorization

Retrieves data for all advertisers that the requesting advertiser/publisher has access to. Try it now.

Request

HTTP request

GET https://www.googleapis.com/gan/v1beta1/role/roleId/advertisers

Parameters

Parameter name Value Description
Required parameters
role string The role of the requester. Valid values: 'advertisers' or 'publishers'.

Acceptable values are:
  • "advertisers": The requester is requesting as an advertiser.
  • "publishers": The requester is requesting as a publisher.
roleId string The ID of the requesting advertiser or publisher.
Optional parameters
advertiserCategory string Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
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 advertisers 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 advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional. Acceptable values are 1 to 4, inclusive.
minSevenDayEpc double Filters out all advertisers 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.
relationshipStatus string Filters out all advertisers for which do not have the given relationship status with the requesting publisher.

Acceptable values are:
  • "approved": An advertiser that has approved your application.
  • "available": An advertiser program that's accepting new publishers.
  • "deactivated": Deactivated means either the advertiser has removed you from their program, or it could also mean that you chose to remove yourself from the advertiser's program.
  • "declined": An advertiser that did not approve your application.
  • "pending": An advertiser program that you've already applied to, but they haven't yet decided to approve or decline your application.

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#advertisers",
  "nextPageToken": string,
  "items": [
    {
      "kind": "gan#advertiser",
      "id": long,
      "status": string,
      "name": string,
      "siteUrl": string,
      "description": string,
      "category": string,
      "productFeedsEnabled": boolean,
      "commissionDuration": integer,
      "epcSevenDayAverage": {
        "amount": double,
        "currencyCode": string
      },
      "epcNinetyDayAverage": {
        "amount": double,
        "currencyCode": string
      },
      "logoUrl": string,
      "contactEmail": string,
      "contactPhone": string,
      "payoutRank": string,
      "joinDate": datetime,
      "allowPublisherCreatedLinks": boolean,
      "defaultLinkId": long,
      "redirectDomains": [
        string
      ],
      "merchantCenterIds": [
        long
      ]
    }
  ]
}
Property name Value Description Notes
kind string The kind for a page of advertisers.
nextPageToken string The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
items[] list The advertiser list.
items[].kind string The kind for an advertiser.
items[].id long The ID of this advertiser.
items[].status string The status of the requesting publisher's relationship this advertiser.
items[].name string The name of this advertiser.
items[].siteUrl string URL of the website this advertiser advertises from.
items[].description string Description of the website the advertiser advertises from.
items[].category string Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
items[].productFeedsEnabled boolean Allows advertisers to submit product listings to Google Product Search.
items[].commissionDuration integer The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
items[].epcSevenDayAverage nested object The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
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 publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
items[].epcNinetyDayAverage.amount double The amount of money.
items[].epcNinetyDayAverage.currencyCode string The 3-letter code of the currency in question.
items[].logoUrl string URL to the logo this advertiser uses on the Google Affiliate Network.
items[].contactEmail string Email that this advertiser would like publishers to contact them with.
items[].contactPhone string Phone that this advertiser would like publishers to contact them with.
items[].payoutRank string A rank based on commissions paid to publishers 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[].joinDate datetime Date that this advertiser was approved as a Google Affiliate Network advertiser.
items[].defaultLinkId long The default link id for this advertiser.
items[].redirectDomains[] list List of redirect URLs for this advertiser
items[].merchantCenterIds[] list List of merchant center ids for this advertiser

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.