本指南简要介绍了使用 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 的可用性。
后续步骤
以下部分详细介绍了如何开始使用归因报告。