Supply List Targeting

  • 3 minute(s) read
Prev Next

Supply lists containing app, site or seller ID lists can be targeted by using the SITE_LISTS targeting type.

Endpoint

/traffic/lines/{id}/targeting

  • A GET request enables you to view supply lists targeted by the specified line.

  • A POST request enables you to target supply 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.

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.

Parameter

Parameter Type

Definition

Data Type

Required

id

path

Specifies the line ID.

integer

Y

siteLists

body

Specifies a payload object that defines the supply lists to be added, removed or cleared. Refer to SiteLists Object for more details.

array

Y

siteListsIncluded

body

A read-only array that displays the supply lists which are marked as Included.

array

N/A

siteListsExcluded

body

A read-only array that displays the supply lists, which are marked as Excluded.

array

N/A

SiteLists Object

Field

Description

Data Type

added

Specifies a siteList for targeting. An array of objects that contains the following required fields.

  • entityId - Specifies the ID of the supply list to be targeted.

  • excluded - Indicates if the added IDs are to be excluded or included.

    • If true, exclude from targeting.

    • If false, include in targeting.

array

removed

Specifies an array of supply lists to be removed. An array of IDs.

array

clearAll

Indicates if all existing supply lists should be removed.

boolean

types

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

SITE_LISTS targeting type must be specified to apply the changes.

To learn more, refer to Targeting Types.

array

Read Supply List Targets

Retrieves a list of supply lists that may be targeted.

GET https://api.admanagerplus.yahoo.com/traffic/targeting/sitelists?lineId={lineId}&page={page}&limit={limit}&sort={sort}&dir={dir}&query={query}

All of the accepted parameters are query parameters.

Parameters

Parameter

Description

Data Type

Required

lineId

Specifies the line ID.

integer

Y

page

Specifies the page number.

integer

N

limit

Specifies the total number of items to return. Maximum allowed value is 100.

integer

N

sort

Specifies the column to sort by.

string

N

dir

Specifies the sort direction. Valid values:

  • asc

  • desc

string

N

query

Specifies the Search term.

Use URL encoding conventions (i.e. a space should be replaced with a + or %20). Provide a partial search string or leave it empty to get all results.

string

Y

Sample Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/targeting/sitelists?limit=3&lineId=365277&query=test

Sample Response

{
  "response": [
    {
      "id": 56919,
      "name": "Test Mobile 11/28",
      "createdAt": "2016-11-29T01:00:47Z"
      "type": "APP_LIST"
    },
    {
      "id": 200346,
       "name": "SellerID Test",
       "createdAt": "2025-09-05T00:00:36Z",
       "type": "SELLER_ID_LIST"
    },
    {
      "id": 62187,
      "name": "test site list",
      "createdAt": "2017-05-31T22:35:59Z"
      "type": "SITE_LIST"
    }
  ],
  "errors": null,
  "timeStamp": "2017-08-03T05:18:34Z"
}

Add/Update Supply Lists Targeting

Add or update supply 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.

Sample Request URL

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

Sample Request Body

{
  "siteLists": {
    "removed": [],
    "clearAll": false,
    "added": [
      {
        "excluded": false,
        "entityId": 62187
      },
      {
        "excluded": true,
        "entityId": 90950
      }
    ]
  },
  "types": [
    {
      "name": "SITE_LISTS",
      "isTargeted": true
    }
  ]
}

Sample Response

{
  "response": {
    "types": [
      {
        "name": "SITE_LISTS",
        "isTargeted": true
      }
    ],
    "siteListsIncluded": [
      {
        "id": 62187,
        "name": "test site list",
        "accountName": "Test_video_karim",
        "createdAt": "2017-05-31T22:35:59Z",
        "updatedAt": "2017-05-31T23:35:01Z",
        "totalSites": 8,
        "type": "SITE_LIST"
      }
    ],
    "siteListsExcluded": [
      {
        "id": 90950,
        "name": "test222",
        "accountName": "Traffic API ADV",
        "createdAt": "2018-11-13T00:50:23Z",
        "updatedAt": "2018-11-13T00:52:11Z",
        "totalSites": 3,
        "type": "APP_LIST"
      }
    ],
    "errors": null,
    "timeStamp": "2018-01-12T01:57:40Z"
  }
}

Additional Resources