DOOH Screen Lists Targeting

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

  • Use a GET request to view DOOH screen lists targeted by the specified line.

  • Use a POST request 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 utilizing DOOH_SCREEN_LISTS targeting type-specific parameters:

Parameter

Parameter Type

Description

Data Type

Required

id

path

The ID of the line.

integer

Y

doohScreenLists

body

The IDs of the DOOH screen lists targeted.

array

Y

types

body

An array used to update, enable or disable targeting types.

The 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 line.

POST traffic/lines/{id}/targeting

Parameters

Specify the line ID in the URL path and all other parameters in the request body.

Sample Request URL

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

Sample Request Body

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

Sample 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

Retrieves DOOH screen lists being targeted by the line.

GET traffic/lines/{id}/targeting

Parameters

The line ID in the URL path.

Sample Request URL

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

Sample 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