Attribution-Reporting-Register-Trigger
Attribution-Reporting-Register-Trigger
标头将页面功能注册为 归因触发器。这是包含在对包含 Attribution-Reporting-Eligible
标头的请求的响应的一部分。
有关更多详细信息,请参阅 归因报告 API。
注意:如果调用站点未在成功的 隐私沙盒注册流程 中包含归因报告 API,则会忽略 Attribution-Reporting-Register-Trigger
标头,并且不会注册归因触发器。
标头类型 | 响应标头 |
---|---|
禁止的标头名称 | 否 |
CORS 安全列表响应标头 | 否 |
语法
Attribution-Reporting-Register-Trigger: <json-string>
指令
<json-string>
-
提供可包含在生成的报告中的数据的 JSON 字符串,例如触发器的 ID 以及优先级和重复数据删除值。可用的字段如下所示
"aggregatable_trigger_data"
-
对象数组,每个对象定义一个应用于不同源键的聚合键。每个对象包含以下属性
"key_piece"
-
表示键的十六进制值。
"source_keys"
-
包含一个或多个数据键值的数组。
"aggregatable_values"
-
包含属性的对象,表示在
"aggregatable_trigger_data"
中定义的每个数据点的值。在每种情况下,属性名称都等于在"source_keys"
中定义的名称,属性值是您需要的任何任意值。 "debug_key"
可选-
表示调试键的数字。如果您希望与关联的归因报告一起生成 调试报告,请设置此值。
"debug_reporting"
可选-
布尔值。如果设置了
debug_key
,则将其设置为true
以指定生成的调试报告应为详细的调试报告。 "filters"
可选-
包含自定义数据的对象,可用于筛选哪些触发器生成报告。有关更多详细信息,请参阅 筛选器。
"event_trigger_data"
-
表示触发器相关数据的对象。可用的子字段如下所示
"trigger_data"
-
表示描述触发器的数据的字符串,通常用于指示诸如“用户将商品添加到购物车”或“用户注册邮件列表”之类的事件。此值将包含在生成的事件级报告(如果有)中,尽管它会根据归因源的
"trigger_data_matching"
字段进行修改。注意:用于表示每个事件的值以及数组中的元素数量完全是任意的,由您作为开发人员定义。数组可能包含未使用的值,但数组中必须存在值才能在注册触发器时由浏览器归因于源。
"priority"
可选-
表示归因触发器优先级值的字符串。默认情况下,触发器将归因于最新的匹配源。对于事件级和汇总报告,您可以设置更高的优先级数字以使触发器匹配较旧的源。例如,值
2
优先于默认值1
。有关更多信息,请参阅 报告优先级和限制。 "deduplication_key"
可选-
表示唯一键的字符串,可用于防止重复归因——例如,如果用户多次将同一商品添加到购物车。有关更多信息,请参阅 防止报告中的重复。
"filters"
可选-
包含筛选器对象,这些筛选器执行选择性筛选以根据相应
Attribution-Reporting-Register-Source
标头中设置的filter_data
设置"trigger_data"
、"priority"
和"deduplication_key"
。有关更多信息,请参阅 筛选器。
示例
为事件级报告注册触发器
Node.js 服务器可能会如下设置 Attribution-Reporting-Register-Trigger
响应标头以注册旨在匹配事件级报告归因源的触发器
res.set(
"Attribution-Reporting-Register-Trigger",
JSON.stringify({
"event_trigger_data": [
{
"trigger_data": "4",
"priority": "1000000000000",
"deduplication_key": "2345698765",
},
],
"debug_key": "1115698977",
});
);
为汇总报告注册触发器
在注册旨在与汇总报告归因源匹配的触发器时,您需要包含以下字段
res.set(
"Attribution-Reporting-Register-Trigger",
JSON.stringify({
"aggregatable_trigger_data": [
{
"key_piece": "0x400",
"source_keys": ["campaignCounts"]
},
{
"key_piece": "0xA80",
"source_keys": ["geoValue", "nonMatchingKeyIdsAreIgnored"]
}
],
"aggregatable_values": {
"campaignCounts": 32768,
"geoValue": 1664
},
"debug_key": "1115698977"
});
);
规范
规范 |
---|
归因报告 # 创建归因触发器 |
浏览器兼容性
BCD 表格仅在启用 JavaScript 的浏览器中加载。