App & Site Lists

This article describes resources and services you can use to view, create, and update app lists and site lists.

Overview

Use app lists and site lists to allow or deny apps or sites (URLs) for your display, video, and native lines.

• App Lists. Lists of mobile apps.

• Site Lists. Lists of websites.

Create as many app lists and site lists as you want for a single advertiser, or shared across all the advertisers in a seat.

Hierarchy

A Site List is an object for both app lists and site lists. You can define a Site List at the seat level or the advertiser level.

• Seat-level app and site lists are shared by every advertiser in the seat.

• Advertiser-level app and site lists are specific to a single advertiser.

Endpoint

/traffic/sitelists

Use the following HTTP methods:

• Use the GET method to view an existing app list or site list.

• Use the POST method to create a new app list or site list.

• Use the PUT method to update an existing app list or site list.

Resources

Site List

The Site List object contains the following fields:

Items

Each element in the items object contains the following fields:

Read Site List

Get data for a specific app list or site list.

GET /traffic/sitelists/{id}

Parameters

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"
}

Create Site List

Create a new app list or site list.

POST /traffic/sitelists/

Parameters

All fields 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"
}

Update Site List

Update an existing app or site list.

PUT /traffic/sitelists/{id}

Partial updates are supported; values of supported fields that are not in the payload 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"
}

Delete Site List

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