Attribution-Reporting-Register-Trigger

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Der HTTP Attribution-Reporting-Register-Trigger Antwort-Header registriert ein Seitenmerkmal als Attribution-Trigger. Dieser Header ist Teil einer Antwort auf eine Anfrage, die den Header Attribution-Reporting-Eligible enthält.

Weitere Details finden Sie in der Attribution Reporting API.

Hinweis: Wenn die aufrufende Site die Attribution Reporting API nicht in einem erfolgreichen Privacy Sandbox Einschreibungsprozess eingebunden hat, wird der Attribution-Reporting-Register-Trigger Header ignoriert und Attribution-Trigger werden nicht registriert.

Header-Typ Antwort-Header
Verbotener Anfrage-Header Nein
CORS-safelisted Antwort-Header Nein

Syntax

http
Attribution-Reporting-Register-Trigger: <json-string>

Direktiven

<json-string>

Ein JSON-String, der Daten bereitstellt, die in generierte Berichte aufgenommen werden können, wie die ID des Triggers, Prioritäts- und Deduplizierungswerte. Verfügbare Felder sind wie folgt:

"aggregatable_trigger_data"

Ein Array von Objekten, wobei jedes einen Aggregationsschlüssel definiert, der auf verschiedene Quellschlüssel anzuwenden ist. Jedes Objekt enthält die folgenden Eigenschaften:

"key_piece"

Ein hexadezimaler Wert, der einen Schlüssel darstellt.

"source_keys"

Ein Array, das einen oder mehrere Schlüsselwerte für die Daten enthält.

"aggregatable_values"

Ein Objekt mit Eigenschaften, die einen Wert für jeden Datenpunkt darstellen, der in "aggregatable_trigger_data" definiert ist. In jedem Fall entspricht der Eigenschaftsname dem Namen, der in "source_keys" definiert ist, und der Eigenschaftswert ist ein beliebiger Wert, den Sie benötigen.

"debug_key" Optional

Eine Zahl, die einen Debug-Schlüssel darstellt. Setzen Sie dies, wenn Sie einen Debug-Bericht zusammen mit dem zugehörigen Attributionsbericht generieren möchten.

"debug_reporting" Optional

Ein boolescher Wert. Wenn ein debug_key gesetzt ist, setzen Sie dies auf true, um anzugeben, dass der generierte Debug-Bericht ein ausführlicher Debug-Bericht sein soll.

"filters" Optional

Ein Objekt, das benutzerdefinierte Daten enthält, die verwendet werden können, um festzulegen, welche Trigger Berichte generieren. Weitere Details finden Sie unter Filters.

"event_trigger_data"

Ein Objekt, das Daten über den Trigger darstellt. Die verfügbaren Unterfelder sind wie folgt:

"trigger_data"

Ein String, der Daten darstellt, die den Trigger beschreiben, und typischerweise für Ereignisse wie "Benutzer hat Artikel in den Warenkorb gelegt" oder "Benutzer hat sich für die Mailingliste angemeldet" verwendet wird. Dieser Wert wird in den generierten Ereignisbericht aufgenommen, sofern vorhanden, allerdings kann er basierend auf dem "trigger_data_matching" Feld der zugeordneten Quelle geändert werden.

Hinweis: Die Werte zur Darstellung jedes Ereignisses und die Anzahl der Elemente im Array sind vollständig willkürlich und von Ihnen als Entwickler festgelegt. Das Array kann Werte enthalten, die nicht verwendet werden, aber es müssen Werte im Array vorhanden sein, damit sie vom Browser der Quelle zugeordnet werden können, wenn ein Trigger registriert wird.

"priority" Optional

Ein String, der einen Prioritätswert für den Attribution-Trigger darstellt. Standardmäßig werden Trigger der neuesten übereinstimmenden Quelle zugeordnet. Für sowohl Ereignis- als auch Zusammenfassungsberichte setzen Sie eine höhere Prioritätsnummer, um den Trigger mit älteren Quellen zu verknüpfen. Zum Beispiel hat ein Wert von 2 Vorrang vor dem Standardwert von 1. Weitere Informationen finden Sie unter Berichtsprioritäten und -grenzen.

"deduplication_key" Optional

Ein String, der einen eindeutigen Schlüssel darstellt, der verwendet werden kann, um zu verhindern, dass Zuordnungen dupliziert werden — z. B. wenn ein Benutzer denselben Artikel mehrmals in einen Warenkorb legt. Weitere Informationen finden Sie unter Vermeidung von Duplikationen in Berichten.

"filters" Optional

Ein Objekt, das Filter enthält, die selektives Filtern durchführen, um "trigger_data", "priority" und "deduplication_key" basierend auf den im entsprechenden Attribution-Reporting-Register-Source Header gesetzten filter_data festzulegen. Weitere Informationen finden Sie in Filters.

Beispiele

Registrierung eines Triggers für einen Ereignisbericht

Ein Node.js-Server könnte den Attribution-Reporting-Register-Trigger Antwort-Header wie folgt festlegen, um einen Trigger zu registrieren, der für eine Attribution-Quelle eines Ereignisberichts bestimmt ist:

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

Registrierung eines Triggers für einen Zusammenfassungsbericht

Bei der Registrierung eines Triggers, der darauf abzielt, mit einer Attribution-Quelle eines Zusammenfassungsberichts übereinzustimmen, müssen Sie die folgenden Felder einbeziehen:

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"
  });
);

Spezifikationen

Specification
Attribution Reporting
# create-an-attribution-trigger

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Attribution-Reporting-Register-Trigger
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.

Siehe auch