Advertisers

Overview

The AdvertiserService provides methods for retrieving advertiser data. An advertiser is an entity that manages campaigns in Gemini. It has settings such as contact information and billing details, and is able to manage campaigns and view reports for those campaigns. The Yahoo ID you use to log in to Ad Manager can be associated with one or more advertisers.

Fields

The Advertiser object contains the following fields:

Name Description Type
id The ID of the advertiser to retrieve. long
advertiserName The name of the advertiser. string
timezone The timezone of the advertiser. string
currency The currency of the advertiser. string

Endpoint

Resource URI

https://api.admanager.yahoo.com/v1/rest/advertiser/

Example Representations

Advertiser

{
  "id": 1,
  "currency": "USD",
  "timezone": "America/New_York",
      "advertiserName": "advertiser1"
}

Advertiser Array

[
   {
    "id": 1,
    "currency": "USD",
    "timezone": "America/New_York",
    "advertiserName": “advertiser1”
   },
   {
    "id": 2,
    "currency": "USD",
    "timezone": "America/New_York",
    "advertiserName": “advertiser2”
   }
]

Advertiser Response

{
   "errors": null,
   "response": {
      "id": 1,
      "currency": "USD",
          "timezone": "America/New_York",
      "advertiserName": "advertiser1"
   }
}

Operations

Read specific advertiser data

Method: To retrieve data for a specific advertiser, make a GET call with the id parameter.

Example: GET call to retrieve an advertiser:

https://api.admanager.yahoo.com/v1/rest/advertiser/87292

The response will be the advertiser associated with the given id:

{
  "errors": null,
  "response": {
      "id": 87292,
      "currency": "USD",
          "timezone": "America/New_York",
      "advertiserName": "company name"
  }
}

Response: The advertiser associated with the given ID.

Example: GET call to retrieve a list of advertisers:

https://api.admanager.yahoo.com/v1/rest/advertiser/?id=134&id=19426

Response: The advertisers associated with the given ids:

{
  "errors": null,
  "response": [
      {
          "id": 134,
          "currency": "USD",
                      "advertiserName": "NativeAdvertiser_1",
                      "timezone": "America/New_York"
      },
      {
          "id": 19426,
          "currency": "USD",
                      "advertiserName": "SearchAdvertiser_1",
                      "timezone": "America/New_York"
      }
  ]
}

Read data for filtered list of advertisers

Method: To retrieve data for a filtered list of advertisers, make a GET call with the parameters in the table below:

Name Description Type
id The ID of the advertiser to retrieve. long
mr The maximum number of rows to retrieve. This value should not be greater than 300. int
si The start index or the first element to retrieve. int

Example: GET call for a filtered list of advertisers:

https://api.admanager.yahoo.com/v1/rest/advertiser/?mr=5

Response: The list of advertisers matching the given filter.