Device ID Audiences
- 3 Minutes to read
Device ID Audiences
- 3 Minutes to read
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Device ID audiences are audiences made up of Apple iOS Identifier for Advertising (IDFA) IDs, or Google Play Advertising IDs (GPADVIDs) that you provide. After you create a device ID audience, you can target the audience at the line level.
Hierarchy
You define a Device ID audience at the advertiser level.
Endpoint
/traffic/audiences/device_idUse the following HTTP methods:
Use the
GETmethod to read an existing device ID audience.Use the
POSTmethod to create a new device ID audience.Use the
PUTmethod to update an existing device ID audience.
Resources
The Device ID audience object contains the following fields:
Field | Description | Data Type | Create | Update |
|---|---|---|---|---|
| Specifies the audience ID. |
| N/A | Required |
| Specifies the name of the audience. |
| Required | Optional |
| Specifies the current status of the audience. Allowed values:
Defaults to |
| Optional | Optional |
| Specifies the advertiser ID. An audience is tied to its advertiser and you can only use it in that advertiser’s campaigns. To learn more, refer to Advertisers. |
| Required | Required |
| Specifies an array of device IDs. Limit is 50K items per request. |
| Required | Optional |
| Specifies the types of devices you can include. Allowed values:
|
| Required | Optional |
| Enables or disables cross-device support. If you enable cross-device support, Yahoo DSP links cookie and mobile device identifiers deterministically at a person level and probabilistically at a household level. Disabling cross-device support turns off device linked cookies and restricts targeting to the seed audience that you have uploaded or collected using a pixel. If you disable cross-device targeting, you disable the deterministic and probabilistic cross-device linkages that occur both when you create the segment and when you target it.
Defaults to |
| Optional | Optional |
| A read-only field that specifies when the audience was created. |
| N/A | N/A |
Read History
Get the history and status of a device ID audience
GET /traffic/audiences/device_id/{id}/history?accountId={accountId}Parameters
Parameter | Parameter Type | Description | Data Type | Required |
|---|---|---|---|---|
| path | Specifies the audience ID. |
| Y |
| query | Specifies the advertiser ID. |
| Y |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/50346201/history?accountId=1406321Sample Response
{
"response": [
{
"id": "AUDAP_PreScored_20171012T0311348424657",
"status": "Completed",
"failPercentage": 0,
"type": "IDFA",
"createdDate": "2017-10-12T03:11:35",
"errorMessage": "",
"failedRecords": [],
"totalIds": 2,
"duplicated": 0,
"totalFailed": 0
},
{
"id": "AUDAP_PreScored_20171012T0307180667358",
"status": "Completed",
"failPercentage": 0,
"type": "GPADVID",
"createdDate": "2017-10-12T03:07:18",
"errorMessage": "",
"failedRecords": [],
"totalIds": 2,
"duplicated": 0,
"totalFailed": 0
}
],
"errors": null,
"timeStamp": "2017-10-12T03:11:48Z"
}Read Audience
Read a specific device ID audience.
GET /traffic/audiences/device_id/{id}?accountId={accountId}Parameters
Parameter | Parameter Type | Description | Data Type | Required |
|---|---|---|---|---|
| path | Specifies the audience ID. |
| Y |
| query | Specifies the advertiser ID. |
| Y |
Sample Request URL
GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/51525777?accountId=1406321Sample Response
{
"response": {
"status": "ACTIVE",
"id": 51525777,
"name": "dev_id_56",
"accountId": 1406321,
"createdAt": "2020-02-01",
"isDeviceOnly": false
},
"errors": null,
"timeStamp": "2020-02-01T05:12:41.049Z"
}Create Audience
Create a new device ID audience.
POST /traffic/audiences/device_idParameters
All fields are specified in the body of the application/json payload.
Sample Request URL
POST https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_idSample Request Body
{
"name": "test_device_id",
"status": "ACTIVE",
"accountId": 1406321,
"seedList": [
"34A668B2-03CF-11E5-8418-1697F925EC7B",
"34a66c5e-03cf-11e5-8418-1697f925ec7b"
],
"seedListType": "GPADVID"
}Sample Response
{
"response": {
"status": "ACTIVE",
"id": 51525777,
"name": "test_device_id",
"accountId": 1406321,
"createdAt": "2020-02-01",
"isDeviceOnly": false
},
"errors": null,
"timeStamp": "2020-02-01T05:12:41.049Z"
}Update Audience
Update an existing device ID audience.
PUT /traffic/audiences/device_id/{id}Partial updates are supported; values of supported fields that are not in the payload remain unchanged.
Note
Additional Device IDs may be appended to the audience using the
PUToperation.
Parameters
The audience id is specified in the endpoint path. All other fields are specified in the body of the application/json payload.
Sample Request URL
PUT https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id{id}Sample Request Body
{
"name": "test_device_id-2",
"accountId": 1406321
}Sample Response
{
"response": {
"status": "ACTIVE",
"id": 51525777,
"name": "test_device_id-2",
"accountId": 1406321,
"createdAt": "2020-02-01",
"isDeviceOnly": false
},
"errors": null,
"timeStamp": "2020-02-01T05:12:41.049Z"
}Delete Audience
The DSP Traffic API does not support the deletion of device ID audiences.
Was this article helpful?
