Ad Initiation Targeting

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

Overview

The Oath Ad Platforms DSP supports AD_INITIATION targeting for lines serving video and native ads.

Endpoint

/traffic/lines/{id}/targeting
  • A GET request enables you to view ad initiations targeted by the specified line.
  • A POST request enables you to target ad initiations 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 SEGMENT, EXCHANGES, and AD_INITIATION target types.

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

Field Description Data Type
id Specifies the line ID. integer
adInitiations

For video ads, specifies how the targeted ad is initiated:

  • AUTOINITIATED - The video starts without any user action.
  • USERINITIATED - The video starts only if the user clicks Play.
  • ANDROID
  • UNKNOWN
  • ALL
array

Note

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

Read Ad Initiation Targets

Returns a list of targets for the specified line.

GET /traffic/lines/{id}/targeting

The resource returns all targets specified for the line including adinitiations.

To learn more, see Read Line Targeting.

Add/Update Ad Initiation Targets

Specifies video and native ads to target based on how they were initiated.

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.

Table 130 Add/Update Ad Initiation Target Parameters
Parameter Parameter Type Definition Data Type Required
id path Specifies the line lD. integer Y
adInitiations body

For video ads, specifies how the targeted ad is initiated:

  • AUTOINITIATED - The video starts without any user action.
  • USERINITIATED - The video starts only if the user clicks Play.
  • ANDROID
  • UNKNOWN
  • ALL
array Y
types body

Specifies an array of targeting types to target. To target adInitiations, the AD_INITIATION targeting type must be specified.

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.

{
  "adInitiations": [
    "USERINITIATED"
  ],
  "types": [
    {
      "name": "AD_INITIATION",
      "isTargeted": true
    }
  ]
}

See also

About Targeting