版本1.0/ 2017年3月
广告主可通过此工具创建APP黑/白名单. 旧的whitelist/blacklist API(白/黑名单API)会被弃用,并以此API为代替
相关的API如下
List – 显示已创建的App列表
Create – 创建一个新的列表
Append – 增加新的App至现有列表内
Delete – 删除指定App列表
Delete Apps – 从特定列表中移除指定App
验证:
该API需要API密钥,以作为请求的查询参数. 如需获取Management Key,可查阅广告主账户页面的“Keys”标签. 若该密钥为空,请发送邮件至adsupport@applovin.com,即可生成密钥.
https://api.applovin.com/applists/list?api_key=<API_KEY>
错误:
HTTP状态码,可显示Error
HTTP 响应编码
|
描述
|
200 |
成功 |
400 |
请求格式不完整,数据丢失或失效 |
403 |
验证失败. 检查API密钥是否有效 |
404 |
App列表ID不存在 |
406 |
创建时已存在相同名称的有效列表 |
500 |
服务不可用 |
创建:
要提交App列表,首先创建一个空列表. 要创建一个新列表,则发出HTTP请求至
https://api.applovin.com/
applists
/create?api_key=<API_KEY>
Create API 可采用以下字段作为URL编码查询参数
名称 |
类型 |
描述 |
要求 |
name |
String |
列表名 |
是。必须为字母数字,_-+,或URL编码的空格符 |
description |
String |
列表描述 |
否 |
响应为JSON格式
名称 |
类型 |
描述 |
app_list_id |
String |
受众ID |
请求范例:
curl "https://api.applovin.com/
applists
/create?name=High%20Perfoming%20Apps&api_key=<API_KEY>"
响应范例:
{"app_list_id" : "fce0b41a0849706bd0fbbe181e61f419"}
列表:
如需获取当前所有App列表,则发出HTTP请求至List API
https://api.applovin.com/applists/list?api_key=<API_KEY>
响应为JSON格式:
名称 |
类型 |
描述 |
code |
int |
若为200,则成功 |
app_lists |
List |
包含某一App列表信息的对象列 |
app_list_id |
String |
列表ID |
name |
String |
列表名 |
description |
String |
列表描述 |
app_count |
Long |
列表部分的App数 |
count |
Long |
返回列表数 |
请求范例:
curl "https://api.applovin.com/applists/list?api_key=<API_KEY>"
响应范例:
{
"code": 200,
"app_lists": [
{
"app_list_id": "dab2d1297d35592597b0eee016e92baa",
"name": "High Performing Apps",
"description": "Apps that exceed our ROAS goals",
"app_count": 3
}
],
"count": 1
}
列表(附带已定义App列表ID)
如需获取特定App列表中的所有App列,则发出HTTP请求至List API,并附带一个app_list_id参数
https://api.applovin.com/applists/list?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
app_list_id |
String |
从Create API或List API中返回的App列表ID |
是 |
响应为JSON格式
名称 |
类型 |
描述 |
code |
int |
若为200,则成功 |
apps |
List |
包含列表中所有App的对象列 |
application |
String |
外部应用ID |
count |
Long |
列表部分的App数 |
请求范例:
curl "https://api.applovin.com/applists/list?api_key=<API_KEY>&app_list_id=fce0b41a0849706bd0fbbe181e61f419"
相应范例:
{ "code": 200, "apps": [ { "application":"
a0849706bd
a0849706bd
"
},
{
"application":"4326af2346b2l46e2346"
}
],
"count": 2 }
附加:
如需增加App至现有列表,则发出HTTP POST 请求至
https://api.applovin.com/applists/append?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
app_list_id |
String |
从Create API或List API中返回的App列表ID |
是 |
Post主体: 在POST请求中,Append API可接收用行隔开的External APP ID列表。
名称 |
类型 |
描述 |
要求 |
List of apps |
List of Strings |
分行的external app ID列表 |
是 |
该响应为JSON格式
名称 |
类型 |
描述 |
app_list_id |
String |
App列表ID |
processed_apps |
Integer |
请求中有效的App数 |
failed_apps |
Integer |
请求中无效的App数 |
请求范例:
curl -X POST --data-binary @apps.txt "https://api.applovin.com/applists/append?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"
其中apps.txt文件所含内容为
a0849706bd
a0849706bd
4326af2346b2l46e2346
响应范例
{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }
删除:
如需删除某一App列表,则发出HTTP请求至
https://api.applovin.com/applists/delete?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
app_list_id |
String |
从Create API或List API中返回的App列表ID |
是 |
Delete API不会返回任何信息. 若HTTP响应为success,则返回编码200
请求范例:
curl "https://api.applovin.com/applists/delete?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"
删除App(从某一列表中移除App):
如需从现有的某列表删除App,则发出HTTP POST请求至
https://api.applovin.com/applists/deleteApps?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
查询参数:
名称 |
类型 |
描述 |
要求 |
app_list_id |
String |
从Create API或List API中返回的App列表ID |
是 |
POST主体: 在POST请求中,Delete API可接收用行隔开的External APP ID列表。
名称 |
类型 |
描述 |
要求 |
List of apps |
List of Strings |
分行的external app ID列表 |
是 |
响应为JSON格式
名称 |
类型 |
描述 |
app_list_id |
String |
App列ID |
processed_apps |
Integer |
该请求中从列表删除的App数 |
failed_apps |
Integer |
该请求中的无效App数 |
请求范例:
curl -X POST --data-binary @apps.txt "https://api.applovin.com/applists/deleteApps?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"
其中apps.txt文件所含内容为
a0849706bd
a0849706bd
4326af2346b2l46e2346
响应范例:
{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }
目标活动App列表:
App列表一经创建并与App关联,该列表即作为选项出现在所有广告活动的Edit Targets页面中的Application区。