Advertisers¶
Abstract¶
The AdvertiserService provides methods for retrieving advertiser data.
Overview¶
An advertiser is an entity that manages campaigns in the Yahoo Native API. It has settings such as contact information and billing details, and is able to manage campaigns and view reports for those campaigns. The Yahoo Native 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 |
---|---|---|
|
The ID of the advertiser to retrieve. |
long |
|
The name of the advertiser. |
string |
|
The timezone of the advertiser. |
string |
|
The currency of the advertiser. |
string |
Endpoint¶
Resource URI
https://api.gemini.yahoo.com/v3/rest/advertiser/
v3 Upgraded URL Attributes¶
Important
For the v3 Native Ad Platform API, Upgraded URL (UU) attributes are now supported for the Advertiser object type.
The following table describes the supported UU attributes per the Advertiser object type in v3 Native API.
Object |
Landing Url |
Display Url |
Final Url |
Mobile Final Url |
TrackingUrl |
Custom Parameters |
Display Url Path1 |
Display Url Path2 |
---|---|---|---|---|---|---|---|---|
Advertiser |
no |
no |
no |
no |
yes |
no |
no |
no |
Note
The landing page url is deprecated only for search. The Final url will be eligible in a native context. Native-only ads are not required to use the final URL and may continue to use the landing page url.
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.gemini.yahoo.com/v3/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.gemini.yahoo.com/v3/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 |
---|---|---|
|
The ID of the advertiser to retrieve. |
long |
|
The maximum number of rows to retrieve. This value should not be greater than 300. |
int |
|
The start index or the first element to retrieve. |
int |
|
The status of the advertiser to filter the list of advertisers. |
enum |
|
This field indicates that the advertiser account has a managing entity that is authorized to perform actions on their behalf. The value should be the id of the reseller that is creating the account, and is immutable once set. |
long |
|
This field defaults to ADVERTISER and is read-only. |
enum |
|
This field enables you to search by name and can be any part of a name. |
long |
Example: GET call for a filtered list of advertisers:
https://api.gemini.yahoo.com/v3/rest/advertiser/?mr=5
Response: The list of advertisers matching the given filter.
Important
The Advertiser must be a managed account in order to take advantage of these APIs.