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
Response-Header registriert ein Seitenmerkmal als Attribution Trigger. Dieser Header ist Teil einer Antwort auf eine Anfrage, die den Attribution-Reporting-Eligible
Header enthält.
Siehe die Attribution Reporting API für weitere Details.
Hinweis:
Wenn die aufrufende Seite die Attribution Reporting API nicht erfolgreich über einen Privacy Sandbox Anmeldeprozess integriert hat, wird der Attribution-Reporting-Register-Trigger
Header ignoriert und Attribution Triggers werden nicht registriert.
Header-Typ | Response-Header |
---|---|
Verbotener Request-Header | Nein |
CORS-safelisted Response-Header | Nein |
Syntax
Attribution-Reporting-Register-Trigger: <json-string>
Direktiven
<json-string>
-
Eine JSON-Zeichenkette, die Daten bereitstellt, die in generierten Berichten enthalten sein können, wie z.B. die ID des Triggers, Prioritäts- und Deduplizierungswerte. Verfügbare Felder sind wie folgt:
"aggregatable_trigger_data"
-
Ein Array von Objekten, wobei jedes ein Aggregationsschlüssel definiert, der auf verschiedene Quellschlü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 repräsentieren. In jedem Fall entspricht der Eigenschaftsname dem in"source_keys"
definierten Namen und der Eigenschaftswert ist ein beliebiger von Ihnen benötigter Wert. "debug_key"
Optional-
Eine Zahl, die einen Debug-Schlüssel darstellt. Stellen Sie diesen ein, 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 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 Triggers Berichte generieren. Siehe Filter für weitere Details.
"event_trigger_data"
-
Ein Objekt, das Daten über den Trigger darstellt. Verfügbare Unterfelder sind wie folgt:
"trigger_data"
-
Eine Zeichenkette, die Daten repräsentiert, die den Trigger beschreiben, und typischerweise dazu verwendet wird, 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 Berichts auf Event-Ebene enthalten sein, obwohl er aufgrund des dem zugewiesenen Quellobjekts zugewiesenen
"trigger_data_matching"
Felds einer Modifikation unterliegen kann.Hinweis: Die Werte, die verwendet werden, um jedes Ereignis darzustellen, sowie die Anzahl der Elemente im Array, sind vollständig 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 vom Browser einer Quelle zugeordnet werden können, wenn ein Trigger registriert wird.
"priority"
Optional-
Eine Zeichenkette, die einen Prioritätswert für den Attribution Trigger darstellt. Standardmäßig werden Triggers der zuletzt passenden Quelle zugeordnet. Für sowohl event-level als auch zusammenfassende Berichte können Sie einen höheren Prioritätswert setzen, um den Trigger mit älteren Quellen abzugleichen. Zum Beispiel nimmt ein Wert von
2
Vorrang vor dem Standardwert von1
. Siehe Berichtsprioritäten und -limits für weitere Informationen. "deduplication_key"
Optional-
Eine Zeichenkette, die einen eindeutigen Schlüssel darstellt, der verwendet werden kann, um zu verhindern, dass Attributions dupliziert werden — zum Beispiel, wenn ein Benutzer denselben Artikel mehrfach in einen Warenkorb legt. Siehe Verhinderung von Duplikaten in Berichten 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 dem im entsprechendenAttribution-Reporting-Register-Source
Header gesetztenfilter_data
zu setzen. Siehe Filter für weitere Informationen.
Beispiele
Registrierung eines Triggers für einen Bericht auf Event-Ebene
Ein Node.js-Server könnte den Attribution-Reporting-Register-Trigger
Response-Header wie folgt setzen, um einen Trigger zu registrieren, der einer Attributionsquelle für einen Bericht auf Event-Ebene entsprechen soll:
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 zusammenfassenden Bericht
Wenn Sie einen Trigger registrieren möchten, der mit einer Attributionsquelle für einen zusammenfassenden Bericht ü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"
});
);
Spezifikationen
Specification |
---|
Attribution Reporting # create-an-attribution-trigger |
Browser-Kompatibilität
BCD tables only load in the browser