Device ID Audiences

This article describes resources and services you can use to view, create and update device ID audiences.

Overview

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_id

Use the following HTTP methods:

  • Use the GET method to view 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:

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: you can target the audience.
  • INACTIVE: you cannot target the audience.

Defaults to ACTIVE if you don’t specify a value.

string Optional Optional
accountId

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, see Advertisers.

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

Specifies the types of devices you can include.

Allowed values:

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

Enables or disables cross-device support.

If you enable cross-device support, Verizon Media 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 probabalistic cross-device linkages that occur both when you create the segment and when you target it.

  • true: disables cross device support.
  • false: enables cross device support.

Defaults to false if you don’t specify a value.

boolean Optional 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

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

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 that are not in the payload 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 fields 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 the deletion of device ID audiences.