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 einen Attribution-Trigger. Dieser Header ist Teil einer Antwort auf eine Anfrage, die den Attribution-Reporting-Eligible
Header enthält.
Weitere Informationen finden Sie in der Attribution Reporting API.
Hinweis:
Wenn die aufrufende Seite die Attribution Reporting API nicht in einem erfolgreichen Privacy Sandbox-Anmeldeprozess integriert hat, wird der Attribution-Reporting-Register-Trigger
Header ignoriert und Attribution-Triggers werden nicht registriert.
Header-Typ | Antwort-Header |
---|---|
Verbotener Anfrage-Header | Nein |
CORS-sichere Antwort-Header | Nein |
Syntax
Attribution-Reporting-Register-Trigger: <json-string>
Direktiven
<json-string>
-
Ein JSON-String, der Daten bereitstellt, die in erstellte Berichte aufgenommen werden können, wie z. B. die ID des Triggers sowie Prioritäts- und Entdoppelungswerte. Verfügbare Felder sind wie folgt:
"aggregatable_trigger_data"
-
Ein Array von Objekten, von denen jedes einen Aggregationsschlüssel definiert, der auf verschiedene Quellschlüssel angewendet wird. Jedes Objekt enthält die folgenden Eigenschaften:
"key_piece"
-
Ein Hexadezimalwert, 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 dies, wenn Sie neben dem zugehörigen Attraktionsbericht einen Debug-Bericht generieren möchten.
"debug_reporting"
Optional-
Ein boolescher Wert. Wenn ein
debug_key
festgelegt ist, setzen Sie dies 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 erzeugen. Weitere Details finden Sie unter Filter.
"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, der 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 in den generierten ereignisbezogenen Bericht aufgenommen, falls vorhanden, obwohl er basierend auf dem Feld
"trigger_data_matching"
des zugeordneten Ursprungs geändert werden kann.Hinweis: Die Werte, die zur Darstellung jedes Ereignisses verwendet werden, und die Anzahl der Elemente im Array sind völlig beliebig 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 dem Browser dem Ursprung zugeordnet zu werden, wenn ein Trigger registriert wird.
"priority"
Optional-
Ein String, der einen Prioritätswert für den Attribution-Trigger darstellt. Standardmäßig werden Trigger dem zuletzt passenden Ursprung zugeordnet. Für sowohl ereignisbezogene als auch zusammenfassende Berichte setzen Sie eine höhere Prioritätsnummer, um den Trigger älteren Ursprüngen zuzuordnen. Zum Beispiel hat ein Wert von
2
Vorrang vor dem Standardwert von1
. Weitere Informationen finden Sie unter Berichtsprioritäten und -limits. "deduplication_key"
Optional-
Ein String, der einen einzigartigen Schlüssel darstellt, der verwendet werden kann, um zu verhindern, dass Attributationen dupliziert werden - zum Beispiel, wenn ein Benutzer denselben Artikel mehrfach in einen Warenkorb legen würde. Weitere Informationen finden Sie unter Duplizierung in Berichten verhindern.
"filters"
Optional-
Ein Objekt, das Filter enthält, die selektives Filtern durchführen, um
"trigger_data"
,"priority"
und"deduplication_key"
basierend auf den in einem entsprechendenAttribution-Reporting-Register-Source
Header gesetztenfilter_data
festzulegen. Weitere Informationen finden Sie unter Filter.
Beispiele
Registrieren eines Triggers für einen ereignisbezogenen Bericht
Ein Node.js-Server könnte den Attribution-Reporting-Register-Trigger
Antwort-Header wie folgt setzen, um einen Trigger zu registrieren, der eine Zuordnung zu einer ereignisbezogenen Berichtsattributionsquelle beabsichtigt:
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
Beim Registrieren eines Triggers, der eine Zuordnung mit einer zusammenfassenden Berichtsattributionsquelle beabsichtigt, 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",
}),
);
Spezifikationen
Specification |
---|
Attribution Reporting # create-an-attribution-trigger |