Attribution Reporting API:集成指南

Attribution Reporting API 旨在通过消除对跨方用户标识符的依赖来更好地保护用户隐私,并支持跨应用进行归因和转化衡量的关键用例。本文档中的准则旨在帮助您为 Attribution Reporting API 集成做好准备。

本指南提供了全面信息,其中可能包括 Privacy Sandbox on Android 开发者预览版当前阶段尚未实现的功能。对于这种情况,相关详细信息将被标记为尚未实现。

集成目标

在 Privacy Sandbox 开发者预览版的当前阶段,集成计划的目标包括:

现有支持和即将提供的支持

最新开发者预览版中当前支持的用例和功能包括:

  • 来源优先的最后接触归因和安装后归因
  • 注册应用归因来源和应用触发器。
  • 接受事件级报告。
  • 接受未经加密的可汇总报告。

即将推出的开发者预览版计划增加对以下更多用例和技术功能的支持。随着这些功能的推出,我们会更新本指南以反映相关详细信息。

  • 广告技术平台注册
  • 调试支持,可帮助开发者比较汇总报告与采用现有机制的报告。
  • 注册网站归因来源和网站触发器,以支持应用到网站归因。
  • 从 API 接受经过加密的可汇总报告,并将批量数据发送到汇总服务。
  • 从汇总服务接受摘要报告。
  • 使用 API 需要新的一般权限。

广告技术平台目标受众群体

若要从 Attribution Reporting API 接受报告,广告技术平台必须同时注册归因来源和触发器。为了支持完整端到端测试,广告投放技术合作伙伴和移动衡量合作伙伴必须携手合作,为同一广告客户调用 API,并且可能需要在注册调用中利用重定向。您可能还需要使用发布商或广告客户应用。

对于归因来源注册,API 调用通常由用于在发布商应用中投放广告的广告技术 SDK 发起,不过应用也可以直接调用该 API。

对于触发器注册,API 调用通常由广告客户衡量应用中的移动衡量合作伙伴的 SDK 发起,或由广告客户应用本身发起。

前提条件

集成步骤

为了准备将 Attribution Reporting API 集成到您的解决方案中,请完成以下几个部分中的步骤。

在测试环境中验证技术正确性

  • 创建测试应用以熟悉 Privacy Sandbox on Android Attribution Reporting API。在此阶段,您也可以从 GitHub 上的示例应用着手。
  • 设置模拟服务器端点使用我们的示例服务器,熟悉归因报告客户端 API 使用的 REST API 签名。
  • 注册事件,包括查看、点击和转化(触发器)事件。
  • 为便于测试,请使用适当的 adb 命令强制运行报告作业,以缩短对于事件级报告和汇总报告接收报告数据的时间跨度。
  • 评估 API 签名对当前技术栈的适用性。这包括输入参数和返回值。识别数据流和缓解措施之间的任何缺口。

验证与现有技术基础架构的兼容性

  • 客户端开发环境和代码库:
    • 开发者预览版之后,Privacy Sandbox on Android 要求的最低目标 API 级别为 33。确定现有代码库的迁移路径。评估您的应用或 SDK 与 Android 13 中引入的其他变更的兼容性。
  • 服务器端:
    • 将 API 桩端点添加到现有技术基础架构,以查找并验证任何技术限制。
    • 添加回调以接受对现有技术基础架构的报告。

定义并验证集成要求

  • 在日志或服务器数据中验证报告是否包含观看、点击和转化数据。
  • 验证事件级报告和汇总级报告。