Email Address Audiences

Overview

An mail address audience is a custom audience you create by providing email addresses.

Note

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

Endpoint

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

Fields

The Email Address audience object 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 email addresses in SHA256 format. array Required Optional
createdAt (Read-Only) Creation timestamp. datetime N/A N/A

Read Audience (Single)

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

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/email_address/{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/email_address/50351924?accountId=1356341

Example Response

{
  "response": {
    "status": "ACTIVE",
    "id": 50351924,
    "name": "audienceTest",
    "accountId": 1356341,
    "createdAt": "2017-10-20",
    "retention_days": 730
  },
  "errors": null,
  "timeStamp": "2017-10-20T19:04:17Z"
}

Update Audience

To update an existing Email Address 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/email_address/{id}
Name Description Type Required?
id Audience / Segment ID integer Y

Example Request

PUT https://dspapi.admanagerplus.yahoo.com/traffic/audiences/email_address/50351924

Example Payload

{
  "name": "audienceTest_2",
  "accountId": 1356341
}

Example Response

{
  "response": {
    "id": 50351924,
    "name": "audienceTest_2",
    "status": "ACTIVE",
    "accountId": 1356341,
    "retention_days": 730
  },
  "errors": null,
  "timeStamp": "2017-10-20T19:23:53Z"
}

Create Audience

To create a new Email Address 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/email_address

Example Payload

{
  "name": "audience3",
  "accountId": 1356341,
  "seedList": [
    "251014dafc651f68edac7e583edab8ed4fbdbe176b9b4c81f67e9e87a66da103",
    "afbc34416ac6e7fbb97331a21fa2823f56952c0796a615d05a07a08cc52704da",
    "42cbe7eebb412bbcd5b566945df59f67962106041ae7ea39f5bc6ee99307c19e",
    "379b4653a40878da7a58458e4d9a99f834fb12179a5d4e2a840f77dc090c9a98"
  ]
}

Example Response

{
  "response": {
    "id": 50351924,
    "name": "audience3",
    "status": "ACTIVE",
    "accountId": 1356341,
    "retention_days": 730
  },
  "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/email_address/{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/email_address/50346201/history?accountId=1356341

Example Response

{
  "history": [
    {
      "id": "AUDAP_Email_20171020T2233502619009",
      "status": "Active",
      "failPercentage": 0,
      "type": "SHA1EMAIL",
      "createdDate": "2017-10-20T22:33:50",
      "errorMessage": "",
      "failedRecords": [],
      "totalIds": 1,
      "duplicated": 0,
      "totalFailed": 0
    }
  ]
}