抑制 API
<p class=“text-gray-400”>Version 1.1 / August 2024</p>
广告主可以使用抑制 API 来防止现有应用用户被该应用的 Campaign 再次定向。该 API 支持对用户开启或关闭抑制。在使用时,可以通过 iOS 的 IDFA 或 Android 的 GAID 来识别用户。
请求格式
目标 URL
想要使用此 API,请通过向下面其中一个基础 URL 发送 HTTP 请求来实现:
https://api.applovin.com/suppressionApps
(添加用户至应用的抑制名单)https://api.applovin.com/deleteSuppressionApps
(从应用的抑制名单中移除用户)
身份验证
此 API 要求您在请求中包含 API Key 作为查询参数 (api_key
):
https://api.applovin.com/suppressionApps?api_key=«management-key»https://api.applovin.com/deleteSuppressionApps?api_key=«management-key»
您可以在账户页面的 Keys 选项卡中找到此 Management Key。 如果 Management Key 不可见,请提交工单 这里 并请求生成一个 Management Key。
添加用户
要将用户列表添加到抑制名单,请发送 HTTP POST
请求至:
https://api.applovin.com/suppressionApps?api_key=«management-key»&package_name=«package-name»
删除用户
要从抑制名单中移除用户,请发送 HTTP POST
请求至:
https://api.applovin.com/deleteSuppressionApps?api_key=«management-key»&package_name=«package-name»
查询参数
名称 | 类型 | 描述 | 必要 |
---|---|---|---|
package_name | String | 应用的 Bundle ID (iOS) 或包名 (Android) | 是 |
请求正文 (Post Body)
该 API 在 POST
请求中接受以换行符分隔的 ID 列表:
类型 | 描述 | 必要 |
---|---|---|
List of Strings | 一个由 Apple 的 IDFA 或 Android 的 GAID 组成的换行分隔列表;这些 ID 必须为 UUID 格式。 | 是 |
响应格式
响应为 JSON 格式:
名称 | 类型 | 描述 |
---|---|---|
num_valid_ids | Integer | 该请求中成功处理的 ID 数量 |
num_invalid_ids | Integer | 该请求中无效广告 ID 的数量 |
错误
该 API 通过返回 HTTP 状态代码来指明错误:
HTTP 响应代码 | 描述 |
---|---|
200 | 成功。 |
400 | 请求格式不正确;缺失数据或包含无效数据。 |
403 | 身份验证失败。检查 API Key 的有效性。 |
500 | 服务不可用。 |
请求示例
添加用户请求示例:
curl -X POST --data-binary @userIds.txt "https://api.applovin.com/suppressionApps?api_key=«management-key»&package_name=com.machinezone.gow"
删除用户请求示例:
curl -X POST --data-binary @userIds.txt "https://api.applovin.com/deleteSuppressionApps?api_key=«management-key»&package_name=com.machinezone.gow"
其中文件 userIds.txt
的内容为:
c77bbe4e-6a28-11e4-bcda-14109fdf9591f601faf5-4a83-44d6-98ef-b67c24919d39
响应示例
{ "num_valid_ids": 2, "num_invalid_ids": 0}