Device ID Audiences

This article describes APIs for creating, and updating device ID audiences.

Overview

A device ID audience enables you to target custom, device-based audiences. Every device ID audience is based on a list of Apple iOS Identifier for Advertising (IDFA) IDs, or Google Play Advertising IDs (GPADVID) that you provide and use for line targeting.

Note

You can only build a device ID audience for one advertiser at a time, not for an entire seat.

Hierarchy

A Device ID audience can be defined at the advertiser-level.

  • Advertiser-level audiences are specific to a single advertiser account.

Endpoint

/traffic/audiences/device_id

The action taken depends on the HTTP method and the parameters specified.

  • Use the GET method to read an existing device ID audience.
  • Use the POST method to create a new device ID audience.
  • Use the PUT method to update an existing device ID audience.

Resources

The Device ID audience object contains the following fields:

Table 33 Device ID Audience Fields
Field Description Data Type Create Update
id Specifies the audience ID. integer N/A Required
name Specifies the name of the audience. string Required Optional
status

Specifies the current status of the audience.

Allowed values:

  • ACTIVE: the audience can be targeted.
  • INACTIVE: the audience cannot be targeted.
[1]If not specified when creating the audience, defaults to ACTIVE.
string Optional [1] Optional
accountId

Specifies the advertiser ID.

The audience is tied to a specific advertiser and can only be used in that advertisers’ campaigns. To learn more, see Advertisers.

integer Required Required
seedList Specifies an array of device IDs. array Required Optional
seedListType

Specifies the type of devices that can be included.

Allowed values:

  • IDFA: Apple (IDFA)
  • GPADVID: Google
array Required Optional
isDeviceOnly

Enable / Disable cross device support. Our Oath Identity Graph enhances cross-screen capabilities by linking all cookie and mobile device Identifiers deterministically at a person level and probabilistically at a household level. You can choose to turn off the cross device linked cookies and devices; in order to restrict the targeting to the seed audience, that you have uploaded, or collected via our pixel. This disables both deterministic and probabilistic cross device linkages during segment creation as well as targeting time.

  • true: disable cross device support.
  • false: enable cross device support.
[2]If not specified when creating the audience, defaults to false.
boolean Optional [2] Optional
createdAt A read-only field that specifies when the audience was created. string N/A N/A

Read Device ID Audience History

Get the history and status of a device ID audience.

GET /traffic/audiences/device_id/{id}/history?accountId={accountId}

Parameters

Table 34 Read Device ID Audience History Parameters
Parameter Parmameter Type Description Data Type Required
id path Specifies the audience ID. integer Y
accountId query Specifies the advertiser ID. integer Y

Example Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/50346201/history?accountId=1356341

Example 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 Device ID Audience

Get data for a specific device ID audience.

GET /traffic/audiences/device_id/{id}?accountId={accountId}

Parameters

Table 35 Read Device ID Audience Parameters
Parameter Parmameter Type Description Data Type Required
id path Specifies the audience ID. integer Y
accountId query Specifies the advertiser ID. integer Y

Example Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/50346201?accountId=1356341

Example Response

{
  "response": {
    "id": 50346201,
    "name": "test_device_id",
    "status": "ACTIVE",
    "accountId": 1356341,
    "isDeviceOnly": false
  },
  "errors": null,
  "timeStamp": "2017-10-11T00:58:24Z"
}

Update Device ID Audience

Update an existing device ID audience.

PUT /traffic/audiences/device_id/{id}

Partial updates are supported; values of supported fields which are not in the payload will remain unchanged.

Parameters

The audience id is specified in the endpoint path. All other fields are specified in the body of the application/json payload.

Example Request URL

PUT https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/50346201

Example Request Body

{
  "name": "test_device_id-2",
  "accountId": 1356341
}

Example Response

{
  "response": {
    "id": 50346201,
    "name": "test_device_id-2",
    "status": "ACTIVE",
    "accountId": 1356341,
    "isDeviceOnly": false
  },
  "errors": null,
  "timeStamp": "2017-10-11T06:23:53Z"
}

Create Device ID Audience

Create a new device ID audience.

POST /traffic/audiences/device_id

Parameters

All parameters are specified in the body of the application/json payload.

Example Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id

Example Request Body

{
  "name": "test_device_id",
  "status": "ACTIVE",
  "accountId": 1356341,
  "seedList": [
    "34A668B2-03CF-11E5-8418-1697F925EC7B",
    "34a66c5e-03cf-11e5-8418-1697f925ec7b"
  ],
  "seedListType": "GPADVID"
}

Example Response

{
  "response": {
    "id": 50346201,
    "name": "test_device_id",
    "status": "ACTIVE",
    "accountId": 1356341,
    "isDeviceOnly": false
  },
  "errors": null,
  "timeStamp": "2017-10-11T00:33:54Z"
}

Delete Device ID Audience

The DSP Traffic API does not support deletion of device ID audiences.