Attribution-Reporting-Register-Trigger header
Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.
Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.
Der HTTP Attribution-Reporting-Register-Trigger Response-Header registriert eine Seitenfunktion als Attribution Trigger. Dieser Header ist Teil einer Antwort auf eine Anfrage, die den Attribution-Reporting-Eligible Header enthält.
Weitere Details finden Sie in der Attribution Reporting API.
Hinweis:
Wenn die aufrufende Seite die Attribution Reporting API nicht im Rahmen eines erfolgreichen Privacy Sandbox-Registrierungsprozesses eingebunden hat, wird der Attribution-Reporting-Register-Trigger Header ignoriert und Attribution Trigger werden nicht registriert.
| Header-Typ | Response-Header |
|---|---|
| CORS-safelisted response header | Nein |
Syntax
Attribution-Reporting-Register-Trigger: <json-string>
Direktiven
<json-string>-
Ein JSON-String, der Daten liefert, die in generierte Berichte aufgenommen werden können, wie die ID des Triggers, sowie Prioritäts- und Deduplizierungswerte. Verfügbare Felder sind:
"aggregatable_trigger_data"-
Ein Array von Objekten, von denen jedes einen Aggregationsschlüssel definiert, der auf verschiedene Quellen-Schlüssel angewendet wird. 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, das Eigenschaften enthält, die einen Wert für jeden in
"aggregatable_trigger_data"definierten Datenpunkt darstellen. In jedem Fall entspricht der Eigenschaftsname dem in"source_keys"definierten Namen, und der Eigenschaftswert ist ein beliebiger Wert, den Sie benötigen. "debug_key"Optional-
Eine Zahl, die einen Debug-Schlüssel darstellt. Setzen Sie diesen, wenn Sie einen Debug-Bericht zusammen mit dem zugehörigen Attributionsbericht generieren möchten.
"debug_reporting"Optional-
Ein boolescher Wert. Wenn ein
debug_keygesetzt ist, setzen Sie diesen auftrue, 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 zu filtern, welche Trigger Berichte generieren. Siehe Filter für weitere Details.
"event_trigger_data"-
Ein Objekt, das Daten über den Trigger darstellt. Verfügbare Unterfelder sind:
"trigger_data"-
Ein String, der Daten beschreibt, die den Trigger beschreiben, üblicherweise verwendet, um Ereignisse wie "Benutzer hat Artikel zum Warenkorb hinzugefügt" oder "Benutzer hat sich für den Newsletter angemeldet" anzugeben. Dieser Wert wird in den generierten ereignisbezogenen Bericht aufgenommen, sofern vorhanden, wobei er jedoch auf Basis des
"trigger_data_matching"Felds der zugeordneten Quelle modifiziert werden kann.Hinweis: Die Werte, die verwendet werden, um jedes Ereignis darzustellen, und die Anzahl der Elemente im Array sind völlig beliebig und von Ihnen als Entwickler definiert. Das Array kann Werte enthalten, die nicht verwendet werden, aber Werte müssen im Array vorhanden sein, damit sie der Quelle vom Browser zugeordnet werden, wenn ein Trigger registriert wird.
"priority"Optional-
Ein String, der einen Prioritätswert für den Attribution Trigger darstellt. Standardmäßig werden Trigger der zuletzt passenden Quelle zugeordnet. Für sowohl ereignisbezogene als auch zusammenfassende Berichte setzen Sie eine höhere Prioritätsnummer, um den Trigger mit älteren Quellen zu matchen. Ein Wert von
2hat z.B. Vorrang vor dem Standardwert von1. Siehe Bericht-Prioritäten und -Grenzen für mehr Informationen. "deduplication_key"Optional-
Ein String, der einen eindeutigen Schlüssel darstellt, der verwendet werden kann, um Doppelattributionen zu verhindern — zum Beispiel, wenn ein Benutzer denselben Artikel mehrmals in einen Einkaufswagen legt. Siehe Doppelung in Berichten verhindern für mehr Informationen.
"filters"Optional-
Ein Objekt, das Filter enthält, die selektives Filtern durchführen, um
"trigger_data","priority"und"deduplication_key"basierend auf denfilter_dataim entsprechendenAttribution-Reporting-Register-SourceHeader festzulegen. Siehe Filter für mehr Informationen.
Beispiele
Registrieren eines Triggers für einen ereignisbezogenen Bericht
Ein Node.js-Server könnte den Attribution-Reporting-Register-Trigger Response-Header wie folgt setzen, um einen Trigger zu registrieren, der einer Quelle für die Attribution auf Ereignisebene entspricht:
res.set(
"Attribution-Reporting-Register-Trigger",
JSON.stringify({
event_trigger_data: [
{
trigger_data: "4",
priority: "1000000000000",
deduplication_key: "2345698765",
},
],
debug_key: "1115698977",
}),
);
Registrieren eines Triggers für einen zusammenfassenden Bericht
Wenn Sie einen Trigger registrieren, der mit einer Quelle für die Attribution in einem zusammenfassenden Bericht übereinstimmen soll, müssen Sie die folgenden Felder einbeziehen:
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",
}),
);