Yahoo Native Lists

This article describes services for creating, reading, updating and searching native lists.

Overview

You can use the Native List resource to manage and search for native lists.

A native list is a list of sites or apps that you can apply to targeting rules for Yahoo native lines. For information on targeting a native list, see Native List Targeting.

Note

Yahoo DSP API currently only supports targeting rules that block a native list, so plan your native lists accordingly.

Endpoint

/traffic/nativelists

Resources

Yahoo DSP API supports the following fields creating and managing native lists.

Field

Description

Data Type

Characteristics

Required

name

The name of the native list.

String

Mutable

Y

accountId

The account’s identifier.

Long

Immutable

Y

status

The status of the native list. When INACTIVE, it’s not available for line targeting.

String

Mutable

Y

items

An array of items. An item can be an app or website. Limit of 500 items.

Array <item>

Mutable

Y

item.itemName

A valid website or app domain.

String

Mutable

Y

Create

Example Request

POST /traffic/nativelists HTTP/1.1
Host: <HOST_NAME>
Content-Type: application/json
Accept: application/json
X-Auth-Method: OAuth2
X-Auth-Token: <ACCESS_TOKEN>
{
  "items": [
      {
        "itemName": "happymedium.world"
      },
      {
        "itemName": "ford.com"
      },
      {
        "itemName": "honda.com"
      },
      {
        "itemName": "yamaha.com"
      }
  ],
      "accountId": 1111,
  "name": "HappyMedium Native List 1",
      "status": "ACTIVE"
}

Example Response

{
  "response": {
     "id": 4,
     "accountId": 1234,
     "name": "HappyMedium Native List 1",
     "updatedAt": "2020-02-06T02:52:29Z",
     "items": [
         {
               "itemName": "ford.com"
         },
         {
               "itemName": "honda.com"
         },
         {
               "itemName": "yamaha.com"
         },
         {
               "itemName": "happymedium.world"
         }
     ],
     "status": "ACTIVE",
  },
  "errors": null,
  "timeStamp": "2020-02-06T02:52:33.317Z"
}

Read

Example Request

GET /traffic/nativelists/4 HTTP/1.1
Host: <HOST_NAME>
Content-Type: application/json
Accept: application/json
X-Auth-Method: OAuth2
X-Auth-Token: <ACCESS_TOKEN>

Example Response

{
  "response": {
     "id": 4,
     "accountId": 1234,
     "name": "HappyMedium Native List 1",
     "updatedAt": "2020-02-06T02:52:29Z",
     "items": [
         {
               "itemName": "ford.com"
         },
         {
               "itemName": "honda.com"
         },
         {
               "itemName": "yamaha.com"
         },
         {
               "itemName": "happymedium.world"
         }
     ],
     "status": "ACTIVE",
  },
  "errors": null,
  "timeStamp": "2020-02-06T02:52:33.317Z"
}

Update

Native List items do not support partial updates. Include the full list of items to be saved. To add new items, read the existing items using a GET request, add new items to the items object, and make a PUT request that includes them all.

Example Request

PUT /traffic/nativelists/4 HTTP/1.1
Host: <HOST_NAME>
Content-Type: application/json
Accept: application/json
X-Auth-Method: OAuth2
X-Auth-Token: <ACCESS_TOKEN>
{
  "accountId": 1234,
  "name": "HappyMedium Native List 1.A",
  "updatedAt": "2020-02-06T02:52:29Z",
  "items": [
         {
               "itemName": "ford.com"
         },
         {
               "itemName": "honda.com"
         },
         {
               "itemName": "happymedium.world"
         },
         {
               "itemName": "hello.world"
         },
         {
               "itemName": "mozilla.com"
         }
     ],
     "status": "ACTIVE",
}

Example Response

{
  "response": {
     "id": 4,
     "accountId": 1234,
     "name": "HappyMedium Native List 1",
     "updatedAt": "2020-02-06T02:59:06Z",
     "geminiNativeListTypeId": 1,
     "items": [
         {
               "itemName": "ford.com"
         },
         {
               "itemName": "honda.com"
         },
         {
               "itemName": "happymedium.world"
         },
         {
               "itemName": "hello.world"
         },
         {
               "itemName": "mozilla.com"
         }
     ],
     "status": "ACTIVE",
  },
  "errors": null,
  "timeStamp": "2020-02-06T02:59:08.410Z"
}