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/advertisersThe action taken depends on the HTTP method and the parameters specified.
Use the
GETmethod to read an existing advertiser.Use the
POSTmethod to create a new advertiser.Use the
PUTmethod 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 |
| Optional | 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 code field from the Currency Types response. For example, |
| 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 when Advertiser was created. |
| N/A | N/A |
| Read-only field that specifies the time of the last update. |
| N/A | N/A |
| Read-only field that specifies the MDM ID of the Advertiser. |
| 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 |
Sample Payload
{
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "admin@yahooinc.com"
}
}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 |
Sample Payload
{
"billingContact": {
"firstName": "Admin",
"lastName": "Yahoo",
"email": "admin@yahooinc.com",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
}
}Measurement Rules Object
The Measurement rules object is only included when trying to retrieve all In-Flight Outcomes (IFO) measurement rules under an advertiser. Learn more at Read Advertiser Measurement Rules. The measurementRules object is read only and contains the following fields.
Name | Description | Type | Add | Update |
|---|---|---|---|---|
| Specifies the type of the measurement rule |
| N/A | N/A |
| Specifies the Rule ID of the measurement rule |
| N/A | N/A |
| Specifies the name of the measurement rule |
| N/A | N/A |
| Specifies the name of the vendor of the measurement rule. |
| N/A | N/A |
| Specifies the lookback window for the measurement rule. |
| N/A | N/A |
| Specifies the date when the measurement rule was created |
| N/A | N/A |
Sample Response
{
"type": "IFO",
"ruleId": 123,
"ruleName": "ISA Conversion Rule 1",
"vendorName": "Vendor Name",
"lookbackWindow": 30,
"createdDate": "2025-01-15",
}Measurement Rule Object
The Measurement rule object is only included when trying to retrieve the definition of an IFO measurement rule under an advertiser. Learn more at Read Advertiser Measurement Rule. The measurementRule object is read only and contains the following fields.
Name | Description | Type | Add | Update |
|---|---|---|---|---|
| Specifies the type of the measurement rule |
| N/A | N/A |
| Specifies the Rule ID of the measurement rule |
| N/A | N/A |
| Specifies the name of the measurement rule |
| N/A | N/A |
| Specifies the name of the vendor of the measurement rule. |
| N/A | N/A |
| Specifies the lookback window for the measurement rule. |
| N/A | N/A |
| Specifies the unit for the lookback window for the measurement rule. |
| N/A | N/A |
| Specifies the date when the measurement rule was created. |
| N/A | N/A |
| Specifies the date when the measurement rule was last updated. |
| N/A | N/A |
| Specifies the advertiser ID to which the measurement rule belongs to. |
| N/A | N/A |
| Specifies the description of the measurement rule |
| N/A | N/A |
| Contains a list of line ids and campaign ids to which the measurement rule is actively associated. lineIds: Contains list of line ids. |
| N/A | N/A |
| Specifies a list of UPC codes that are assigned during rule creation. |
| N/A | N/A |
| Specifies the brands that are assigned to the rule at rule creation. |
| N/A | N/A |
| Specifies the country which the measurement rule is meant to track. |
| N/A | N/A |
Sample Response (IFO)
{
"type": "IFO",
"ruleId": 456,
"ruleName": "ISA Conversion Rule 1",
"vendorName": "Vendor Name",
"lookbackWindow": 30,
"lookbackWindowUnit": DAY, // This is static
"trackingCost": “Image: 1.0 | Video: 1.0 | CTV: 0.25”,
"createdDate": "2025-01-15",
"updatedDate": "2025-01-15",
"accountId": 123,
"description": “Test Rule”,
"associatedEntityIds": {
"lineIds": [12345, 67890, 11111],
"campaignIds": [12345, 67890, 11111]
}
"upcCodes": [‘1123’, ‘123’],
"brands": {
"advertisers": [],
"highBrands": [],
"lowBrands": [
{
"advertiserName": "Adv Name ",
"brandHighName": "Brand High Name ",
"brandLowName": "Brand Low Name ",
"category": "",
"subCategory": ""
}
]
},
"pixelId": 10203888,
"pixelName": "Test"
}Sample Response (Offline)
{
"type": "Offline",
"ruleId": 456,
"ruleName": "Offline Conversion Rule 1",
"vendorName": "Yahoo Store Visits",
"lookbackWindow": 30,
"lookbackWindowUnit": DAY, // This is static
"trackingCost": “Image: 1.0 | Video: 1.0 | CTV: 0.25”,
"createdDate": "2025-01-15",
"updatedDate": "2025-01-15",
"accountId": 123,
"description": “Test Rule”,
"associatedEntityIds": {
"lineIds": [12345, 67890, 11111],
"campaignIds": [12345, 67890, 11111]
},
"country": "US"
}Brands Object
The Brands object is only included when trying to retrieve the definition of an IFO measurement rule. Learn more at Measurement Rule Object. The brands object contains the following fields.
Name | Description | Type | Add | Update |
|---|---|---|---|---|
| Specifies the list of advertiser level brands. Learn more at Brand Advertiser, High Brand, Low Brand Object. |
| N/A | N/A |
| Specifies the list of high brands. Learn more at Brand Advertiser, High Brand, Low Brand Object. |
| N/A | N/A |
| Specifies the list of low brands. Learn more at Brand Advertiser, High Brand, Low Brand Object. |
| N/A | N/A |
Sample Response
"brands": {
"advertisers": [],
"highBrands": [],
"lowBrands": [
{
"advertiserName": "Adv Name ",
"brandHighName": "Brand High Name ",
"brandLowName": "Brand Low Name ",
"category": "",
"subCategory": ""
}
]
}Brand Advertiser, High Brand, Low Brand Object
The Advertiser/High Brand/Low Brand Object is only included when trying to retrieve the definition of an IFO measurement rule. Learn more at Measurement Rule Object.
Name | Description | Type | Add | Update |
|---|---|---|---|---|
| Specifies the name of the brand advertiser. |
| N/A | N/A |
| Specifies the name of the high brand. |
| N/A | N/A |
| Specifies the name of the low brand. |
| N/A | N/A |
| Specifies the category of the brand. |
| N/A | N/A |
| Specifies the subcategory of the brand. |
| N/A | N/A |
Sample Response
"lowBrands": [
{
"advertiserName": "Adv Name ",
"brandHighName": "Brand High Name ",
"brandLowName": "Brand Low Name ",
"category": "",
"subCategory": ""
}
]Read Advertiser
Get data for a specific advertiser.
Parameters
Parameter | Parameter Type | Description | Data Type | Required |
|---|---|---|---|---|
| path | Specifies the advertiser ID. |
| Y |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/1Sample Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1,
"name": "My Yahoo!!",
"landingPageUrl": "https://www.yahoo.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": 501,
"updatedAt": "2026-03-05T19:10:10Z",
"createdAt": "2026-03-05T19:10:10Z",
"mdmId": "41514",
"billingPrice": 20,
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "admin@yahooinc.com"
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2026-03-06T05: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.
Sample Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1,
"name": "My Yahoo!!",
"landingPageUrl": "https://www.yahoo.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": 501,
"updatedAt": "2026-03-05T19:10:10Z",
"createdAt": "2026-03-05T19:10:10Z",
"mdmId": "41524",
"billingPrice": 20,
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "admin@yahooinc.com"
},
"billingContact": {
"firstName": "Admin",
"lastName": "Yahoo",
"email": "admin@yahooinc.com",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}Read Advertisers
Get a filtered list of advertisers.
GET /traffic/advertisers?query={query}&page={page}&limit={limit}&sort={sort}&dir={dir}&startTime={startTime}&endTime={endTime}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 |
| query | Defines the start of the time window. Used with |
| N |
| query | Defines the end of the time window. Used with |
| N |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers?page=1&limit=2&startTime=2026-03-01T00:00:00Z&endTime=2026-03-31T00:00:00ZSample 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": "2026-03-05T19:10:10Z",
"createdAt": "2026-03-05T19:10:10Z",
"mdmId": "41454",
"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": "2026-03-05T19:10:10Z",
"createdAt": "2026-03-05T19:10:10Z",
"mdmId": "41454",
"isCrossdeviceOff": false
}
],
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}Read Advertiser Measurement Rules
Get available Measurement Rules.
GET /traffic/advertisers/{accountId}/measurement-rulesParameters
Parameter | Parameter Type | Description | Data Type | Required |
|---|---|---|---|---|
| path | Specifies the advertiser ID. |
| Y |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/12345/measurement-rulesResponse
{
"response": {
"measurementRules": [
{
"type": "IFO",
"ruleId": 123,
"ruleName": "ISA Conversion Rule 1",
"vendorName": "Vendor Name",
"lookbackWindow": 30,
"createdDate": "2025-01-15"
},
{
"type": "Offline",
"ruleId": 456,
"ruleName": "Offline Measurement Rule 1",
"vendorName": "Offline Partner",
"lookbackWindow": 14,
"createdDate": "2025-01-10"
},
{
"type": "IFO",
"ruleId": 789,
"ruleName": "Mail Purchase Rule 1",
"vendorName": "Yahoo Mail",
"lookbackWindow": 7,
"createdDate": "2025-01-12"
}
],
"totalCount": 3,
"warnings": [
"Unable to fetch Offline rules" // This field shows partial fetch errors
]
},
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}Read Advertiser Measurement Rule
Get available Measurement Rules.
GET /traffic/advertisers/{accountId}/measurement-rules/{ruleId}Parameters
Parameter | Parameter Type | Description | Data Type | Required |
|---|---|---|---|---|
| path | Specifies the advertiser ID. |
| Y |
| path | Specifies the measurement rule ID. |
| Y |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/12345/measurement-rules/890Sample Response (IFO)
{
"response": {
"type": "IFO",
"ruleId": 456,
"ruleName": "ISA Conversion Rule 1",
"vendorName": "Vendor Name",
"lookbackWindow": 30,
"lookbackWindowUnit": "DAY",
"trackingCost": "Image: 1.0 | Video: 1.0 | CTV: 0.25",
"createdDate": "2025-01-15",
"updatedDate": "2025-01-15",
"accountId": 123,
"description": "Test Rule",
"associatedEntityIds": {
"lineIds": [
12345,
67890,
11111
],
"campaignIds": [
12345,
67890,
11111
]
},
"upcCodes": [
"1123",
"123"
],
"brands": {
"advertisers": [],
"highBrands": [],
"lowBrands": [
{
"advertiserName": "Adv Name ",
"brandHighName": "Brand High Name ",
"brandLowName": "Brand Low Name ",
"category": "",
"subCategory": ""
}
]
},
"pixelId": 10203888,
"pixelName": "Test"
},
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}Response (Offline)
{
"response": {
"type": "Offline",
"ruleId": 456,
"ruleName": "Offline Conversion Rule 1",
"vendorName": "Yahoo Store Visits",
"lookbackWindow": 30,
"lookbackWindowUnit": "DAY",
"trackingCost": "Image: 1.0 | Video: 1.0 | CTV: 0.25",
"createdDate": "2025-01-15",
"updatedDate": "2025-01-15",
"accountId": 123,
"description": "Test Rule",
"associatedEntityIds": {
"lineIds": [
12345,
67890,
11111
],
"campaignIds": [
12345,
67890,
11111
]
},
"country": "US"
},
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}Export Product Catalog
An email containing an excel sheet with product catalog details of a measurement rule is sent to the current user.
GET traffic/v3/offlinepurchase/advertiser/{advertiserId}/rules/{ruleId}/exportParameters
Parameter | Parameter Type | Description | Data Type | Required |
|---|---|---|---|---|
| path | Specifies the advertiser ID. |
| Y |
| path | Specifies the measurement rule ID |
| Y |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/v3/offlinepurchase/advertiser/123/rules/456/exportResponse
{
"response": {
"message": "Report created, will be emailed shortly"
},
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}Create Advertiser
Create a new advertiser.
POST /traffic/advertisersParameters
All fields are specified in the body of the application/json payload.
Sample Request URL
POST https://dspapi.admanagerplus.yahoo.com/traffic/advertisersSample 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"
}
}Sample 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": "2026-03-05T19:10:10Z",
"createdAt": "2026-03-05T19:10:10Z",
"billingPrice": 40.5,
"contact": {
"addressLine1": "1 N.First St",
"addressLine2": "",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94056",
"country": "United States"
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}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.
Sample 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": "admin@yahooinc.com",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
}
}Sample 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": "2026-03-05T19:10:10Z",
"createdAt": "2026-03-05T19:10:10Z",
"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": "admin@yahooinc.com",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"postalCode": "94089",
"country": "United States",
"vatNumber": "123456789",
"legalMandateConfirmation": true
},
"isCrossdeviceOff": false
},
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}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.
Sample Request URL
PUT https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/1Sample Request Body
{
"status": "ACTIVE",
"isCrossdeviceOff": true,
"billingPrice": 23,
"currency": "USD"
}Sample Response
{
"response": {
"status": "ACTIVE",
"timezone": "Etc/GMT",
"currency": "USD",
"id": 1,
"name": "My Yahoo!!",
"landingPageUrl": "https://www.yahoo.com",
"iabCategoryId": 5,
"iabSecondaryCategoryId": 501,
"updatedAt": "2026-03-05T19:10:10Z",
"createdAt": "2026-03-05T19:10:10Z",
"mdmId": "41454",
"billingPrice": 23,
"contact": {
"firstName": "Admin",
"lastName": "Yahoo",
"addressLine1": "Yahoo1",
"addressLine2": "701st Avenue",
"city": "Sunnyvale",
"region": "CA",
"country": "United States",
"telephone": "4574888849",
"email": "admin@yahooinc.com",
"postalCode": "94056"
},
"isCrossdeviceOff": true
},
"errors": null,
"timeStamp": "2026-03-06T05: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}/beaconlookupsParameters
Parameter | Parameter Type | Description | Data Type | Required |
|---|---|---|---|---|
| path | Specifies the advertiser ID. |
| Y |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/advertisers/1356341/beaconlookupsSample Response
{
"response": [
{
"id": 6508313,
"name": "test conversion1",
"dotPixel": true
},
{
"id": 6508309,
"name": "CPA Pixel",
"dotPixel": true
}
],
"errors": null,
"timeStamp": "2026-03-06T05:22:42Z"
}