Advertisers: get

Requires authorization

Retrieves data for a single advertiser if the requesting advertiser/publisher has access to that data. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter. Try it now.

Request

HTTP request

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

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
advertiserId string The ID of the advertiser to look up. Optional.

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#advertiser",
  "item": {
    "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 an advertiser.
item nested object The requested advertiser.
item.kind string The kind for an advertiser.
item.id long The ID of this advertiser.
item.status string The status of the requesting publisher's relationship this advertiser.
item.name string The name of this advertiser.
item.siteUrl string URL of the website this advertiser advertises from.
item.description string Description of the website the advertiser advertises from.
item.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
item.productFeedsEnabled boolean Allows advertisers to submit product listings to Google Product Search.
item.commissionDuration integer The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
item.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.
item.epcSevenDayAverage.amount double The amount of money.
item.epcSevenDayAverage.currencyCode string The 3-letter code of the currency in question.
item.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.
item.epcNinetyDayAverage.amount double The amount of money.
item.epcNinetyDayAverage.currencyCode string The 3-letter code of the currency in question.
item.logoUrl string URL to the logo this advertiser uses on the Google Affiliate Network.
item.contactEmail string Email that this advertiser would like publishers to contact them with.
item.contactPhone string Phone that this advertiser would like publishers to contact them with.
item.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).
item.joinDate datetime Date that this advertiser was approved as a Google Affiliate Network advertiser.
item.defaultLinkId long The default link id for this advertiser.
item.redirectDomains[] list List of redirect URLs for this advertiser
item.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.