- 7 Minutes to read
Advertisers
- 7 Minutes to read
This article describes services for reading, adding, and updating advertisers.
Overview
A direct advertiser is a company that lists advertisements on Yahoo DSP to purchase inventory provided by a range of publishers in the broader marketplace. A seat holder manages direct advertisers.
Endpoint
/traffic/advertisers
The action taken depends on the HTTP method and the parameters specified.
Use the
GET
method to read an existing advertiser.Use the
POST
method to create a new advertiser.Use the
PUT
method to update an existing advertiser.
Resources
Advertiser Object
The advertisers
resource is defined by the following following fields:
Name | Description | Type | Create | Update |
---|---|---|---|---|
| Specifies the advertiser ID. |
| N/A | Required |
| Specifies the name of the advertiser. |
| Required | Optional |
| Specifies the current status of the advertiser. Options include:
|
| Required | Optional |
| Specifies the advertiser’s website URL. |
| Required | Optional |
| Specifies the primary category of the advertiser’s business. Use the |
| Required | Optional |
| Specifies a secondary category of the advertiser’s business. Use the |
| Required | Optional |
| Specifies the default time zone for the advertiser’s data; the time zone used to aggregate advertiser data in reports. Use the |
| Required | N/A |
| Specifies the default currency for the advertiser’s data. Use the |
| Required | N/A |
| Specifies the advertiser’s percentage profit margin expressed as a value between 0 and 100. |
| Required | Optional |
| Specifies the advertiser’s primary contact information. To learn more, refer to Contact Object. |
| Required | N/A |
| Specifies the advertiser’s billing contact information. Billing contact fields are only included in the response for certain seats. To learn more, refer to Billing Contact Object. |
| Optional | N/A |
| Enable or disable the optimization using cross device conversions. By default,
|
| Optional | Optional |
| Read-only field that specifies the time of the last update. |
| N/A | N/A |
Contact Object
The contact
object contains the following fields:
Name | Description | Type | Add | Update |
---|---|---|---|---|
| Specifies the first name of the contact. |
| Optional | Optional |
| Specifies the last name of the contact. |
| Optional | Optional |
| Specifies the first line of contact information. |
| Required | Optional |
| Specifies the second line of contact information. |
| Optional | Optional |
| Specifies the contact’s city. |
| Required | Optional |
| Specifies the contact’s region or state. |
| Required | Optional |
| Specifies the contact’s postal code. |
| Optional | Optional |
| Specifies the contact’s country. |
| Required | Optional |
| Specifies the contact’s telephone number. |
| Optional | Optional |
| Specifies the email address of the advertiser contact. |
| Optional | Optional |
Example Payload
{
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "[email protected]"
}
}
Billing Contact Object
Billing contact fields are only included in the response for certain seats that need to comply with country-specific laws (i.e. the Sapin II Law in France). The billingContact
object contains the following fields:
Name | Description | Type | Add | Update |
---|---|---|---|---|
| Specifies the first name of the billing contact. |
| Required | Required |
| Specifies the last name of the billing contact. |
| Required | Required |
| Specifies the email address of the advertiser billing contact. |
| Required | Required |
| Specifies the first line of the billing contact information. |
| Required | Required |
| Specifies the second line of the billing contact information. |
| Optional | Optional |
| Specifies the third line of the billing contact information. |
| Optional | Optional |
| Specifies the billing contact’s city. |
| Required | Required |
| Specifies the billing contact’s region or state. |
| Optional | Optional |
| Specifies the billing contact’s postal code. |
| Optional | Optional |
| Specifies the billing contact’s country. |
| Required | Required |
| Specifies the billing contact’s VAT Number. |
| Optional | Optional |
| Confirms sending the legal mandate to the account manager. |
| Required | Required |
Example Payload
{
"billingContact": {
"firstName": "Admin",
"lastName": "Yahoo",
"email": "[email protected]",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
}
}
Read Advertiser
Get data for a specific advertiser.
Parameters
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| path | Specifies the advertiser ID. |
| Y |
Example Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/1
Example Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1,
"name": "My Yahoo!!",
"landingPageUrl": "https://www.yahoo.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": 501,
"updatedAt": "2017-04-18T05:22:43Z",
"billingPrice": 20,
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "[email protected]"
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2017-04-18T05:22:42Z"
}
For seats that need to comply with country-specific laws (such as France’s Sapin II law) the response contains an additional billing contact section.
Example Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1,
"name": "My Yahoo!!",
"landingPageUrl": "https://www.yahoo.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": 501,
"updatedAt": "2017-04-18T05:22:43Z",
"billingPrice": 20,
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "[email protected]"
},
"billingContact": {
"firstName": "Admin",
"lastName": "Yahoo",
"email": "[email protected]",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2017-04-18T05:22:42Z"
}
Read Advertisers
Get a filtered list of advertisers.
GET /traffic/advertisers?query={query}&page={page}&limit={limit}&sort={sort}&dir={dir}
Parameters
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| query | Specifies the search term. Use URL encoding conventions (i.e. a space should be replaced with a |
| N |
| query | Specifies the page number. |
| N |
| query | Specifies the total number of items to return. Maximum allowed value is |
| N |
| query | Specifies the column to sort by. |
| N |
| query | Specifies the sort direction. Allowed values:
|
| N |
Example Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers?page=1&limit=2
Example Response
{
"response": [
{
"status": "ACTIVE",
"timezone": "America/New_York",
"currency": "USD",
"id": 1,
"name": "My Yahoo!!",
"landingPageUrl": "http://yahoo.com",
"iabCategoryId": 1,
"iabSecondaryCategoryId": 101,
"accountGroupId": 2491,
"updatedAt": "2017-04-15T02:46:03Z",
"isCrossdeviceOff": false
},
{
"status": "ACTIVE",
"timezone": "America/Los_Angeles",
"currency": "USD",
"id": 2,
"name": "Your Retail Sales Advertiser",
"landingPageUrl": "http://www.yourretailsalesadvertiser.com",
"iabCategoryId": 9,
"iabSecondaryCategoryId": 927,
"accountGroupId": 2491,
"updatedAt": "2015-12-18T18:57:46Z",
"isCrossdeviceOff": false
}
],
"errors": null,
"timeStamp": "2017-04-18T05:32:09Z"
}
Create Advertiser
Create a new advertiser.
POST /traffic/advertisers
Parameters
All fields are specified in the body of the application/json
payload.
Example Request URL
POST https://dspapi.admanagerplus.yahoo.com/traffic/advertisers
Example Request Body
{
"name": "TEST_1_3",
"landingPageUrl": "http://www.example.com",
"iabCategoryId": 5,
"timezone": "Etc/GMT",
"currency": "USD",
"status": "ACTIVE",
"billingPrice": 40.5,
"contact": {
"addressLine1": "1 N.First St",
"addressLine2": "",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94056",
"country": "United States"
}
}
Example Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1259301,
"name": "TEST_1_3",
"landingPageUrl": "http://www.example.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": -1,
"updatedAt": "2017-04-18T05:38:40Z",
"billingPrice": 40.5,
"contact": {
"addressLine1": "1 N.First St",
"addressLine2": "",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94056",
"country": "United States"
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2017-04-18T05:38:39Z"
}
For seats that need to comply with country-specific laws (such as France’s Sapin II law) the payload should contain the billing contact fields.
Example Request Body
{
"name": "TEST_1_3",
"landingPageUrl": "http://www.example.com",
"iabCategoryId": 5,
"timezone": "Etc/GMT",
"currency": "USD",
"status": "ACTIVE",
"billingPrice": 40.5,
"contact": {
"addressLine1": "1 N.First St",
"addressLine2": "",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94056",
"country": "United States"
},
"billingContact": {
"firstName": "Admin",
"lastName": "Yahoo",
"email": "[email protected]",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
}
}
Example Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1259301,
"name": "TEST_1_3",
"landingPageUrl": "http://www.example.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": -1,
"updatedAt": "2017-04-18T05:38:40Z",
"billingPrice": 40.5,
"contact": {
"addressLine1": "1 N.First St",
"addressLine2": "",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94056",
"country": "United States"
},
"billingContact": {
"firstName": "Admin",
"lastName": "Yahoo",
"email": "[email protected]",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2017-04-18T05:38:39Z"
}
Update Advertiser
Update an existing advertiser.
PUT /traffic/advertisers/{id}
Partial updates are supported; values of supported fields that are not in the payload remain unchanged. For seats that need to comply with country-specific laws (such as France’s Sapin II law) the payload can contain the billing contact fields.
Parameters
The Advertiser id
is specified in the url path. All other fields are specified in the body of the application/json
payload.
Example Request URL
PUT https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/1
Sample Request Body
{
"status": "ACTIVE",
"isCrossdeviceOff": true,
"billingPrice": 23,
"currency": "USD"
}
Example Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1,
"name": "My Yahoo!!",
"landingPageUrl": "https://www.yahoo.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": 501,
"updatedAt": "2017-04-18T05:22:43Z",
"billingPrice": 23,
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "[email protected]",
"postalCode": "94056"
},
"isCrossdeviceOff": true
},
"errors": null,
"timeStamp": "2017-04-18T05:22:42Z"
}
Delete Advertiser
The DSP Traffic API does not support deletion of advertisers.
Read Advertiser Beacon Lookups
Get available beacons.
GET /traffic/advertisers/{accountId}/beaconlookups
Parameters
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| path | Specifies the advertiser ID. |
| Y |
Example Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/1356341/beaconlookups
Example Response
{
"response": [
{
"id": 6508313,
"name": "test conversion1",
"dotPixel": true
},
{
"id": 6508309,
"name": "CPA Pixel",
"dotPixel": true
}
],
"errors": null,
"timeStamp": "2017-06-07T21:10:45Z"
}