本指南概述了如何使用 Attribution Reporting API 生成事件级归因报告和摘要归因报告,并提供了相关设置说明。
首先,您将学习如何:
区分 Attribution Reporting API 报告类型
完成 API 实现和报告生成步骤
查找参考信息和问题排查信息
选择报告类型
为了以不同的详细程度和隐私保护级别有效衡量广告系列效果,Attribution Reporting API 提供了两种不同的报告类型:
事件级报告:提供精细的数据,将特定广告点击或观看(即来源)与相应的转化数据(即触发)相关联。事件级报告会限制转化数据的数量,并向报告添加噪声。它们非常适合需要进行单个事件归因的用例,例如衡量广告系列覆盖面。
摘要报告:提供汇总的用户数据,并且可以包含添加了噪声的更详细的转化信息。可汇总报告同时使用 Attribution Reporting API 和 Private Aggregation API,由汇总报告构建而成,提供比事件级报告更丰富的数据模型。对于需要汇总数据分析的场景,例如计算转化价值或分析不同用户细分群组的广告系列效果,摘要报告特别有用。
实施概览
以下各部分简要介绍了生成每种报告的步骤。您还可以观看 Attribution Reporting API 演示,了解整个流程的分步演示。
前提条件:您的网站必须具有 SSL/TLS 证书 (HTTPS),然后才能注册来源和触发器并接收报告。
生成事件级报告
以下步骤介绍了如何生成事件级报告:
注册来源:将广告点击或观看与归因信息相关联。如需查看详细说明,请参阅注册归因来源和归因来源注册。请注意,点击和观看的注册流程略有不同。
注册触发器:记录转化事件并将其与之前注册的来源相关联。如需查看相关说明,请参阅注册归因触发器。
设置报告端点:在服务器上创建一个端点以接收事件级报告。端点网址应采用以下格式:
{REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-event-attribution。如需查看POST方法的示例,请参阅adtech.js中的示例代码。如需详细了解.well-known,请参阅 Wikipedia。
如需深入了解事件级报告,请参阅事件级报告说明。
生成摘要报告
注册触发器:与事件级报告相同。请参阅注册归因触发器。
设置报告端点:创建用于接收汇总报告的端点。网址应为:
{REPORTING_ENDPOINT}/.well-known/attribution-reporting/report-aggregate-attribution。如需查看POST方法示例,请参阅adtech.js;如需了解.well-known信息,请参阅 Wikipedia。
如需深入了解汇总报告,请参阅可汇总报告说明。
除了实施步骤之外,以下主题还将帮助您规划汇总报告策略:
设置过滤条件(可选)
如需更精细地控制您收到的归因数据,您可以设置过滤条件。
过滤功能可提供精细的数据分析,让您能够隔离特定数据子集以进行分析,从而减少干扰。它还有助于跟踪特定广告系列和转化事件的效果,以便进行更精确的衡量。
如需设置过滤条件,请参阅使用过滤条件定义自定义规则以及归因触发注册的触发器部分,了解有关可汇总报告的详细信息。
确认 API 已启用
使用该 API 之前,请使用以下代码检查它是否已启用:
if (document.featurePolicy.allowsFeature('attribution-reporting')) {
// the Attribution Reporting API is enabled
}
此检查用于指示在当前上下文中是否允许使用相应 API。不过,用户浏览器设置或其他因素可能仍然会阻止使用该 API。出于隐私方面的考虑,目前没有以编程方式明确确认 API 可用性的方法。
后续步骤
以下部分详细介绍了如何开始使用归因报告。