Version 1.0 / January 2016
广告主可通过此API创建机型的黑/白名单.
可用的设备定向API为:
List – 列出当前设备列表,或在特定列表中列出已定义的设备
Create – 用于创建新的设备列表
Append – 增加新的设备至现有列表
Delete – 删除指定的设备列表
Delete Device – 从特定列表中移除指定的设备
验证:
本API需要API密钥,以作为该请求的查询参数. 如需获取用于验证Audience API(受众API) 和Device Model API (设备型号 API) 的Management Key,请查阅广告主账户页面的“Keys”标签。若无法获得 Management Key密钥,请发送邮件至adsupport@applovin.com,我们会为您生成密钥。
https://api.applovin.com/devices/list?api_key=<API_KEY>
错误:
Http状态码,用于显示错误
HTTP Response Code
|
Description
|
200 |
成功 |
400 |
请求格式不完整,该请求缺少必要参数或存在无效参数 |
403 |
验证失败。检查该API密钥是否有效 |
404 |
设备列表ID不存在 |
406 |
创建失败, 已存在相同名称的有效列表 |
500 |
服务不可用 |
创建:
要上传设备列表,首先创建一个空列表.要创建一个新列表,则发出HTTP请求至
https://api.applovin.com/devices/create?api_key=<API_KEY>
Create API (创建API)可采用以下字段作为URL编码查询参数
名称 |
类型 |
描述 |
要求 |
name |
String |
列表名 |
是,必须为字母数字,_-+,或URL编码的空格符 |
description |
String |
列表描述 |
否 |
响应为JSON格式:
名称 |
类型 |
描述 |
device_list_id |
String |
设备列表ID |
请求范例:
curl "https://api.applovin.com/devices/create?name=My%20Devices&api_key=<API_KEY>"
响应范例:
{"device_list_id" : "fce0b41a0849706bd0fbbe181e61f419"}
列表:
如需查看当前所有设备列表,则发出HTTP请求list API
https://api.applovin.com/devices/list?api_key=<API_KEY>
响应为JSON格式:
名称 |
类型 |
描述 |
code |
int |
若为200,则成功 |
device_lists |
List of Objects |
包含某一设备列表信息的对象列 |
device_list_id |
String |
列表ID |
name |
String |
列表名 |
description |
String |
列表描述 |
device_count |
Long |
列表部分的设备数 |
count |
Long |
返回列表数 |
请求范例:
curl "https://api.applovin.com/devices/list?api_key=<API_KEY>"
响应范例:
{
"code": 200,
"device_lists": [
{
"device_list_id": "dab2d1297d35592597b0eee016e92baa",
"name": "List Test",
"description": "Test Custom Device List",
"device_count": 3
}
],
"count": 1
}
列表(附带设备列表ID):
如需获取特定设备列表中所有设备型号的列表,则发出HTTP请求至list API,并附带一个device_list_id参数
https://api.applovin.com/devices/update?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
device_list_id |
String |
从create API或device API中返回的设备列表ID |
是 |
响应为JSON格式:
名称 |
类型 |
描述 |
code |
int |
若为200,则成功 |
devices |
List of Objects |
包含列表中所有设备的对象列表 |
device |
String |
设备名 |
count |
Long |
列表部分的设备数 |
请求范例:
curl "https://api.applovin.com/devices/list?api_key=<API_KEY>&device_list_id=fce0b41a0849706bd0fbbe181e61f419"
相应范例:
{
"code": 200,
"devices": [
{
"device":"SM-G900F"
},
{
"device":"SM-G900FD"
}
],
"count": 2
}
添加:
如需添加设备至现有列表,则发出HTTP POST请求至
https://api.applovin.com/devices/append?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
device_list_id |
String |
create API 或list API 所返回的设备ID |
是 |
Post 主体: 在POST请求中,append API 可接收用行隔开设备型号
名称 |
类型 |
描述 |
要求 |
List of devices |
List of Strings |
分行的设备型号列表 |
是 |
响应为JSON格式:
名称 |
类型 |
描述 |
device_list_id |
String |
设备列表ID |
processed_devices |
Integer |
该请求所含的有效设备数 |
failed_devices |
Integer |
该请求所含的无效设备数 |
请求范例:
curl -X POST --data-binary @devices.txt "https://api.applovin.com/devices/append?device_list_id=<DEVICE_LIST_ID>&api_key=<API_KEY>"
其中devices.txt文件所含内容为
SM-J100H
HUAWEI Y520-U03
响应范例:
{ "device_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_devices" : 2, "failed_devices" : 0 }
删除:
如需删除某设备列表,则发出HTTP请求至
https://api.applovin.com/devices/delete?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
device_list_id |
String |
create API 或list API 返回的设备列表ID |
是 |
Delete API不会返回任何信息。若HTTP相应为成功(HTTP200), 则成功删除。
请求范例:
curl "https://api.applovin.com/devices/delete?device_list_id=<DEVICE_LIST_ID>&api_key=<API_KEY>"
删除设备(从列表移除设备):
如需从现有列表中删除设备,则发出HTTP POST请求至
https://api.applovin.com/devices/deleteDevices?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
device_list_id |
String |
从create API或list API返回的设备列表ID |
是 |
Post 主体: 在POST请求中,Delete API 可接收用行隔开设备型号
名称 |
类型 |
描述 |
要求 |
List of devices |
List of Strings |
分行的设备型号列表 |
是 |
响应为JSON格式:
名称 |
类型 |
描述 |
device_list_id |
String |
设备列表ID |
processed_devices |
Integer |
该请求的列表中已删除的设备数 |
failed_devices |
Integer |
该请求中无效的设备数 |
请求范例:
curl -X POST --data-binary @devices.txt "https://api.applovin.com/devices/deleteDevices?device_list_id=<DEVICE_LIST_ID>&api_key=<API_KEY>"
其中devices.txt文件所含内容为
SM-J100H
HUAWEI Y520-U03
响应范例:
{ "device_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_devices" : 2, "failed_devices" : 0 }
定向至设备列表的广告活动:
设备列表一经创建,并有设备与之相关联,则该列表将作为选项,出现在所有广告活动的Edit Targets页面Custom Devices上
Postman Collection范例: