This article describes resources that enable you to read and define beacon targeting.

Overview

Yahoo DSP supports pixels, which offer a universal, cross-platform tracking tag. Use a single pixel to record many different types of events for conversion tracking.

The pixel tag is a standard code snippet that when placed on an advertiser’s web page can be used to send site interaction information about the advertiser’s users to Verizon Media. This information can then be used by Verizon Media to track conversions, retarget users in real time or collect user data for custom audience creation. As a convenience, the tag can also support inclusion of third-party pixels.

To learn more, see Beacon Targeting.

Endpoint

/traffic/lines/{id}/targeting

• A GET request enables you to view beacons targeted by the specified line.

• A POST request enables you to target beacons with the specified line.

Resources

Targeting Object

The targeting resource is the standard Yahoo DSP resource for targeting consumers based on their profiles, behaviors, and ad content.

This resource comprises multiple fields that enable you to specify line targeting across many types of targets including the SEGMENT, EXCHANGES, and BEACONS target types.

To target beacons, you need only be concerned with the following BEACONS targeting type-specific fields:

Note

For a complete list of targeting resource fields, see Targeting Object.

Beacons Object

The beacons payload object enables you to Add/Update Beacon Targets, Update Beacon Targets, Remove Beacon Targets, or Clear All Beacon Targets targeted by a line.

Beacons Included Object

Beacons Excluded Object

Read Beacons

Returns a list of beacons that can be targeted by the specified line. Beacons may be filtered based on a specified query.

GET /traffic/targeting/pixels?lineId={lineId}&query={query}

The resource accepts two parameters:

Example Request

GET /traffic/targeting/pixels?lineId=365277&query=test

Use URL encoding conventions (i.e. a space should be replaced with a + or %20). Provide a partial search string or leave it empty to get all results.

Example Response

The response contains the following fields of interest:

Add/Update Beacon Targets

Adds or updates the beacons targeted for a line.

POST /traffic/lines/{id}/targeting

Parameters

The line ID is specified in the path of the endpoint. All other parameters are specified in the body of the application/json payload.

Example Request

The line ID is specified in the path of the resource endpoint:

POST traffic/lines/365277/targeting/

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

{
  "beacons": {
    "added": [
      {
        "excluded": false,
        "entityId": 6436593,
        "recency": 30,
        "frequency": 7
      },
      {
        "excluded": true,
        "entityId": 6434432,
        "recency": 50,
        "frequency": 1
      }
    ]
  },
  "types": [
    {
      "name": "BEACONS",
      "isTargeted": true
    }
  ]
}

Example Response

{
  "response": [
    {
      "id": "6508331",
      "name": "test dot broker conversion rule",
      "createdAt": "2016-07-19T21:44:35Z",
      "type": "CONVERSION"
    },
    {
      "id": "6508393",
      "name": "test dot broker retargeting",
      "createdAt": "2016-07-28T06:13:38Z",
      "type": "RETARGETING"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-05T02:23:02Z"
}

Update Beacon Targets

Updates the beacons targeted by a line.

POST /traffic/lines/{id}/targeting

Parameters

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

Example Request

{
  "id": 365277,
  "beacons": {
    "edited": [
      {
        "excluded": false,
        "entityId": 6436593,
        "recency": 55,
        "frequency": 2
      }
    ]
  },
  "types": [
    {
      "name": "BEACONS",
      "isTargeted": true
    }
  ]
}

Remove Beacon Targets

Removes the specified beacons from targeting.

POST /traffic/lines/{id}/targeting

The line ID is specified in the path of the URL. The beacon IDs are specified in the body of the application/json.

Parameters

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

Example Request

{
  "id": 365277,
  "beacons": {
    "removed": [
      6436593
    ]
  },
  "types": [
    {
      "name": "BEACONS",
      "isTargeted": true
    }
  ]
}

Example Response

{
  "response": [
    {
      "id": "6508331",
      "name": "test dot broker conversion rule",
      "createdAt": "2016-07-19T21:44:35Z",
      "type": "CONVERSION"
    },
    {
      "id": "6508393",
      "name": "test dot broker retargeting",
      "createdAt": "2016-07-28T06:13:38Z",
      "type": "RETARGETING"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-05T02:23:02Z"
}

Clear All Beacon Targets

Clears all beacons currently targeted by the specified line.

POST /traffic/lines/{id}/targeting

The line ID is specified in the path of the URL.

Parameters

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

See Also

About Targeting

Beacon Targeting