IP Address Audiences¶

An IP Address audience is a custom audience you create by providing a list of SHA256-hashed IP addresses.

Hierarchy¶

Define an IP Address audience at the advertiser level.

Endpoint¶

/traffic/audiences/customsegments

Use the following HTTP methods:

Use the GET method to read an existing IP Address audience.
Use the POST method to create a new IP Address audience.
Use the PUT method to update an existing IP Address audience.

Resources¶

The IP Address 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, refer to Advertisers.	`integer`	Required	Required
`seedList`	Specifies an array of email addresses hashed using the SHA256 cryptographic hashing algorithm. At least 1 item is required, the limit is 50K items per request.	`array`	Required	Optional
`seedListType`	In the case of IP Address audiences, the value of this field has to be `SHA256IP`. For `POST`, it is always required. For `PUT`, it is only required when the `seedList` is also sent.	`string`	Required	Optional
`seedListAction`	Specifies the operation which will be performed on the provided `seedList`. Allowed values: `ADD`: insert the provided `seedList` entries `DELETE`: remove the provided `seedList` entries. Defaults to `ADD` if you don’t specify a value.	`string`	Optional	Optional
`createdAt`	A read-only field that specifies when the audience was created.	`string`	N/A	N/A

Read Audience¶

Read an IP Address audience.

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

Parameters¶

Parameter	Parameter Type	Description	Data Type	Required
`id`	path	Specifies the audience ID.	`integer`	Y
`accountId`	query	Specifies the advertiser ID.	`integer`	Y

Sample Request URL¶

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/customsegments/53095732?accountId=2757689

Sample Response¶

{
  "response": {
    "status": "ACTIVE",
    "id": 53095732,
    "name": "Traffic Create IP Custom Audience",
    "accountId": 2757689,
    "retentionDays": 730,
    "createdAt": "2021-05-14"
  },
  "errors": null,
  "timeStamp": "2021-05-14T10:28:53.389Z"
}

Read History¶

Get the history and status of an IP Address audience.

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

Parameters¶

Parameter	Parameter Type	Description	Data Type	Required
`id`	path	Specifies the audience ID.	`integer`	Y
`accountId`	query	Specifies the advertiser ID.	`integer`	Y

Sample Request URL¶

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/customsegments/53095732/history?accountId=2757689

Sample Response¶

{
  "response": [
    {
      "id": "AUDAP_Ipaddress_20210514T1144357342173",
      "status": "Active",
      "failPercentage": 0,
      "type": "SHA256IP",
      "createdDate": "2021-05-14T11:44:36"
    },
    {
      "id": "AUDAP_Ipaddress_20210514T1003346694717",
      "status": "Active",
      "failPercentage": 0,
      "type": "SHA256IP",
      "createdDate": "2021-05-14T10:03:35"
    }
  ],
  "errors": null,
  "timeStamp": "2021-05-14T11:46:31.034Z"
}

Create Audience¶

Create a new IP Address audience.

POST /traffic/audiences/customsegments

Parameters¶

Specify all fields in the body of the application/json payload.

Sample Request URL¶

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

Sample Request Body¶

{
  "accountId": 2757689,
  "name": "Traffic Create IP Custom Audience",
  "seedListType": "SHA256IP",
  "seedListAction": "ADD",
  "seedList": [
      "4cda9cd051e28cce2c10baa075b16fce29dc20014d443004ea9fac1b532c5453",
      "edd1f211054d7c1f7d5cc4baceedb4d9b5231d65aa82ea0892f8ab821e6d2006",
      "d230a1f9533d2218bcdce1c67a1b89c057c0c7adb2e2b53d4e2f8ac296aa9530",
      "e2ac40fc7e5fc9571c0952491784f948bc6a98549db1a33a6abdda993ff1e0d9"
  ],
  "status": "ACTIVE"
}

Sample Response¶

{
   "response": {
     "status": "ACTIVE",
     "id": 53095732,
     "name": "Traffic Create IP Custom Audience",
     "accountId": 2757689,
     "retentionDays": 730,
     "createdAt": "2021-05-14"
   },
   "errors": null,
   "timeStamp": "2021-05-14T10:03:54.060Z"
}

Update Audience¶

Update an existing IP Address audience.

PUT /traffic/audiences/customsegments/{id}

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

Parameters¶

Specify the audience id in the endpoint path. Specify all other fields in the body of the application/json payload.

Sample Request URL¶

PUT https://dspapi.admanagerplus.yahoo.com/traffic/audiences/customsegments/53095732

Sample Request Body¶

{
  "accountId": 2757689,
  "name": "Traffic Create IP Custom Audience Updated",
  "status": "INACTIVE",
}

Sample Response¶

{
  "response": {
    "status": "INACTIVE",
    "id": 53095732,
    "name": "Traffic Create IP Custom Audience Updated",
    "accountId": 2757689,
    "retentionDays": 730,
    "createdAt": "2021-05-14"
  },
  "errors": null,
  "timeStamp": "2021-05-14T10:15:50.678Z"
}

Delete Audience¶

You cannot delete IP Address audiences using the DSP Traffic API.