Conversion Rule Audiences

Overview

A conversion rule audience is built from Dot tags created via the Beacon/Pixels API. Before you set up conversion rules for your audience, create the Dot tags on which the audience will be built.

Note

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

Endpoint

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

Fields

The Conversion Rule 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
createdAt (Read-Only) Creation timestamp. datetime N/A N/A
pixelRuleId Associated pixel rule id. integer Required N/A
pixelRuleName (Read-Only) Pixel rule name. text N/A N/A
pixelRuleSize (Read-Only) Audience size for the rule. integer N/A N/A

Read Audience (Single)

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

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/conversion_rule/{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 Conversion Rule Audience segment associated with the given ID.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/audiences/conversion_rule/50259012?accountId=1356341

Example Response

{
  "response": {
    "status": "ACTIVE",
    "id": 50259012,
    "name": "HP Conversion Audience",
    "accountId": 1356341,
    "pixelRuleName": "HP Conversion",
    "pixelRuleId": 10055198,
    "pixelRuleSize": 58888
  },
  "errors": null,
  "timeStamp": "2017-10-20T19:04:17Z"
}

Update Audience

To update an existing Conversion Rule 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.

Note

You cannot change your conversion rule audiences once you create them. You can only update a conversion rule name or its status.

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

Example Request

PUT https://dspapi.admanagerplus.yahoo.com/traffic/audiences/conversion_rule/50259012

Example Payload

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

Example Response

{
  "response": {
    "status": "ACTIVE",
    "id": 50259012,
    "name": "audienceTest_2",
    "accountId": 1356341,
    "pixelRuleName": "HP Conversion",
    "pixelRuleId": 10055198,
    "pixelRuleSize": 58888
  },
  "errors": null,
  "timeStamp": "2017-10-20T19:04:17Z"
}

Create Audience

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

Note

Conversion rule audiences take about 24 hours to populate.

Example Request

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

Example Payload

{
  "name": "Create_Conversion_Rule",
  "accountId": 1356341,
  "pixelRuleId": 10067237,
  "status": "ACTIVE"
}

Example Response

{
  "response": {
    "status": "ACTIVE",
    "id": 50389217,
    "name": "Create_Conversion_Rule",
    "accountId": 1356341,
    "pixelRuleName": "FH P2_Player-JoinPublic",
    "pixelRuleId": 10067237,
    "pixelRuleSize": 2605
  },
  "errors": null,
  "timeStamp": "2017-10-11T00:33:54Z"
}

Delete Audience

Audience deletion is not supported by the API.

Read Conversion Rules (Filtered)

To retrieve a list of conversion rules for specific advertiser, make a GET call with the supported query parameters.

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/conversion_rule/lookups?accountId={accountId}&page={page}&limit={limit}&sort={sort}&dir={dir}&query={query}
Name Description Type Required?
accountId Account or Advertiser ID integer Y
page Page number integer N
limit Total number of items to return. Maximum allowed value is 100. integer N
sort Column to sort by text N
dir Sort direction. Valid values: asc, desc text N
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). text N

The response will be a list of matching conversion rules with the number of unique users (audience size) for each entry.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/conversion_rule/lookups?accountId=1356341&page=1&limit=3&dir=desc&sort=name

Example Response

{
  "response": [
    {
      "id": 10023297,
      "name": "結帳頁面",
      "uniqueUserCount": 2
    },
    {
      "id": 152028,
      "name": "Z_Flow_PxlZzaS8vG1Uu",
      "uniqueUserCount": 0
    },
    {
      "id": 149474,
      "name": "Z_Flow_PxlZwQx1KmESq",
      "uniqueUserCount": 0
    }
  ]
}