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 Seitenelement als ein Attributionstrigger. 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 Webseite die Attribution Reporting API nicht in einem erfolgreichen Enrollment-Prozess der Privacy Sandbox enthalten hat, wird der Attribution-Reporting-Register-Trigger Header ignoriert und die Attributionstrigger werden nicht registriert.

Header-Typ Response header
Verbotener Headername Nein
CORS-sicherer gelisteter Antwortheader Nein

Syntax

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

Direktiven

<json-string>

Ein JSON-String, der Daten bereitstellt, die in generierte Berichte aufgenommen werden können, wie z.B. die ID des Triggers sowie Prioritäts- und Deduplizierungswerte. 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 werden soll. 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 jeder beliebige Wert, den Sie benötigen.

"debug_key" Optional

Eine Nummer, die einen Debug-Schlüssel darstellt. Setzen Sie dies, wenn Sie einen Debug-Bericht neben 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, das benutzerdefinierte Daten enthält, die zum Filtern 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, 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 im generierten ereignisbezogenen Bericht enthalten sein, falls vorhanden, obwohl er basierend auf dem "trigger_data_matching" Feld der zugeordneten Quelle geändert wird.

Hinweis: Die Werte, die jedes Ereignis darstellen, sowie die Anzahl der Elemente im Array sind völlig willkürlich und von Ihnen als Entwickler festgelegt. Das Array kann Werte enthalten, die nicht verwendet werden, jedoch müssen Werte im Array vorhanden sein, um der Quelle durch den Browser zugeordnet zu werden, wenn ein Trigger registriert wird.

"priority" Optional

Ein String, der einen Prioritätswert für den Attributionstrigger darstellt. Standardmäßig werden Trigger der zuletzt passenden Quelle zugeordnet. Für ereignisbezogene und zusammenfassende Berichte setzen Sie eine höhere Prioritätsnummer, um den Trigger älteren Quellen zuzuordnen. Zum Beispiel hat ein Wert von 2 Vorrang vor dem Standardwert von 1. Siehe Berichtsprioritäten und -beschränkungen für mehr Informationen.

"deduplication_key" Optional

Ein String, der einen eindeutigen Schlüssel darstellt, der verwendet werden kann, um zu verhindern, dass Attributionsvorgänge dupliziert werden — beispielsweise wenn ein Benutzer denselben Artikel mehrfach in einen Warenkorb legt. Siehe Verhindern von Duplikationen 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 im entsprechenden Attribution-Reporting-Register-Source Header gesetzten filter_data 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 Antwortheader wie folgt setzen, um einen Trigger zu registrieren, der einer Attributionsquelle auf Ereignisebene zugeordnet werden soll:

js
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

Bei der Registrierung eines Triggers, der mit einer Attributionsquelle für einen zusammenfassenden Bericht übereinstimmen soll, müssen Sie die folgenden Felder einschließen:

js
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

Siehe auch