Player Size Targeting

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

Overview

The Oath Ad Platforms DSP supports PLAYER_SIZE targeting for lines serving video ads.

Endpoint

/traffic/lines/{id}/targeting
  • A GET request enables you to view player sizes targeted by the specified line.
  • A POST request enables you to target player sizes 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 SITE_LISTS target type.

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

Field Description Data Type
playerSizes

For video ads, the platform determines the player size based on height and width (in pixels) specified in the bid request. The platform extracts the larger of the two and assigns a player size:

  • SMALL - Less than 350 pixels
  • MEDIUM - 350 to 500 pixels
  • LARGE - Greater than or equal to 500 pixels
  • UNKNOWN
  • ALL
array

Note

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

Read Player Size 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 playerSizes.

To learn more, see Read Line Targeting.

Add/Update Player Size Targets

Adds or updates player size targets for the specified line.

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.

Parameter Parameter Type Description Data Type Required?
id path Specifies the line ID. integer Y
id body Specifies the line ID. integer Y
id body Specifies the line ID. integer Y
playerSizes body

For video ads, the platform determines the player size based on height and width (in pixels) specified in the bid request. The platform extracts the larger of the two and assigns a player size:

  • SMALL - Less than 350 pixels
  • MEDIUM - 350 to 500 pixels
  • LARGE - Greater than or equal to 500 pixels
  • UNKNOWN
  • ALL
array N
types body

Specifies an array of targeting types to target.

To target playerSizes, the PLAYER_SIZE targeting type must be enabled.

To learn more, see Targeting Types.

array Y

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.

{
  "playerSizes": [
    "SMALL",
    "LARGE"
  ],
  "types": [
    {
      "name": "PLAYER_SIZE",
      "isTargeted": true
    }
  ]
}

See also

About Targeting