Contextuals Targeting¶
This article describes resources that enable you to read and define contextual targeting.
Overview¶
If you have created contextuals for an advertiser, you can set up targeting to serve or exclude ads based on the contextual.
The Yahoo DSP supports CONTEXTUALS
targeting for lines serving display and video ads.
To learn more, refer to Contextuals.
Endpoint¶
/traffic/lines/{id}/targeting
A
GET
request enables you to view contextuals targeted by the specified line.A
POST
request enables you to target contextuals with the specified line.
Resources¶
Targeting¶
The targeting
resource is the standard Yahoo DSP resource for targeting consumers based on their profiles, behaviors, and ad content.
The targeting
resource is defined by the following CONTEXTUALS
targeting type-specific fields:
Parameter |
Parameter Type |
Definition |
Data Type |
Required |
---|---|---|---|---|
|
path |
Specifies the line ID. |
|
Y |
|
body |
Specifies contextuals to target or exclude from targeting. To learn more, refer to Contextuals Payload Object. |
|
Y |
|
body |
A read-only array that identifies contextuals targeted by the line. For detailed field reference, refer to Contextual. |
|
N/A |
|
body |
A read-only array that identifies contextuals not targeted by the line. For detailed field reference, refer to Contextual. |
|
N/A |
|
body |
Specifies an array of targeting types to update, enable, or disable.
To learn more, refer to Targeting Types. |
|
Y |
Note
For a complete list of targeting
resource fields, refer to Targeting Object.
Contextuals Payload Object¶
Field |
Description |
Data Type |
---|---|---|
|
Double Verify Authentic Brand Safety Contextual IDs to target. Note: This type of contextual can only be targeted (included), it can not be blocked (excluded). |
|
|
Double Verify Brand Safety Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Double Verify Brand Safety Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
IAB Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added IAB Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
IAS Brand Safety Contextual IDs to target. Note: This type of contextual can only be targeted (included), it can not be blocked (excluded). |
|
|
IAS Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added IAS Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
IAS Media Quality Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added IAS Media Quality Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
Peer39 Brand Safety Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Peer39 Brand Safety Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
Peer39 Content Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Peer39 Content Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
Peer39 Page Language Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Peer39 Page Language Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
Peer39 Page Quality Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Peer39 Page Quality Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
Grapeshot Contextual IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Grapeshot Contextual IDs are to be targeted (included) or blocked (excluded).
|
|
|
Grapeshot Brand Safety IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Grapeshot Brand Safety IDs are to be targeted (included) or blocked (excluded).
|
|
|
Grapeshot Language IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Grapeshot Language IDs are to be targeted (included) or blocked (excluded).
|
|
|
Grapeshot Custom IDs to target. Note: Specified contextuals are targeted (included) by default. To block (exclude) them instead, set |
|
|
Indicates if the added Grapeshot Custom IDs are to be targeted (included) or blocked (excluded).
|
|
|
Indicates if all existing targeted contextuals should be removed. By default,
|
|
|
Contextual IDs to be removed from targeting. |
|
Read Targeting Contextuals¶
Get a list of contextuals that are available for targeting.
GET /traffic/targeting/contextuals?lineId={lineId}&taxonomyType={taxonomyType}&query={query}
All of the accepted parameters are query parameters.
Parameters¶
Parameter |
Description |
Data Type |
Required |
---|---|---|---|
|
Specifies the line ID. |
|
Y |
|
Specifies the taxonomy type.
|
|
Y |
|
Specifies the search term. Use URL encoding conventions (i.e. a space should be replaced with a |
|
Y |
Example Request URL¶
GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/contextuals?lineId=365277&taxonomyType=IAB&query=test
Example Response¶
{
"response": [
{
"taxonomyType": "IAB",
"id": "43188",
"name": "contextual_update_test"
},
{
"taxonomyType": "IAB",
"id": "41843",
"name": "test-iab"
}
],
"errors": null,
"timeStamp": "2017-07-27T21:30:07Z"
}
Add/Update Contextuals Targeting¶
Add or update contextual targets for the specified line.
POST traffic/lines/{id}/targeting/
Parameters¶
The line ID is specified in the path of the URL. All other parameters are specified in the body of the application/json payload.
Example Request URL¶
POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting/
Example Request Body¶
{
"id": 365277,
"contextuals": {
"clearAll": false,
"addedDoubleVerifyAuthenticBrandSafety": [
65733
],
"removed": []
},
"types": [
{
"name": "CONTEXTUALS",
"isTargeted": true
}
]
}
Example Response¶
{
"response": {
"types": [
{
"name": "CONTEXTUALS",
"isTargeted": true
}
],
"contextualsIncluded": [
{
"id": 65733,
"accountId": 306442,
"name": "dv-abs",
"updatedAt": "2019-10-11T23:00:47Z",
"categories": [
{
"id": 184132,
"categoryId": 50571280
},
{
"id": 184131,
"categoryId": 50571278
}
],
"taxonomyType": "DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY"
}
]
},
"errors": null,
"timeStamp": "2019-10-15T00:54:14.401Z"
}