Attribution-Reporting-Register-Trigger header
Deprecated
To be removed
This feature is pending removal from browsers. Using it now may lead to broken functionality in future updates. Following the announcement that Chrome will maintain its current approach to third-party cookies, Chrome decided to withdraw certain Privacy Sandbox features including the attribution reporting API.
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 einen Attributions-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 erfolgreich im Rahmen eines Privacy Sandbox-Anmeldeprozesses eingebunden hat, wird der Attribution-Reporting-Register-Trigger Header ignoriert und Attributions-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 bereitstellt, die in generierte Berichte aufgenommen werden können, wie die ID des Triggers, Prioritäts- und Duplikationswerte. Verfügbare Felder sind wie folgt:
"aggregatable_trigger_data"-
Ein Array von Objekten, von denen jedes einen Aggregationsschlüssel definiert, der auf verschiedene Quellenschlü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 Name der Eigenschaft dem in"source_keys"definierten Namen, und der Wert der Eigenschaft ist ein beliebiger Wert, den Sie benötigen. "debug_key"Optional-
Eine Zahl, die einen Debug-Schlüssel darstellt. Setzen Sie diesen, wenn Sie neben dem zugehörigen Attributionsbericht auch einen Debug-Bericht 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 zur Filterung verwendet werden können, welche Trigger Berichte generieren. Siehe Filter für mehr Details.
"event_trigger_data"-
Ein Objekt, das Daten über den Trigger darstellt. Verfügbare Unterfelder sind wie folgt:
"trigger_data"-
Ein String, der Daten darstellt, die den Trigger beschreiben, und typischerweise verwendet wird, um Ereignisse wie "Benutzer hat Artikel in den Warenkorb gelegt" oder "Benutzer hat sich für die Mailingliste angemeldet" anzuzeigen. Dieser Wert wird, falls vorhanden, im generierten Ereignis-Level-Bericht enthalten sein, obwohl er basierend auf dem
"trigger_data_matching"Feld der zugeordneten Quelle geändert werden kann.Hinweis: Die Werte, die verwendet werden, um jedes Ereignis darzustellen, und die Anzahl der Elemente im Array sind völlig willkürlich und werden von Ihnen als Entwickler definiert. Das Array kann Werte enthalten, die nicht verwendet werden, aber Werte müssen im Array vorhanden sein, um von der Quelle durch den Browser zugeordnet zu werden, wenn ein Trigger registriert wird.
"priority"Optional-
Ein String, der einen Prioritätswert für den Attributions-Trigger darstellt. Standardmäßig werden Trigger der neuesten passenden Quelle zugeordnet. Sowohl für Ereignis-Level- als auch für Zusammenfassungsberichte setzen Sie eine höhere Prioritätszahl, um den Trigger älteren Quellen zuzuordnen. Zum Beispiel hat ein Wert von
2Vorrang vor dem Standardwert von1. Siehe Prioritäten und Beschränkungen von Berichten für weitere Informationen. "deduplication_key"Optional-
Ein String, der einen einzigartigen Schlüssel darstellt, der verwendet werden kann, um zu verhindern, dass Attributions mehrfach durchgeführt werden — zum Beispiel, wenn ein Benutzer denselben Artikel mehrfach in den Warenkorb legt. Siehe Verhindern von Duplikationen in Berichten für weitere Informationen.
"filters"Optional-
Ein Objekt, das Filter enthält, die selektives Filtern durchführen, um
"trigger_data","priority", und"deduplication_key"basierend auf dem in einem entsprechendenAttribution-Reporting-Register-SourceHeader gesetztenfilter_datazu setzen. Siehe Filter für weitere Informationen.
Beispiele
Registrieren eines Triggers für einen Ereignis-Level-Bericht
Ein Node.js-Server könnte den Attribution-Reporting-Register-Trigger Response-Header wie folgt setzen, um einen Trigger zu registrieren, der einer Ereignis-Level-Bericht-Attributionsquelle entsprechen soll:
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 Zusammenfassungsbericht
Beim Registrieren eines Triggers, der mit einer Attributionsquelle für Zusammenfassungsberichte übereinstimmen soll, müssen Sie die folgenden Felder einschließen:
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",
}),
);