Site & App Lists

This article describes resources and services that enable you to read, create, and update site lists and app lists.

Overview

Site lists and app lists are used to blacklist or whitelist apps and URLs for your display, video, and native ads.

App Lists
A list of mobile app names or app URLs that may be specified at the seat level or the advertiser level.
Site Lists
A list of website URLs that may be specified at the seat level or advertiser level.

You can define as many app lists and site lists as you want at the advertiser level. Advertiser-level site lists can apply to a single advertiser, or you can optionally share an advertiser-level list across all the advertisers in a seat.

Hierarchy

A Site List is an advertiser-level object.

Endpoint

/traffic/sitelists

The action taken depends on the HTTP method and the parameters specified.

  • Use the GET method to read an existing site list.
  • Use the POST method to create a new site list.
  • Use the PUT method to update an existing site list.

Resources

Site List Object

The SiteList object contains the following fields:

Table 115 Site List Fields
Field Description Data Type Create Update
id Specifies the site list ID. integer N/A Required
name Specifies the name of the site list. string Required Required
accountId

Specifies the advertiser ID.

To learn more, see Advertisers.

integer Required Optional
status

Specifies the current status of the site list.

Allowed values:

  • :code:`ACTIVE: the site list is active.
  • INACTIVE: the site list is inactive.
string Required Required
type

Specifies the type of the site list.

Allowed values:

  • SITE_LIST: Content of the list is web sites.
  • APP_LIST: Content of the list is mobile apps.
string Required Optional
isShared

Enable / Disable sharing the list across advertisers in your seat. Sharing makes the app/site list available for targeting on other advertisers’ line items.

  • If true, Enable sharing.
  • If false, Disable sharing.
[1]If not specified when creating the site list, defaults to false.
boolean Optional [1] Optional
items Specifies an array of items objects. array Required Optional

Items Object

Each element in the items object contains the following fields:

Table 116 Items Fields
Field Description Data Type Create Update
id Specifies the item ID. integer N/A N/A
itemName

Specifies the name of the item.

  • If the Site List type is SITE_LIST, this field would represent the site URL.
  • If the Site List type is APP_LIST, this field would represent the mobile app name.
string Required Required

Read Site List

Get data for a specific site list.

GET /traffic/sitelists/{id}

Parameters

Table 117 Read Site List Parameters
Parameter Paramerer Type Description Data Type Required
id path Specifies the site list ID. integer Y

Example Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/sitelists/67358

Example Response

{
  "response": {
    "status": "ACTIVE",
    "type": "SITE_LIST",
    "id": 67358,
    "name": "test-site-list-1",
    "accountId": 1356341,
    "isShared": false,
    "updatedAt": "2017-09-22T05:45:36Z",
    "items": [
      {
        "id": 1992605,
        "itemName": "http://yahoo.com"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-09-22T05:45:35Z"
}

Update Site List

Update an existing site list.

PUT /traffic/sitelists/{id}

Partial updates are supported; values of supported fields which are not in the payload will remain unchanged.

Parameters

The Site List id is specified in the url path. All other fields are specified in the body of the application/json payload.

Example Request URL

PUT https://dspapi.admanagerplus.yahoo.com/traffic/sitelists/67358

Example Request Body

{
  "accountId": 1356341,
  "status": "ACTIVE",
  "type": "APP_LIST",
  "items": [
    {
      "itemName": "Angry Birds"
    }
  ]
}

Example Response

{
  "response": {
    "status": "ACTIVE",
    "type": "APP_LIST",
    "id": 67358,
    "name": "test-site-list-1",
    "accountId": 1356341,
    "isShared": false,
    "updatedAt": "2017-09-22T05:50:57Z",
    "items": [
      {
        "id": 1992606,
        "itemName": "Angry Birds"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-09-22T05:50:57Z"
}

Create Site List

Create a new site list.

POST /traffic/sitelists/

Parameters

All parameters are specified in the body of the application/json payload.

Example Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/sitelists

Example Request Body

{
  "accountId": 1356341,
  "name": "test-site-list-1",
  "status": "ACTIVE",
  "type": "SITE_LIST",
  "isShared": false,
  "items": [
    {
      "itemName": "http://yahoo.com"
    }
  ]
}

Example Response

{
  "response": {
    "status": "ACTIVE",
    "type": "SITE_LIST",
    "id": 67358,
    "name": "test-site-list-1",
    "accountId": 1356341,
    "isShared": false,
    "updatedAt": "2017-09-22T05:45:36Z",
    "items": [
      {
        "id": 1992605,
        "itemName": "http://yahoo.com"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-09-22T05:45:35Z"
}

Delete Site List

The DSP Traffic API does not support deletion of site lists.