Site / App Lists

Overview

Site / App Lists are used to blacklist or whitelist apps and URLs for your display, video, and native ads.

App Lists Lists of mobile app names or app URLs. Site Lists Lists of website URLs.

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.

Endpoint

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

Fields

The SiteList object contains the following fields:

Name Description Type Add Update
id ID of the list. integer N/A Required
name Name of the list. text Required Required
accountId Advertiser/account ID. Refer to Advertisers. integer Required Required
status

Current status of the list.

  • ACTIVE - Active.
  • INACTIVE - Inactive
text Required Required
type

Type of site list.

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

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

  • true - Enable sharing.
  • false - (Default) Disable sharing.
boolean Optional Optional
childrenCount (Read-Only) Total number of items in the list. integer N/A N/A
updatedAt (Read-Only) Last updated timestamp. datetime N/A N/A
items Array containing SiteList items objects. array Required Required

items object

Each element in the items object contains the following fields:

Name Description Type Add Update
id ID of the record. integer N/A N/A
itemName If creating a site list, this field would represent the site URL. If creating an app list, this would be the mobile app name. text Required Required

Read Site List (Single)

To retrieve data for a specific Site List, make a GET call with the id parameter.

GET https://dspapi.admanagerplus.yahoo.com/traffic/sitelists/{id}
Name Description Type Required?
id Site List ID integer Y

The response will be the Site List associated with the given ID.

Example Request

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

Example Response

{
  "response": {
    "status": "INACTIVE",
    "id": 1,
    "name": "test_site_list",
    "accountId": 281947,
    "isAppName": true,
    "isShared": false,
    "updatedAt": "2017-05-26T22:25:22Z",
    "childrenCount": 2,
    "items": [
      {
        "id": 1985394,
        "itemName": "http://www.yahoo.com"
      },
      {
        "id": 1985395,
        "itemName": "http://www.autos.com"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-07-13T21:49:36Z"
}

Update Site List

To update an existing Site List, make a PUT call with a payload body and id parameter. The response will be the updated Site List.

Partial update is supported; fields that are either not passed or passed as null will be ignored during update.

PUT https://dspapi.admanagerplus.yahoo.com/traffic/sitelists/{id}
Name Description Type Required?
id Site List ID integer Y

Example Request

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

Example Payload

{
  "accountId": 306442,
  "status": "ACTIVE",
  "type": "SITE_LIST",
  "items": [
    {
      "itemName": "http://aol.com"
    }
  ]
}

Example Response

{
  "response": {
    "status": "ACTIVE",
    "type": "SITE_LIST",
    "id": 1,
    "name": "test-site-list-1",
    "accountId": 306442,
    "isShared": false,
    "updatedAt": "2017-05-27T06:11:33Z",
    "childrenCount": 1,
    "items": [
      {
        "id": 1985456,
        "itemName": "http://aol.com"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-07-13T21:49:36Z"
}

Create Site List

To create a new Site List, make a POST call with a payload body. The response will be the newly created Site List.

Example Request

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

Example Payload

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

Example Response

{
  "response": {
    "status": "ACTIVE",
    "id": 61986,
    "name": "test-site-list-1",
    "accountId": 306442,
    "isShared": false,
    "updatedAt": "2017-05-27T00:00:48Z",
    "childrenCount": 1,
    "items": [
      {
        "id": 1985414,
        "itemName": "http://yahoo.com"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-07-13T21:49:36Z"
}

Delete Site List

Site List deletion is not supported by the API.