- 7 Minutes to read
Technology Targeting
- 7 Minutes to read
This article describes resources that enable you to read and define technology targeting rules.
Overview
Technology targeting enables you to target consumers based on the technologies in their computing environment. Consumers may be targeted by device type, operating system, mobile operating system, browser, and mobile device make or model.
The Yahoo DSP supports TECHNOLOGY
targeting for lines serving display, video, and native ads.
Endpoint
/traffic/lines/{id}/targeting
A
GET
request enables you to view technology targeted by the specified line.A
POST
request enables you to target technology with the specified line.
Resources
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 TECHNOLOGY
target type.
The targeting
resource is defined by the following TECHNOLOGY
targeting type-specific fields:
Targeting Object
The targeting
resource is defined by the following TECHNOLOGY
targeting type-specific fields:
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| path | Specifies the line ID. |
| Y |
| body | Specifies the device types targeted. Valid options include:
|
| N |
| body | Specifies the operating system types targeted. Valid options include:
|
| N |
| body | Specifies the browser types targeted. Valid options include:
Note: |
| N |
| body | Specifies the mobile browser types targeted. Valid options include:
Note: |
| N |
| body | Specifies the mobile OS types targeted. Valid options include:
Note: |
| N |
| body | Specifies an array of mobile make IDs. To retrieve a list of mobile makes, use the Read Mobile Makes API. Note: |
| Y |
| body | Specifies an array of mobile model IDs. To retrieve a list of mobile models, use the Read Mobile Models API. Note: Note: The |
| Y |
| body | Specifies an array of iOS version numbers. To use the latest version of iOS in the range, specify a single beginning value. The Yahoo DSP will automatically close the range with LATEST. To view available iOS versions, use Read Mobile OS Versions. |
| N |
| body | Specifies an array of Android version numbers. To use the latest version of the Android in the range, specify a single beginning value. The Yahoo DSP will automatically close the range with LATEST. To view available Android versions, use Read Mobile OS Versions. |
| N |
| body | Specifies an array of targeting types to update, enable, or disable.
To learn more, refer to Targeting Types. |
| Y |
Mobile Make Object
The Read Mobile Makes API returns an array of Mobile Make objects.
Field | Description | Data Type |
---|---|---|
| Specifies the ID number of the mobile make. |
|
| Specifies the name of the mobile make. |
|
| Specifies the name of the mobile operating system. |
|
Mobile Model Object
The Read Mobile Models API returns an array of Mobile Model objects.
Field | Description | Data Type |
---|---|---|
| Specifies the ID number of the mobile model. |
|
| Specifies the name of the mobile model. |
|
| Specifies the name of the mobile device type. |
|
| Specifies the name of the mobile operating system. |
|
| Specifies the name of the mobile make. |
|
Read Technology Targets
Returns a list of targets for the specified line.
GET /traffic/lines/{id}/targeting
The resource returns information about all of the target types enabled and all of the targets specified for the line including deviceTypes
, os
, browsers
, and mobileOS
.
To learn more, refer to Read Line Targeting.
Example Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting
Example Response
{
"response": {
"types": [
{
"name": "TECHNOLOGY",
"isTargeted": true
}
],
"mobileMakes": [
"LG"
],
"mobileModels": [
"iPhone 6S",
"Apple iPhone SE"
],
"deviceTypes": [
"PHONE",
"DESKTOP"
],
"os": [
"ALL"
],
"browsers": [
"ALL"
],
"mobileBrowsers": [
"ALL"
],
"mobileOS": [
"ANDROID",
"IOS"
]
},
"errors": null,
"timestamp": "2018-02-22T00:24:22Z"
}
Add/Update Technology Targeting
Add or update the technology targeting for the specific 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.
Depending on the parameters specified, you can target consumers based on device types, operating systems, browsers, mobile operating systems, mobile device makes or mobile device models.
Device type, mobile OS, mobile make, and mobile model targeting are interdependent.
The
mobileOS
parameter constrains themobileMakes
parameter.The
deviceType
parameter constrains themobileModels
parameter.The
mobileMakes
parameter constrains themobileModels
parameter.
To learn more, refer to Status and Error Codes.
Example Request URL
POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting
Example Request Body
{
"mobileMakes": [
1
],
"mobileModels": [
9
],
"deviceTypes": [
"DESKTOP",
"PHONE"
],
"os": [],
"browsers": [],
"mobileBrowsers": [],
"mobileOS": [
"IOS"
],
"iosVersionRange": [
"11.0"
],
"androidVersionRange": [
"7.1"
],
"types": [
{
"name": "TECHNOLOGY",
"isTargeted": true
}
]
}
Example Response
{
"response": {
"types": [
{
"name": "TECHNOLOGY",
"isTargeted": true
}
],
"deviceTypes": [
"DESKTOP",
"PHONE"
],
"os": [],
"browsers": [],
"mobileBrowsers": [],
"mobileOS": [
"ALL"
],
"IOSVersions": [
"11.0",
"LATEST"
],
"AndriodVersions": [
"7.1",
"LATEST"
],
"mobileMakes": [
"Apple"
],
"mobileModels": [
"Google Nexus 6"
]
},
"errors": null,
"timeStamp": "2018-04-19T21:47:05Z"
}
Status and Error Codes
Code | Description |
---|---|
422 | One or more mobile model(s) selected are not compatible with the selected mobile OS(s). |
422 | Make and model selections are not compatible with the selected device type. |
422 | Specify mobile devices by mobile model or mobile make, but not both. One or more of the specified mobile models belongs to specified mobile make. |
422 | One or more mobile make(s) selected are not compatible with the selected mobile OS(s). |
Read Mobile Makes
Returns a list of mobile makes.
GET /traffic/targeting/mobilemakes
If no query parameters are specified, mobile makes are returned for all operating systems.
The resource returns an array of Mobile Make objects that include the mobileOS
, mobileMake
, id
. Use the mobile make ID to target consumers based on their mobile make. To learn more, refer to Add/Update Technology Targeting.
Parameters
All parameters are specified as a query appended to the end of the endpoint URL.
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| query | Specifies a comma-separated list of mobile operating systems. Available options include:
If no parameters are specified, mobile makes are returned for all operating systems. |
| N |
Example Request URL
GET traffic/targeting/mobilemakes?mobileOSes=IOS,ANDROID
Example Response
{
"response": [
{
"id": 1,
"mobileMake": "Apple",
"mobileOS": "IOS"
},
{
"id": 2,
"mobileMake": "Google",
"mobileOS": "ANDROID"
}
],
"errors": null,
"timeStamp": "2018-01-12T01:07:13Z"
}
Read Mobile Models
Returns a list of mobile models.
GET /traffic/targeting/mobilemodels
If no query parameters are specified, mobile models are returned for all operating systems and device types.
The resource returns an array of Mobile Model objects that include the modelName
, mobileMake
, id
. Use the mobile model ID to target consumers based on their mobile model. To learn more, refer to Add/Update Technology Targeting.
Parameters
All parameters are specified as a query appended to the end of the endpoint URL.
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| query | Specifies a comma-separated list of mobile operating systems. Available options include:
If no parameters are specified, mobile models are returned for all operating systems. |
| N |
| query | Specifies a comma-separated list of device types. Available options include:
If no parameters are specified, mobile models are returned for all device types. |
| N |
| query | Specifies the page size. |
| N |
| query | Specifies the page number. |
| N |
Example Request URL
GET traffic/targeting/mobilemodels?mobileOSes=IOS,ANDROID&deviceTypes=PHONE&limit=5000&page=1
Example Response
{
"response": [
{
"id": 1,
"modelName": "Sony Xperia Z3",
"deviceType": "Phone",
"mobileOS": "ANDROID",
"mobileMake": "Sony"
},
{
"id": 2,
"modelName": "HTC One M7",
"deviceType": "Phone",
"mobileOS": "ANDROID",
"mobileMake": "HTC"
}
],
"errors": null,
"timeStamp": "2018-01-12T01:07:13Z"
}
Read Mobile OS Versions
Returns a list of iOS or Android mobile operating system versions.
GET /traffic/targeting/mobileosversions
Parameters
All parameters are specified as a query appended to the end of the endpoint URL.
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| path | Specifies the mobile make. Valid options include: If no |
| N |
Example Request URL
GET traffic/targeting/mobileosversions?mobileOSes=IOS,ANDROID
Example Response
{
"response": {
"IOSVersions": [
"latest",
"1.0",
"1.1",
"2.0",
"2.1",
"2.2",
"3.0",
"3.1",
"3.2",
"4.0",
"4.1",
"4.2",
"4.3",
"5.0",
"5.1",
"6.0",
"6.1",
"7.0",
"7.1",
"8.0",
"9.0",
"10.0",
"8.1",
"8.2",
"8.3",
"8.4",
"9.1",
"9.2",
"9.3",
"10.1",
"10.2",
"10.3",
"11.0",
"11.1",
"12.0",
"12.1",
"13.0",
"14.0",
"14.1",
"14.2",
"14.3",
"14.4",
"14.5",
"14.6",
"14.7",
"14.8",
"15.0",
"15.1",
"15.2",
"15.3",
"15.4"
],
"AndroidVersions": [
"latest",
"0.5",
"1",
"1.1",
"1.5",
"1.6",
"2",
"2.1",
"2.2",
"2.3",
"2.4",
"3",
"3.1",
"3.2",
"4",
"4.1",
"4.2",
"4.3",
"4.4",
"5",
"6",
"7",
"5.1",
"7.1",
"8",
"8.1",
"9",
"10",
"11",
"12"
]
},
"errors": null,
"timeStamp": "2021-03-10T19:14:13.814Z"
}