我们能为您提供什么帮助?

[封闭 beta] 验证规则 API Closed beta

  • 更新

Automate the creation and management of Validation Rules at scale. 技术团队能够通过验证规则 API 以编程方式创建、更新、修补和删除规则,突破 UI 配置值的上限,并免去手动管理规则的额外开销。

 

备注

验证规则 API 仅面向 Protect360 客户开放。该功能目前处于封闭 beta 阶段,访问权限有限,并按账户单独开通启用。如需申请访问权限,请联系您的客户成功经理(CSM)。

关于验证规则 API

到目前为止,验证规则只能通过 AppsFlyer UI 进行管理。这带来了两个限制:

  • 每条规则最多设置约 17,000 个值,对于企业级规模的黑名单来说,这远远不够。
  • 每次更新都需要在 UI 中手动操作。对于需要频繁变更的团队来说,这既耗时,又增加运营成本。

验证规则 API 解决了这两个限制。它让技术团队能够以编程方式全面控制其规则;对于大型规则,每条规则最多支持 300,000 个值;无需操作 UI 即可实现高频自动化更新。

通过 API 创建的规则会被标记为由 API 管理,并在 AppsFlyer UI 中显示为只读状态。现有通过 UI 创建的规则不受影响。 UI 管理和 API 管理的规则可在同一账户中共存。

这个功能适合您吗?

验证规则 API 适用于特定使用场景。它不是要替代所有客户在 UI的操作。如果您符合以下情况,可考虑使用 API:

  • 您管理的屏蔽黑名单或白名单已超过或即将达到 UI 约 17,000 个值的限制。
  • 您的团队希望将规则管理对接到自己的系统、脚本或自动化流程中。
  • 您的作弊或流量屏蔽逻辑经常变化,手动通过 UI 更新已成为瓶颈。

如果您管理的规则数量较少且很少变更,通过 UI 管理这些验证规则仍然是最简单的方式。

访问权限和适用条件

验证规则 API 面向 Protect360 客户开放。该功能目前处于封闭 beta 阶段,可以按账户申请访问权限。

  • 需要订阅 Protect360。
  • 功能由开关控制。如需申请访问权限并启用此功能,请联系您的客户成功经理(CSM)。
  • 大型规则(最多 300,000 个值)除标准 API 访问权限外,还需要额外的特殊授权才能启用。如需启用这些功能,请联系您的 CSM。

使用方法

身份验证

该 API 使用 Bearer token(JWT)进行身份验证。

  1. 在您的 AppsFlyer 账户中,前往 Security Center > API tokens。
  2. 生成 token。
  3. 在 API 请求的 Authorization 标头中包含该 token。

备注

账户需要先启用 API 访问权限,token 才能生效。如需启用此功能,请联系您的 CSM。

您可以执行的操作
操作 描述
列出规则 检索您账户下所有活跃规则(包括已启用和已禁用)。
创建规则 以编程方式创建新规则。
获取规则 获取规则的完整详细信息,包括所有条件。
更新规则 用新配置覆盖现有规则。
启用/禁用规则 在不删除规则的情况下将其开启或关闭。
删除规则 永久移除规则。
修补规则 无需重写整个规则,即可为单个维度添加、删除或替换值。

对于高频更新,patch 端点尤其有用。您只更新发生变化的部分,而不是整个规则。这非常适合每日更新作弊流量黑名单等工作流。

范围和支持的配置

验证规则 API 当前仅支持 UI 规则生成器中部分已经提供的功能。

  • 仅适用于激活安装事件,此版本不支持应用内事件。
  • 支持的维度:
    • 流量来源(Population):Site ID、媒体渠道、代理、广告系列、广告系列 ID、广告组 ID 和广告 ID
    • 条件:地理位置、平台
  • 支持的运算符:在列表中、不在列表中。
  • 维度之间的逻辑:仅支持 AND,不支持 OR。
  • 规则类型:匹配(屏蔽匹配的流量)或不匹配(屏蔽不匹配的流量)。
  • 来源类型:所有流量、所有非自然流量或来自特定代理的非自然流量。
  • 支持的屏蔽操作:
    • 屏蔽归因,并将归因更正为最后一个有效媒体渠道。
    • 屏蔽归因,并将安装标记为无效。这些安装不会显示在 Protect360 数据面板中。
规则大小和限制
标准规则 大型规则
所有条件下的值总数 上限17,000 上限 300,000
是否需要特殊启用 是 是
每个账户的最大规则数 100 最多 5 个

其他限制:

  • 每条规则最多包含 2,000 个应用 ID。
  • 每次 API 调用的最大上限是2MB。超过此限制的请求(约 50,000 个值)必须拆分为多次调用。
  • 每条大型规则最多 300,000 个值,所有维度合并计算,与操作类型(创建、更新或部分修改)无关。

超出任一限制API都会返回错误,并会指出具体超出的是哪项限制。

如何查看屏蔽流量数据

由 API 管理的规则屏蔽的流量与由 UI 创建的规则屏蔽的流量采用相同的数据报告方式。

报告 地理位置
原始数据导出 Protect360 & 验证规则 > 安装
Data Locker Protect360 报告 > blocked_installs 报告
Pull API 原始数据导出
技术文档

如需查看完整的技术细节,包括端点说明、请求和响应架构以及错误代码,请参阅验证规则 API 技术文档。

特性与限制
特性 描述
事件支持 仅支持安装事件,此版本不支持应用内事件。
逻辑 维度之间仅支持 AND 逻辑,不支持 OR。
UI 交互 通过 API 创建的规则在 UI 中显示为只读,请使用 API 编辑这些规则。
调用大小 每次 API 调用最大上限 2MB(约 50,000 个值)。超过此限制的更新必须拆分为多次调用。

FAQ

谁可以使用验证规则 API?

验证规则 API 面向 Protect360 客户开放。该功能目前处于封闭 beta 阶段,访问权限按账号进行申请启用。请联系您的 CSM 以获取访问权限。

由 API 管理的规则会显示在 UI 中吗?

可以。由 API 管理的规则和由UI 中创建的规则可以在同一账户中共存。

我可以通过 API 管理部分规则,并通过 UI 管理其他规则吗?

可以。由 API 管理的规则和由UI 中创建的规则可以在同一账户中共存。由 API 管理的规则在 UI 中显示为只读。在 UI 中创建的规则无法通过 API 访问。

我可以在 UI 中编辑由 API 管理的规则吗?

不可以,该规则显示为只读。您必须改为使用 API 更新该规则。

Update 和 Patch 有什么区别?

Update 会覆盖整个规则。 Patch 仅更新单个维度,可添加、删除或替换其中的值,而无需重写整个规则。对于频繁且有针对性的更新,请使用 Patch。

如果超出限制,会发生什么?

API 会返回错误,并指出具体超出了哪项限制。为确保每次调用不超过 2MB 的限制,请将大型更新拆分为多次 API 调用。

我可以创建多少条规则?

每个账户最多可创建 100 条标准规则和 5 条大型规则。标准规则和大型规则都需要特殊申请启用。如需启用,请联系您的 CSM。

是否支持 OR 逻辑?

不支持。维度之间仅支持 AND 逻辑。

支持哪些事件类型?

仅支持安装事件,此版本不支持应用内事件。