Attribution-Reporting-Register-Trigger

實驗性功能: 這是一個 實驗性技術
在生產環境中使用之前,請仔細檢視 瀏覽器相容性表格

Attribution-Reporting-Register-Trigger 標頭將頁面功能註冊為 歸因觸發器。這是包含在對包含 Attribution-Reporting-Eligible 標頭的請求的響應的一部分。

有關更多詳細資訊,請參閱 歸因報告 API

注意:如果呼叫站點未在成功的 隱私沙盒註冊流程 中包含歸因報告 API,則會忽略 Attribution-Reporting-Register-Trigger 標頭,並且不會註冊歸因觸發器。

標頭型別 響應標頭
禁止的標頭名稱
CORS 安全列表響應標頭

語法

http
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 響應標頭以註冊旨在匹配事件級報告歸因源的觸發器

js
res.set(
  "Attribution-Reporting-Register-Trigger",
  JSON.stringify({
    "event_trigger_data": [
      {
        "trigger_data": "4",
        "priority": "1000000000000",
        "deduplication_key": "2345698765",
      },
    ],
    "debug_key": "1115698977",
  });
);

為彙總報告註冊觸發器

在註冊旨在與彙總報告歸因源匹配的觸發器時,您需要包含以下欄位

js
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 的瀏覽器中載入。

另請參閱