Device Id Audiences

Overview

A 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.

Endpoint

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

Fields

The Device Id audience payload contains the following fields:

Name Description Type Add Update
id ID of the audience segment. integer N/A Required
name Name of the segment. text Required Optional
status

Current status of the segment.

  • ACTIVE - (Default Value) Active.
  • INACTIVE - Inactive
text Optional Optional
accountId Advertiser/account ID associated with this segment. Refer to Advertisers. integer Required Required
seedList Array containing Device Ids. array Required Optional
seedListType
  • IDFA - Apple (IDFA)
  • GPADVID - Google
text Required Optional
createdAt (Read-Only) Creation timestamp. datetime N/A N/A

Read Audience (Single)

To retrieve data for a specific Device Id Audience, make a GET call with the parameters specified below.

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/{id}?accountId={accountId}
Name Description Type Required?
id Audience / Segment ID integer Y
accountId Account or Advertiser ID integer Y

The response will be the Audience segment associated with the given ID.

Example Request

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

Example Response

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

Update Audience

To update an existing Device Id Audience, make a PUT call with a payload body and id parameter. The response will be the updated Audience.

Partial update is supported; fields that are either not passed or passed as null will be ignored during update.

PUT https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/{id}
Name Description Type Required?
id Audience / Segment ID integer Y

Example Request

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

Example Payload

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

Example Response

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

Create Audience

To create a new Device Id Audience, make a POST call with a payload body. The response will be the newly created Audience.

Example Request

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

Example Payload

{
  "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,
    "retention_days": 720
  },
  "errors": null,
  "timeStamp": "2017-10-11T00:33:54Z"
}

Delete Audience

Audience deletion is not supported by the API.

Read History

To retrieve the history and status, use the endpoint documented below.

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/device_id/{id}/history?accountId={accountId}
Name Description Type Required?
id Audience / Segment ID integer Y
accountId Account or Advertiser ID integer Y

Example Request

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"
}