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 |
---|---|---|---|---|
|
The name of the native list. |
String |
Mutable |
Y |
|
The account’s identifier. |
Long |
Immutable |
Y |
|
The status of the native list. When INACTIVE or ARCHIVED, it’s not available for line targeting. |
String |
Mutable |
Y |
|
An array of items. An item can be an app or website. Limit of 500 items. |
Array <item> |
Mutable |
Y |
|
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>
Example Request Body¶
{
"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>
Example Request Body¶
{
"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"
}
Search¶
Use an optional query string to search for the native lists that are available under an account. Before you create a line targeting POST request that includes Native Lists, use this method with the accountId of the line to fetch the relevant native list IDs.
Example Request¶
GET /traffic/nativelists?accountId=1234&query=happy 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.A",
"updatedAt": "2020-02-04T17:20:12Z",
"status": "ACTIVE"
},
{
"id": 5,
"accountId": 1234,
"name": "HappyMedium Native List 2",
"updatedAt": "2020-02-05T18:41:57Z",
"status": "ACTIVE"
}
],
"errors": null,
"timeStamp": "2020-02-13T01:13:23.802Z"
}