Conversion Rule Audiences

A conversion rule audience enables you to target custom audiences based on conversion rules. A conversion rule audience is built from Dot tags created via the Beacons 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

/traffic/audiences/conversion_rule

• Use the GET method to read an existing conversion rule audience.

• Use the POST method to create a new conversion rule audience.

• Use the PUT method to update an existing conversion rule audience.

Resources

The conversion_rule resource defines a conversion rule audience. The conversion_rule resource contains the following fields:

Read Audience

Read a specific conversion rule audience.

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

Parameters

Sample Request URL

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

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

Read Conversion Rules

Get a filtered list conversion rules for specific advertisers.

GET /traffic/audiences/conversion_rule/lookups?accountId={accountId}&query={query}&page={page}&limit={limit}&sort={sort}&dir={dir}

Parameters

Sample Request URL

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

Sample Response

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

Create Audience

Create a new conversion rule audience.

POST  /traffic/audiences/conversion_rule

Note

Conversion rule audiences take about 24 hours to populate.

Parameters

All fields are specified in the body of the application/json payload.

Sample Request URL

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

Sample Request Body

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

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

Update Audience

Update an existing conversion rule audience.

Note

Once a conversion rule audience is created, it can not be changed except for its name or status.

PUT /traffic/audiences/conversion_rule/{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.

Sample Request URL

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

Sample Request Body

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

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

Delete Audiences

The DSP Traffic API does not support deletion of conversion rule audiences.