- 19 Minutes to read
About Targeting
- 19 Minutes to read
Yahoo DSP enables you to target exchanges, deals, locations, demographics, ad positions, frequency, audiences, devices, and more.
Endpoint
traffic/lines/{lineId}/targeting
Use the following HTTP methods:
Use the
GET
method to view existing line targeting.Use the
POST
method to create new line targeting.Use the
PUT
method to update existing line targeting.
Resources
Targeting Types
Your ability to target consumers is constrained by the creatives served by the line.
The Yahoo DSP supports the following targeting types:
Targeting Type | Description | Display | Video | 3P Native | Yahoo Native |
---|---|---|---|---|---|
| If you have created user groups for A/B testing, you can target those user groups to display the results of your testing. | Y | Y | Y | N |
| For video ads, you can set the type of ad initiation you want to target (Auto Initiated, User Initiated, Unknown, or All). | N | Y | N | N |
| Target the location on a page that you want your display ads to appear. | Y | N | Y | N |
| Note: Only available via special role. Ensure your ads are properly represented and delivered to real people, rather than to bot traffic. | Y | Y | Y | N |
| You can target users based on how they are connected to the internet (wi-fi, cellular, or both). You can also target Internet Service Providers (ISPs) and Mobile Carriers, as follows:
Important: If you target both ISPs and mobile carriers, the targeting uses | Y | Y | Y | N |
| If you have created contextuals for an advertiser, you can set up targeting to serve or exclude ads based on the contextual. | Y | Y | Y | Y |
| Reach your desired audience with age and gender targeting. | Y | Y | Y | Y |
| Choose the days and hours your display or video ads should serve. | Y | Y | Y | Y |
| A line can target or block one or more exchanges or target available private marketplace deals. | Y | Y | Y | N |
| Set a limit on how frequently an ad is shown to a user within a specified time frame. | Y | Y | Y | Y |
| Location targeting enables you to target specific geographical areas. You can target a country, state, city, metro area, sub region, region, Nielsen Designated Marketing Area (DMA), ZIP or postal code, postcode prefix, geofencing location, or a Points Of Interest (POI) category (USA only). Native lines can only target by Country/State/City/DMA. You can set up geofencing to target users within a specified radius of a given address. | Y | Y | Y | Y |
| You can explicitly target web vs. in-app supply. | Y | Y | Y | N |
| Target lines based on the language users most frequently view in their browsers. Advertisers can target or exclude specific languages. | Y | Y | Y | N |
| Enable targeting of consumers with interstitial and rewarded ads. | Y | Y | Y | N |
| If you have set up “native lists” (lists of apps and sites for Yahoo native lines), you can exclude those lists. | N | N | N | Y |
| Enable targeting based on the player size. | N | Y | N | N |
| If you have created audiences, you can perform line item targeting using include and exclude conditions. | Y | Y | Y | Y |
| If you have set app lists and/or site lists to include and/or exclude apps and URLs, you can target those app lists and/or site lists. | Y | Y | N | N |
| Target users based on the technologies in their computing environment such as device type, operating system (desktop and mobile) and browser. | Y | Y | Y | Y |
| Enable targeting based on the video content length. | N | Y | N | N |
| Weather targeting enables you to target consumers based on the weather condition and UV. | Y | Y | Y | N |
| Note: Only available For DOOH Lines. DOOH screen owners targeting enables you to target DOOH Screens based on screen owners (Media Owners). | Y | Y | N | N |
| Note: Only available For DOOH Lines. DOOH Venue Types targeting enables you to target DOOH screens based on venue types. | Y | Y | N | N |
| Note: Only available For DOOH Lines. DOOH Screen Lists targeting enables you to target DOOH screens based on screen lists. | Y | Y | N | N |
Targeting Object
The targeting
resource is the standard Yahoo DSP resource for targeting consumers based on their profiles, behaviors, and ad content.
This resource comprises multiple fields that enable you to specify line targeting across many types of targets including the SEGMENT
, EXCHANGES
, and CONNECTION
target types.
Note
Read-only fields are returned by Read Line Targeting requests.
Field | Description | Data Type | Target Type |
---|---|---|---|
| Specifies the genders targeted.
|
|
|
| Specifies the age ranges targeted.
|
|
|
| Specifies the frequency cap interval.
|
|
|
| Specifies the number of impressions all for the selected
|
|
|
| A value of false means the limit will be set by People/Device. A value of true means the limit will be set by Household. Limit the frequency capping by Household is only for CTV lines. | boolean |
|
| Specifies multi-layer frequency cap for the line.
|
|
|
| Specifies whether the ad is served to known or unknown users:
|
|
|
| Specifies the days of the week and hours of the day targeted. To learn more, refer to Day Parting Targeting. |
|
|
| Specifies the languages targeted:
|
|
|
| Specifies the inventory types targeted:
|
|
|
| Specifies the bot fraud prevention partner:
|
|
|
| Specifies the user group entry. For |
|
|
| Specifies the device types targeted:
|
|
|
| Specifies the operating system types targeted:
|
|
|
| Specifies the browser types targeted. Note: |
|
|
| Specifies the mobile OS types targeted. Note: |
|
|
| For video ads, specifies how the targeted ad is initiated:
|
|
|
| For display ads, specifies location on the page where the ad appears:
|
|
|
| For video ads, the platform determines the player size based on height and width (in pixels) specified in the bid request. The platform extracts the larger of the two and assigns a player size:
To learn more, refer to Player Size Targeting. |
|
|
| Video content length is the duration of the video a user is about to watch, not the duration of the ad. Valid values include:
To learn more, refer to Video Content Length Targeting. |
|
|
| Specifies the mobile carriers and ISPs targeted. Note: To target a mobile carrier, you need only specify the |
|
|
| Specifies the IDs of publishers/exchanges targeted. To learn more, refer to Exchange Targeting. |
|
|
| Specifies private marketplace deals to target.
|
|
|
| An array that contains 2 or 3 priority buckets. Each bucket contains targeted deals and exchanges and has an assigned priority. For details, refer to Priority Bucket Post Object and Priority Bucket Get Object. |
|
|
| Specifies contextuals to target or exclude from targeting.
|
|
|
| Specifies site lists and app lists to target or exclude from targeting.
|
|
|
| Specifies geographic locations to target or exclude from targeting.
Note: You cannot target both geographic locations and geofencing locations at the same time. |
|
|
| Specifies geo fencing locations to target or exclude from targeting.
Note: You cannot target both geographic locations and geofencing locations at the same time. |
|
|
| Specifies points of interest resources to target within the set geographic locations.
Note: POI is only supported in United States. You cannot target both points of interest resources and geofencing locations at the same time. |
|
|
| Specifies segments to target or exclude from targeting.
|
|
|
| Specifies the mobile placement types:
To learn more, refer to Mobile Placements Targeting. |
|
|
| Weather targeting is powered by the Yahoo Weather API. You can use weather targeting to target audiences based on the real-time or forecasted weather conditions of the user’s location. Valid values include:
|
|
|
| The Yahoo Weather API powers the line’s weather targeting. You can use weather targeting to target audiences based on the real-time or forecasted weather temperature for the user’s location. Valid values are between -40 and 136 (Fahrenheit) or -40 and 58 (Celsius). For details, refer to Weather Condition Targeting. |
|
|
| The Yahoo Weather API powers the line’s weather targeting. You can use weather targeting to target audiences based on the real-time or forecasted weather humidity for the user’s location. Valid values are between 0% and 100%. |
|
|
| The Yahoo Weather API powers the line’s weather targeting. You can use weather targeting to target audiences based on the real-time or forecasted weather UV for the user’s location. Valid values include:
For details, refer to Weather UV Targeting. |
|
|
| A read-only array that specifies the publishers/exchanges included in targeting. To learn more, refer to Exchange Targeting. |
|
|
| A read-only array that specifies the publishers/exchanges excluded from targeting. To learn more, refer to Exchange Targeting. |
|
|
| A read-only array that specifies the deals included in targeting. To learn more, refer to Exchange Targeting. |
|
|
| A read-only array that specifies the contextuals included in targeting. To learn more, refer to Contextuals Targeting. |
|
|
| A read-only array that specifies the contextuals excluded from targeting. To learn more, refer to Contextuals Targeting. |
|
|
| A read-only array that shows the attributes of engagement events used during any funnel targeting efforts to retarget users with specific product sets. To learn more, refer to Funnel Targeting. |
|
|
| A read-only array of site lists and app lists that are included in targeting. To learn more, refer to Site List Targeting. |
|
|
| A read-only array of site lists and app lists that are excluded from targeting. To learn more, refer to Site List Targeting. |
|
|
| A read-only array of geo locations included in targeting. To learn more, refer to Geos Included Object. |
|
|
| A read-only array of geofencing locations excluded from targeting by the line. To learn more, refer to Geos Excluded Object. |
|
|
| A read-only array of geofencing locations included in targeting by the line. To learn more, refer to Geo Fencing. |
|
|
| A read-only array of points of interest locations included in targeting by the line. To learn more, refer to Points of Interest (POI). |
|
|
| A read-only array that shows the segments included in targeting. To learn more, refer to Segments Included Object. |
|
|
| A read-only array that shows the segments excluded from targeting. To learn more, refer to Segments Included Object. |
|
|
| Specifies DOOH Screen Owners IDs to target.
|
|
|
| Specifies DOOH Venue Types IDs to target.
|
|
|
| Specifies DOOH Screen Lists IDs to target.
|
|
|
| Specifies the targeting types enabled and disabled for the line. To learn more, refer to Targeting Types. |
| N/A |
Target Types Object
When reading (GET
) existing line targeting, the types
payload object shows all the targeting types which are enabled for the line.
When creating or updating (POST
) line targeting, the types
payload object contains all the targeting types which are to be enabled or modified.
Name | Description | Data Type |
---|---|---|
| Specifies the name of the target type. For a complete list of target types, refer to Targeting Types. |
|
| Specifies whether the target type is enabled or disabled for the line.
|
|
Sample Payload (Partial)
{
"types": [
{
"isTargeted": true,
"name": "SITE_LISTS"
},
{
"isTargeted": true,
"name": "AD_POSITION"
}
]
}
Read Line Targeting
Returns targeting data for the specific line.
GET /traffic/lines/{id}/targeting
Parameters
Name | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| path | Specifies the line ID. |
| Y |
Example Request
GET https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting
Example Response
The response returns information about target types targeted by the line.
{
"response": {
"types": [
{
"name": "GEOGRAPHY",
"isTargeted": true
},
{
"name": "PLAYER_SIZE",
"isTargeted": true
},
{
"name": "VIDEO_CONTENT_LENGTH",
"isTargeted": true
},
{
"name": "AD_INITIATION",
"isTargeted": true
},
{
"name": "VIDEO_INVENTORY",
"isTargeted": true
},
{
"name": "DEMOGRAPHIC",
"isTargeted": true
},
{
"name": "FREQUENCY_CAPPING",
"isTargeted": true
},
{
"name": "AB_TESTING",
"isTargeted": true
},
{
"name": "SEGMENT",
"isTargeted": true
},
{
"name": "TECHNOLOGY",
"id": 7,
"isTargeted": true
},
{
"name": "ENHANCED_DAY_PARTING",
"isTargeted": false
},
{
"name": "SITE_LISTS",
"isTargeted": true
},
{
"name": "CONTEXTUALS",
"isTargeted": true
},
{
"name": "EXCHANGES",
"isTargeted": true
},
{
"name": "MOBILE",
"isTargeted": true
},
{
"name": "LANGUAGES",
"isTargeted": true
},
{
"name": "SEAT_LEVEL_SITE_LISTS",
"isTargeted": true
},
{
"name": "BOT",
"isTargeted": true
},
{
"name": "INVENTORY_TYPE",
"isTargeted": true
}
],
"mobileCarriers": [
"Verizon"
],
"isps": [
"Colt Technology Services"
],
"genders": [
"MALE",
"FEMALE"
],
"ages": [
"55-64",
"65-999",
"18-20",
"21-24",
"45-49",
"50-54"
],
"days": [
"ALL"
],
"deviceTypes": [
"UNKNOWN",
"TABLET"
],
"os": [
"ALL"
],
"browsers": [
"ALL"
],
"mobileOs": [
"ANDROID",
"IOS"
],
"languages": [
"ENGLISH",
"GERMAN"
],
"inventoryTypes": [
"APP"
],
"playerSizes": [
"MEDIUM",
"LARGE"
],
"videoContentLength": [
"UP_TO_TWO_MINUTES",
"UNKNOWN"
],
"weatherConditions": [
"STORMY",
"SUNNY"
],
"weatherHumidities": {
"minHumidity": 10,
"maxHumidity": 50,
"allHumidities": false
},
"weatherUVs": [
"LOW",
"MODERATE"
],
"weatherTemperatures": {
"minTemp": 10,
"maxTemp": 50,
"isFahrenheit": true
},
"adInitiations": [
"USERINITIATED"
],
"bots": [
"DOUBLE_VERIFY"
],
"positions": [
"ALL"
],
"userGroupEntry": {
"id": 32659,
"name": "sg2",
"userGroupId": 14962,
"trafficPercent": 56,
"lowerBound": 0,
"upperBound": 55
},
"contextualsIncluded": [
{
"taxonomyType": "IAB",
"id": 43505,
"accountId": 7987,
"name": "iabtest5566",
"updatedAt": "2017-08-01T22:08:52Z",
"categories": [
{
"id": 132269,
"categoryId": 107
},
{
"id": 132270,
"categoryId": 102
}
]
}
],
"contextualsExcluded": [
{
"taxonomyType": "DOUBLE_VERIFY",
"id": 43236,
"accountId": 7987,
"name": "contextual_update_test",
"updatedAt": "2017-07-17T23:58:28Z",
"categories": [
{
"id": 131535,
"categoryId": 6
},
{
"id": 131536,
"categoryId": 9
}
]
}
],
"siteListsIncluded": [
{
"id": 47539,
"name": "TestSiteList_1459797912042",
"accountName": "test-advertiser",
"createdAt": "2018-11-13T00:50:23Z",
"updatedAt": "2018-11-13T00:52:11Z",
"totalSites": 3,
"type": "SITE_LIST"
}
],
"siteListsExcluded": [
{
"id": 56919,
"name": "Test Mobile 11/28",
"accountName": "test-advertiser",
"createdAt": "2017-04-10T23:21:39Z",
"updatedAt": "2019-08-21T20:29:58Z",
"totalSites": 1,
"type": "APP_LIST"
}
],
"publishers": [
{
"id": 3,
"name": "BRXD"
},
{
"id": 4,
"name": "Rubicon"
},
{
"id": 67,
"name": "AdForm(BSW)"
},
{
"id": 74,
"name": "A9"
}
],
"geosIncluded": [
{
"id": "#######ab#can",
"name": "Alberta, Canada",
"description": "alberta",
"level": "State",
"key": "ab, can",
"excluded": false
},
{
"id": "########can",
"name": "Canada",
"description": "canada",
"level": "Country",
"key": "can",
"excluded": false
},
{
"id": "#######15#nor",
"name": "More Og Romsdal, Norway",
"description": "more og romsdal",
"level": "State",
"key": "15, nor",
"excluded": false
}
],
"geosExcluded": [
{
"id": "###callahan####fl#usa",
"name": "Callahan, Florida",
"description": "callahan, fl",
"level": "City",
"key": "callahan, florida",
"excluded": true
}
],
"segmentsIncluded": [
{
"id": "20604896",
"name": "Penny Dreadful S3 BrightRoll Test",
"recency": 30,
"createdAt": "2015-12-08",
"audienceType": "3rd Party",
"segmentType": "COMPOSITE",
"reachCount": 449491095
}
],
"segmentsExcluded": [
{
"id": "50348744",
"name": "FlyWheel Studio Test",
"recency": 90,
"createdAt": "2017-10-13",
"audienceType": "3rd Party",
"segmentType": "COMPOSITE",
"reachCount": 617452399
},
{
"id": "20703845",
"name": "MB Test - HHI 75k+",
"recency": 30,
"createdAt": "2016-05-04",
"audienceType": "3rd Party",
"segmentType": "COMPOSITE",
"reachCount": 135984850
}
],
"threshold": 40,
"frequencyCapValue": 2,
"frequencyCapPeriod": "HOURLY",
"serveUnknownUser": true,
"enableViewabilityFreqCap": false,
},
"errors": null,
"timeStamp": "2018-01-12T01:57:40Z"
}
Add/Update Line Targeting
Adds or updates the specified targets for the specified line.
POST traffic/lines/{id}/targeting/
Parameters
All requests to add or update targets to a line require id
and types
fields.
Name | Parameter Type | Description | Data Type |
---|---|---|---|
| path | Specifies the line ID. |
|
| body | Specifies an array of Targeting Type objects that identify the targeting type and whether it is targeted by the line.
To learn more, refer to Targeting Types. |
|
| body | Specifies the genders targeted. To learn more, refer to Demographic Targeting. |
|
| body | Specifies the age ranges targeted. To learn more, refer to Demographic Targeting. |
|
| body | Specifies the frequency cap interval. To learn more, refer to Frequency Capping Targeting. |
|
| body | Specifies the number of impressions all for the selected To learn more, refer to Frequency Capping Targeting. |
|
| body | Specifies whether the ad is served to known or unknown users. To learn more, refer to Frequency Capping Targeting. |
|
| body | Specifies the days of the week and hours of the day targeted. To learn more, refer to Day Parting Targeting. |
|
| body | Specifies the languages targeted. To learn more, refer to Language Targeting. |
|
| body | Specifies the inventory types targeted. |
|
| body | Specifies the bot fraud prevention partner. To learn more, refer to Fraud Avoidance. |
|
| body | Specifies the ID of the user group to target. To learn more, refer to A/B Testing Targeting. |
|
| body | Specifies the device types targeted. To learn more, refer to Technology Targeting. |
|
| body | Specifies the operating system types targeted. To learn more, refer to Technology Targeting. |
|
| body | Specifies the browser types targeted. To learn more, refer to Technology Targeting. Note: |
|
| body | Specifies the mobile OS types targeted. To learn more, refer to Technology Targeting. Note: |
|
| body | For video ads, specifies how the targeted ad is initiated. To learn more, refer to Ad Initiation Targeting. |
|
| body | For display ads, specifies the location on the page where the ad appears. To learn more, refer to Ad Position Targeting. |
|
| body | For video ads, the platform determines the player size based on height and width (in pixels) specified in the bid request. The platform extracts the larger of the two and assigns a player size. To learn more, refer to Player Size Targeting. |
|
| body | Video content length is the duration of the video a user is about to watch, not the duration of the ad. To learn more, refer to Video Content Length Targeting. |
|
| body | Specifies the mobile carriers and ISPs targeted. To learn more, refer to Connection Targeting. |
|
| body | Specifies the IDs of publishers/exchanges targeted. To learn more, refer to Exchange Targeting. |
|
| body | Specifies the IDs of private marketplace deals to target. To learn more, refer to Exchange Targeting. |
|
| body | Specifies contextuals to include or exclude from targeting. To learn more, refer to Contextuals Targeting. |
|
| body | Specifies site lists and app lists to include or exclude from targeting. To learn more, refer to Site List Targeting. |
|
| body | Specifies geographic locations to include or exclude from targeting. To learn more, refer to Geography Targeting. Note: You cannot target both geographic locations and geofencing locations at the same time. |
|
| body | Specifies geofencing locations to include or exclude from targeting. To learn more, refer to Geography Targeting. Note: You cannot target both geographic locations and geofencing locations at the same time. |
|
| body | Specifies audience segments to include or exclude from targeting. To learn more, refer to Segment Targeting. |
|
| body | Specifies the mobile placement types targeted. To learn more, refer to Mobile Placements Targeting. |
|
| body | Specifies the weather conditions targeted. To learn more, refer to Weather Condition Targeting. |
|
| body | Specifies the weather humidity targeted. To learn more, refer to Weather Humidity Targeting. |
|
| body | Specifies the weather UVs targeted. To learn more, refer to Weather UV Targeting. |
|
| body | Specifies the weather temperature targeted. To learn more, refer to Weather Temperature Targeting. |
|
For each targeting type the line targets, you must specify the payload for that target.
Example Request
The line ID is specified in the path of the resource endpoint:
POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting
All other parameters are specified in the body of the application/json
payload.
{
"id": 412063,
"deviceTypes": [
"DESKTOP",
"PHONE"
],
"os": [
"MAC"
],
"browsers": [
"FIREFOX"
],
"mobileOs": [
"IOS",
"ANDROID"
],
"iosVersionRange":[
"10.1", "12.1"
],
"androidVersionRange":[
"8", "latest"
],
"mobileMakes": [
4,
5,
6
],
"mobileModels": [
12,
20
],
"types": [
{
"name": "TECHNOLOGY",
"id": 7,
"isTargeted": true
}
]
}