Attribution-Reporting-Register-Trigger header

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 im Rahmen eines erfolgreichen Privacy Sandbox Anmeldeprozesses enthält, 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

http

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

Direktiven

<json-string>

Ein JSON-String, der Daten bereitstellt, die in generierten Berichten enthalten sein können, wie z.B. die ID des Triggers sowie Prioritäts- und Deduplikationswerte. 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 ist der Eigenschaftsname gleich 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_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 mit benutzerdefinierten Daten, die verwendet werden können, um festzulegen, 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": Ein String, der Daten repräsentiert, die den Trigger beschreiben, der typischerweise verwendet wird, um Ereignisse wie "Nutzer hat Artikel in den Warenkorb gelegt" oder "Nutzer hat sich für die Mailingliste angemeldet" anzuzeigen. Dieser Wert wird in den generierten Bericht auf Ereignisebene aufgenommen, falls vorhanden, obwohl er basierend auf dem Attributed Source's "trigger_data_matching" Feld modifiziert wird.

Hinweis: Die verwendeten Werte zur Repräsentation jedes Ereignisses und 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 es müssen Werte im Array vorhanden sein, um vom Browser beim Registrieren eines Triggers auf die Quelle attributiert zu werden.
"priority" Optional: Ein String, der einen Prioritätswert für den Attribution Trigger darstellt. Standardmäßig werden Triggers der zuletzt passenden Quelle zugeordnet. Sowohl für Berichte auf Ereignisebene als auch Zusammenfassungsberichte setzen Sie eine höhere Prioritätszahl, um den Trigger älteren Quellen zuzuordnen. Beispielsweise hat ein Wert von 2 Vorrang vor dem Standardwert von 1. Siehe Berichtsprioritäten und -grenzen für weitere Informationen.
"deduplication_key" Optional: Ein String, der einen eindeutigen Schlüssel darstellt, der verwendet werden kann, um zu verhindern, dass Attributions dupliziert werden - zum Beispiel, wenn ein Nutzer denselben Artikel mehrfach in einen Warenkorb legt. Siehe Duplikationsvermeidung 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 den filter_data, die in einem entsprechenden Attribution-Reporting-Register-Source Header gesetzt sind, festzulegen. Siehe Filter für mehr Informationen.

Beispiele

Registrieren eines Triggers für einen Bericht auf Ereignisebene

Ein Node.js-Server könnte den Attribution-Reporting-Register-Trigger Response-Header wie folgt setzen, um einen Trigger zu registrieren, der für die Zuordnung zu einer Attributionquelle auf Ereignisebene bestimmt ist:

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 Zusammenfassungsbericht-Attributionquelle ü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