Viewability Targeting

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

Overview

You can set hard viewability goals for display and video line items. When you set a viewability threshold for a line item, viewability takes precedence over line item delivery, and you can expect line items to achieve and maintain the viewability goal.

The Oath Ad Platforms DSP supports VIEWABILITY targeting for lines serving display and video ads.

Endpoint

/traffic/lines/{id}/targeting
  • A GET request enables you to view viewability thresholds targeted by the specified line.
  • A POST request enables you to target viewability thresholds with the specified line.

Resources

The targeting resource is the standard Oath Ad Platforms 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 VIEWABILITY target type.

The targeting resource is defined by the following VIEWABILITY targeting type-specific fields:

Field Description Data Type
id Specifies the line ID. integer
inviewThreshold Specifies the viewability rate threshold. A value between 1-100. number

Note

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

Read Viewability Targets

Returns a list of targets for the specified line.

GET /traffic/lines/{id}/targeting

The resource returns information about all of the target types enabled and all of the targets specified for the line including inviewThreshold settings.

To learn more, see Read Line Targeting.

Add/Update Viewability Targets

Adds or updates viewabilty targets.

POST traffic/lines/{id}/targeting/

Parameters

The line ID is specified in the path of the URL. 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 URL:

POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting

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

{
  "inviewThreshold": 1.56,
  "types": [
    {
      "name": "VIEWABILITY",
      "isTargeted": true
    }
  ]
}

See also

About Targeting