生成归因报告

当触发器和来源匹配时，浏览器会生成报告，并通过无凭证的 POST 请求将报告发送到报告来源的特定端点：

• 对于事件级报告，端点为 <reporting-origin>/.well-known/attribution-reporting/report-event-attribution。
• 对于汇总报告，端点为 <reporting-origin>/.well-known/attribution-reporting/report-aggregate-attribution。

<reporting-origin> 与注册的来源（source）和触发器同源（same-origin）。

报告数据包含在一个 JSON 结构中。

事件级报告会在其包含的报告窗口结束时生成并计划发送。报告窗口的长度由来源的 Attribution-Reporting-Register-Source 标头中的 "event_report_window" 或 "event_report_windows" 字段决定。

如果未指定这些字段，报告窗口将回退到以下默认值：

• 对于基于事件的来源，默认报告窗口在来源的 "expiry" 到期时结束，该值在 Attribution-Reporting-Register-Source 的 "expiry" 字段中设置。如果未显式设置，则默认为注册后 30 天。
• 对于基于导航的来源，默认报告窗口分别为 2 天、7 天和来源的 "expiry"。

有关详细信息，请参阅自定义报告窗口。

一旦事件级报告到达相应的端点，数据如何处理、存储和显示完全取决于开发者。一个典型的事件级报告可能如下所示：

{
  "attribution_destination": "https://advertiser.example",
  "source_event_id": "412444888111012",
  "trigger_data": "4",
  "report_id": "123e4567-e89b-12d3-a456-426614174000",
  "source_type": "navigation",
  "randomized_trigger_rate": 0.34,
  "scheduled_report_time": "1692255696",
  "source_debug_key": 647775351539539,
  "trigger_debug_key": 647776891539539
}

属性如下：

"attribution_destination"

一个字符串，或者是一个包含 2-3 个字符串的数组，取决于来源是否注册了多个目标。这些字符串代表在来源注册时通过关联的 Attribution-Reporting-Register-Source 响应标头中设置的归因 "destination" 站点。

"source_event_id"

一个表示归因来源 ID 的字符串。这等同于在来源注册时通过关联的 Attribution-Reporting-Register-Source 响应标头中设置的 "source_event_id"。

"trigger_data"

一个表示归因触发器来源数据的字符串，在触发器注册时设置（通过关联的 Attribution-Reporting-Register-Trigger 响应标头设置的 "trigger_data"）。

"report_id"

一个表示此报告的通用唯一标识符（UUID）的字符串，可用于防止重复计算。

"source_type"

一个字符串，值为 "navigation" 或 "event"，分别表示相关的归因来源是基于导航的，还是基于事件的。

"randomized_trigger_rate"

一个介于 0 和 1 之间的随机数，表示此特定来源配置应用噪声的频率。

"scheduled_report_time"

一个字符串，表示从 Unix 纪元开始到浏览器最初计划发送报告的秒数（以避免因设备离线导致报告延迟而产生的不准确性）。

"source_debug_key" 可选

一个 64 位无符号整数，表示归因来源的调试密钥。此值与关联的 Attribution-Reporting-Register-Source 标头中的 "debug_key" 字段中设置的值相同。有关更多信息，请参阅调试报告。

"trigger_debug_key" 可选

一个 64 位无符号整数，表示归因触发器的调试密钥。此值与关联的 Attribution-Reporting-Register-Trigger 标头中的 "debug_key" 字段中设置的值相同。有关更多信息，请参阅调试报告。

汇总报告是从收到的多个可汇总报告创建的，并随后批处理以准备由汇总服务处理。此后，数据如何处理、存储和显示完全取决于开发者。

默认情况下，可汇总报告是在触发器交互后生成并计划发送的，带有随机延迟以帮助模糊时序并提高隐私性。对于给定的已注册归因来源，从注册到来源过期期间会记录归因来源事件——这称为报告窗口。

到期时间由关联的 Attribution-Reporting-Register-Source 标头中的 expiry 值定义，如果未明确设置，则默认为注册后 30 天。请注意，可以通过在 Attribution-Reporting-Register-Source 标头中设置 aggregatable_report_window 值来进一步修改报告窗口的长度。有关详细信息，请参阅自定义报告窗口。

典型的可汇总报告可能如下所示：

{
  "shared_info": "{\"api\":\"attribution-reporting\",\"attribution_destination\":\"https://advertiser.example\",\"report_id\":\"123e4567-e89b-12d3-a456-426614174000\",\"reporting_origin\":\"https://reporter.example\",\"scheduled_report_time\":\"1692255696\",\"source_registration_time\":\"1692230400\",\"version\":\"3\"}",
  "aggregation_service_payloads": [
    {
      "payload": "[base64 编码的 HPKE 加密数据，仅供汇总服务读取]",
      "key_id": "[标识用于加密有效负载的公钥的字符串]",
      "debug_cleartext_payload": "[base64 编码的未加密有效负载]"
    }
  ],
  "aggregation_coordinator_origin": "https://publickeyservice.aws.privacysandboxservices.com",
  "source_debug_key": 647775351539539,
  "trigger_debug_key": 647776891539539
}

属性如下：

"shared_info"

这是一个序列化的 JSON 对象，提供汇总服务使用的信息。这些数据使用 AEAD 进行加密，以防篡改。序列化字符串中包含以下属性：

"api"

表示触发报告生成的 API 的枚举值。目前，这个值将始终等于 "attribution-reporting"，但将来可能会扩展以支持其他 API。

"attribution_destination"

一个表示归因 "destination" URL 的字符串，该 URL 在来源注册时通过相关的 Attribution-Reporting-Register-Source 响应标头设置。

"report_id"

一个表示此报告的全局唯一标识符（UUID）的字符串，可用于防止重复计数。

"reporting_origin"

触发报告生成的来源。

"scheduled_report_time"

一个字符串，表示从 Unix 纪元到浏览器最初计划发送报告的时间，以秒为单位（避免由于设备离线导致的报告延迟）。

"source_registration_time"

一个字符串，表示从 Unix 纪元到归因来源注册的时间，四舍五入到整天。

"version"

一个表示生成报告的 API 版本的字符串。

"aggregation_service_payloads"

一个对象数组，表示汇总服务用来组装报告中数据的直方图贡献的有效负载对象。目前，每个报告只支持一个由浏览器配置的有效负载。将来可能会支持多个可定制的有效负载。每个有效负载对象包含以下属性：

"payload"

一个通过 HPKE 加密并经过 base64 编码的 CBOR 映射，结构如下：

js

{
  "operation": "histogram",  // 允许服务支持将来其他操作
  "data": [{
    "bucket": <分桶，编码为 16 字节（即 128 位）的大端字节串>,
    "value": <桶值，编码为 4 字节（即 32 位）的大端字节串>
  }, ...]
}

"key_id"

一个字符串，标识用于加密有效负载的公钥。

"debug_cleartext_payload" 可选

可选的调试信息。

"aggregation_coordinator_origin"

汇总服务的部署选项。

"source_debug_key" 可选

一个 64 位无符号整数，表示归因来源的调试密钥。此值与相关 Attribution-Reporting-Register-Source 标头的 "debug_key" 字段中的值一致。更多信息请参见调试报告。

"trigger_debug_key" 可选

一个 64 位无符号整数，表示归因触发器的调试密钥。此值与相关 Attribution-Reporting-Register-Trigger 标头的 "debug_key" 字段中的值一致。更多信息请参见调试报告。

噪声被添加到报告中，以模糊与特定来源相关的输出，从而保护用户隐私。确切的来源数据无法被识别并归因到用户个体，但从数据中提取的总体模式仍然可以提供相同的意义。

关于归因报告中噪声的工作原理，请参见：

• 理解汇总报告中的噪声
• 数据限制和噪声
• 处理噪声

默认情况下，所有归因来源的优先级相同，并且归因模型是最后接触（last-touch）模型，这意味着转化被归因到最新的匹配来源事件。对于事件级和可汇总的报告，你可以通过在相关 Attribution-Reporting-Register-Source 标头中设置 "priority" 字段的新值来更改来源优先级。默认值为 0；如果你将特定来源的 "priority" 值设置为 1，则该来源将首先匹配，优先于任何优先级为 0 的来源。优先级为 2 的来源将在优先级为 1 的来源之前匹配，依此类推。

归因触发器优先级的工作方式相同；你也可以通过在相关 Attribution-Reporting-Register-Trigger 标头中添加 "priority" 字段来设置触发器优先级，但仅适用于事件级报告。

不同的来源类型有不同的默认限制：

• 基于导航的归因来源默认限制为三个报告。例如，如果用户点击了一个广告并进行了四次转化：他们访问了广告商网站主页，然后访问了产品页面，注册了时事通讯，最后进行了购买。由于这是第四次转化，购买报告将被丢弃。
• 基于事件的归因来源默认限制为一个报告。

当为给定的来源事件触发归因时，如果该来源已达到最大归因次数（点击为 3 次，图像/脚本为 1 次），浏览器将：

• 将新报告的优先级与同一来源的现有计划报告的优先级进行比较。
• 删除优先级最低的报告以安排新的报告。如果新报告的优先级最低，则忽略新报告，不会收到它。

如果未设置优先级，浏览器将回退到其默认行为：在点击后的第三次转化或查看后的第一次转化后发生的任何转化都将被丢弃。

你可以使用过滤器定义哪些转化会生成报告。例如，你可以选择只计算特定产品类别的转化，并过滤掉其他类别的转化。

要声明过滤器：

1. 在来源注册时，将 filter_data 字段添加到 Attribution-Reporting-Register-Source 标头中，该字段定义了你将在触发端用于过滤转化的过滤键。这些是完全自定义的字段。例如，要指定仅特定子域名和特定产品的转化：

   json

   "filter_data": {
     "conversion_subdomain": ["electronics.megastore", "electronics2.megastore"],
     "product": ["1234"]
   }
   

2. 在触发注册时，将 filters 字段添加到 Attribution-Reporting-Register-Trigger 标头中。例如，以下内容会使触发交互匹配上述来源注册，因为它们都包含 "electronics.megastore" 的 "conversion_subdomain" 字段。而 "directory" 过滤器则在尝试匹配时被忽略，因为它未包含在上述来源注册中。

   json

   "filters": {
     "conversion_subdomain": ["electronics.megastore"],
     "directory": ["/store/electronics"]
   }
   

如果 "filter_data" 和 "filters" 字段包含匹配的子字段（如上例中的 "conversion_subdomain"），但这些子字段的值没有匹配项，则会忽略触发器，导致没有匹配。

可以扩展 Attribution-Reporting-Register-Trigger 标头中的 event_trigger_data 字段，以根据在 Attribution-Reporting-Register-Source 标头中定义的 filter_data 选择性地设置 trigger_data、priority 或 deduplication_key。

例如：

{
  "event_trigger_data": [
    {
      "trigger_data": "2",
      "filters": { "source_type": ["navigation"] }
    },
    {
      "trigger_data": "1",
      "filters": { "source_type": ["event"] }
    }
  ]
}

在此上下文中，filters 可以是对象或对象数组。当指定列表时，只需一个字典匹配即可将触发器视为匹配。

{
  "event_trigger_data": [
    {
      "trigger_data": "2",
      "filters": [
        {
          "product": ["1234"],
          "conversion_subdomain": ["electronics.megastore"]
        },
        {
          "product": ["4321"],
          "conversion_subdomain": ["electronics4.megastore"]
        }
      ]
    }
  ]
}

如果事件触发器的过滤器都不匹配，则不会创建事件级报告。如果过滤器匹配多个事件触发器，则使用第一个匹配的事件触发器。

你可以启用调试报告，以返回有关归因报告的故障排除信息。这些报告可用于检查你的设置是否正常工作，并了解基于 cookie 的旧实现和新归因报告实现之间的测量结果差距。调试报告会立即发送；它们不受事件级和汇总报告相同的调度约束。

有两种不同类型的调试报告：

• 成功调试报告跟踪特定归因报告的成功生成。成功调试报告在注册相应触发器后立即生成并发送。
• 详细调试报告为与归因报告关联的归因来源和归因触发事件提供更多可见性。它们使你能够确保来源已成功注册，或跟踪丢失的报告并确定其原因（例如，由于来源或触发事件注册失败或发送或生成报告时失败）。详细调试报告在来源或触发器注册时立即发送。

要使用调试报告，你需要：

1. 在报告来源上设置 ar_debug cookie。在来源和触发注册期间，该 cookie 需要存在：

   http

   Set-Cookie: ar_debug=1; SameSite=None; Secure; Path=/; HttpOnly
   

2. 在与你希望为其公开调试信息的归因报告相关的所有 Attribution-Reporting-Register-Source 和 Attribution-Reporting-Register-Trigger 响应标头中设置 debug_key 字段。每个 debug_key 值必须是格式为十进制字符串的 64 位无符号整数。使每个调试键成为唯一的 ID——例如，可以将每个键设置为 cookie ID + 来源/触发时间戳（如果希望将其与旧的基于 cookie 的系统进行比较，则可以在旧系统中捕获相同的时间戳）。

   json

   {
     "debug_key": "647775351539539"
   }
   

   备注：使来源端的调试键与 source_event_id 不同，以便区分具有相同来源事件 ID 的单个报告。

3. 可选地，在 Attribution-Reporting-Register-Source 和 Attribution-Reporting-Register-Trigger 标头中将 debug_reporting 字段设置为 true。如果执行此操作，将生成详细的调试报告。如果不执行此操作，将生成反映你正在生成的归因报告类型（事件级或汇总）的成功调试报告。

   json

   {
     "debug_key": "647775351539539",
     "debug_reporting": true
   }
   

4. 设置适当的端点以接收你希望生成的调试报告。调试报告发送到报告来源中的三个单独端点：

   • 事件级成功调试报告的端点：<reporting-origin>/.well-known/attribution-reporting/debug/report-event-attribution
   • 汇总成功调试报告的端点：<reporting-origin>/.well-known/attribution-reporting/debug/report-aggregate-attribution
   • 详细调试报告的端点：<reporting-origin>/.well-known/attribution-reporting/debug/verbose

生成的成功调试报告与归因报告相同，并包含来源端和触发器端的调试键（分别位于 "source_debug_key" 和 "trigger_debug_key" 字段中）。

有关更多信息和示例，请参见：

• developers.google.com 上的调试报告介绍（2023）
• developers.google.com 上的设置调试报告（2023）
• developers.google.com 上的调试宝典（2023）