DOOH Screen Lists Targeting

This article describes resources that enable you to read and write DOOH screen lists targeting.

Overview

You can target DOOH lines (Display or Video) using a list of DOOH screen lists. To learn more, refer to Digital Out Of Home (DOOH).

Endpoint

/traffic/lines/{id}/targeting
  • A GET request enables you to view DOOH screen lists targeted by the specified line.

  • A POST request enables you to target DOOH screen lists with the specified line.

Resources

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

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

Parameter

Parameter Type

Description

Data Type

Required

id

path

Specifies the line ID.

integer

Y

doohScreenLists

body

Specifies the IDs of the DOOH screen lists targeted.

array

Y

types

body

Specifies an array of targeting types to update, enable, or disable.

DOOH_SCREEN_LISTS targeting type must be specified to apply the changes.

To learn more, refer to Targeting Types.

array

Y

Note

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

Add/Update DOOH Screen Lists Targeting

Add or update DOOH screen lists targeting 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.

Example Request URL

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

Example Request Body

{
  "doohScreenLists": [
    1, 2
  ],
  "types": [
    {
      "name": "DOOH_SCREEN_LISTS",
      "isTargeted": true
    }
  ]
}

Example Response

{
  "response": {
    "types": [
      {
        "name": "DOOH_SCREEN_LISTS",
        "isTargeted": true
      }
    ],
    "doohScreenLists": [
      {
        "id": 1,
        "accountId": 15215,
        "name": "Test Clone Advertiser Screen List"
      },
      {
        "id": 2,
        "accountId": 15215,
        "name": "Test Screen List"
      }
    ],
  }
  "errors": null,
  "timeStamp": "2023-01-23T13:45:09.492Z"
}

Read DOOH Screen Lists Targeting

Reads DOOH screen lists targeting for the specified line.

GET traffic/lines/{id}/targeting

Parameters

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

Example Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/lines/2146923/targeting

Example Response

{
  "response": {
    "types": [
      {
        "name": "DOOH_SCREEN_LISTS",
        "isTargeted": true
      }
    ],
    "doohScreenLists": [
      {
        "id": 1,
        "accountId": 15215,
        "name": "Test Clone Advertiser Screen List"
      },
      {
        "id": 2,
        "accountId": 15215,
        "name": "Test Screen List"
      }
    ],
  }
  "errors": null,
  "timeStamp": "2023-01-23T13:45:09.492Z"
}

Additional Resources

About Targeting