Fence: reportEvent() Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Die reportEvent() Methode der Fence-Schnittstelle löst die Übermittlung von Berichtsdaten über ein beacon an eine oder mehrere spezifische URLs aus, die über die registerAdBeacon()-Methode der Protected Audience API registriert wurden, um die Ergebnisse der Anzeigenauktion zu sammeln.

Note: setReportEventDataForAutomaticBeacons() bietet eine ähnliche Übermittlung von Berichtsdaten, außer dass die Übermittlung in diesem Fall durch eine Navigation und nicht durch einen expliziten Methodenaufruf ausgelöst wird.

Syntax

js
reportEvent(event)

Parameter

event

Ein Objekt oder ein String, der die zu sendenden Daten darstellt.

  • Ein Objektwert definiert ein spezifisches Berichtsevent, das Sie senden möchten. Die erforderlichen Eigenschaften sind wie folgt:
    eventType

    Ein String, der den Typ des berichteten Events darstellt – zum Beispiel könnten Sie daran interessiert sein, wie oft auf eine Anzeige geklickt wird. Dieser String kann jeder relevante Eventname sein (zum Beispiel click). Dieser muss mit dem im zugehörigen registerAdBeacon()-Aufruf in einem Protected Audience API Worklet angegebenen Eventtyp übereinstimmen.

    eventData

    Ein String, der die zu sendenden Daten darstellt.

    destination

    Ein Array, das einen oder mehrere aufgezählte Werte enthält, die Zieltypen darstellen. Dies sind die beteiligten Parteien, die die Daten an ihre registrierten URLs erhalten (d. h. über registerAdBeacon()). Die möglichen Werte sind:

    • "buyer": Der Bieter in der Anzeigenauktion.
    • "seller": Der Hauptverkäufer, der die Anzeigenauktion durchführt.
    • "component-seller": Der Verkäufer für eine Komponentenauktion in einer mehrstufigen Auktion.
    • "direct-seller": Der Verkäufer, der die Auktion, in der der Käufer geboten hat, direkt durchgeführt hat. Wenn die Anzeige eine einstufige Auktion war, wird der Wert "seller" verwendet. Wenn die Anzeige eine mehrstufige Auktion war, wird der Wert "component-seller" verwendet.
    • "shared-storage-select-url": Ein Shared Storage API Speicherort, wie in einem Window.sharedStorage.selectURL()-Methodenaufruf definiert.
  • Ein Stringwert stellt einen eventType dar, zum Beispiel "click" (siehe die frühere Definition von eventType). Wenn ein eventType-String als Wert von reportEvent() übergeben wird, löst dies alle Private Aggregation-Beiträge aus, die von diesem Eventtyp abhängen (zum Beispiel über PrivateAggregation.contributeToHistogramOnEvent()) gesendet werden sollen.

Rückgabewert

Keiner (Undefined).

Beispiele

js
window.fence.reportEvent({
  eventType: "click",
  eventData: JSON.stringify({ clickX: "123", clickY: "456" }),
  destination: ["buyer", "seller"],
});

Spezifikationen

Specification
Fenced Frame
# dom-fence-reportevent

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch