Document: browsingTopics() Methode

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

Kein Standard: Diese Funktion ist nicht standardisiert und befindet sich nicht im Standardisierungsprozess. Verwenden Sie sie nicht auf Produktionsseiten, die auf das Web ausgerichtet sind: Sie wird nicht für alle Benutzer funktionieren. Außerdem kann es große Inkompatibilitäten zwischen Implementierungen geben und das Verhalten kann sich in Zukunft ändern.

Warnung: Dieses Feature wird derzeit von zwei Browser-Anbietern abgelehnt. Siehe den Abschnitt Standards positions unten für Details zur Ablehnung.

Hinweis: Ein Einschreibungsprozess ist erforderlich, um dieses Feature in Ihren Anwendungen zu nutzen.

Die browsingTopics() Methode des Document Interface gibt ein Promise zurück, das mit einem Array von Objekten erfüllt wird, die die wichtigsten Themen für den Benutzer repräsentieren, eines aus jeder der letzten drei Epochen. Diese Themen könnten dann in einer nachfolgenden Fetch-Anfrage an die Werbetechnologie-Plattform zurückgegeben werden. Standardmäßig bewirkt die Methode auch, dass der Browser den aktuellen Seitenbesuch aufzeichnet, wie vom Aufrufer beobachtet, sodass der Hostname der Seite später bei der Themenberechnung verwendet werden kann.

Siehe Using the Topics API für weitere Details.

Hinweis: browsingTopics() verlässt sich nicht auf HTTP-Header, um Themen zu senden und als beobachtet zu markieren, wie andere Topics API enabling features, aber es ist etwas weniger leistungsfähig. Es wird empfohlen, eines der HTTP-Header-verwendenden Features zu nutzen und nur auf browsingTopics() zurückzugreifen, wenn die Header nicht geändert werden können.

Syntax

browsingTopics()
browsingTopics(options)

Parameter

options Optional

Ein Optionsobjekt, das die folgenden Eigenschaften enthalten kann:

skipObservation: Ein boolescher Wert, der, wenn auf true gesetzt, bewirkt, dass der Browser nicht beobachtet, wenn browsingTopics() aufgerufen wird. Der Standardwert ist false, was dazu führt, dass Themen beobachtet werden.

Rückgabewert

Ein Promise, das mit einem Array von bis zu drei Objekten erfüllt wird, die die ausgewählten Themen des aktuellen Benutzers für die letzten drei Epochen darstellen. Jedes Objekt enthält die folgenden Eigenschaften:

configVersion: Ein String, der den Algorithmus (außer dem Modellteil) identifiziert, der zur Berechnung des Themas verwendet wird.
modelVersion: Ein String, der das Modell repräsentiert, das verwendet wird, um einen String (wie den Hostnamen einer Webseite) in Themen IDs zu klassifizieren.
taxonomyVersion: Ein String, der die verwendete Taxonomie-Version repräsentiert.
topic: Eine Zahl, die die ID des Themas repräsentiert, die vom Browser verwendet werden kann, um das Thema aus der Taxonomie abzurufen (siehe ein Beispiel für eine Interessen-Taxonomie).
version: Die configVersion, modelVersion und taxonomyVersion, die mit Doppelpunkten (:) zwischen jedem zusammengefügt sind.

Die genauen Eigenschaftswerte können je nach Browser-Implementierung variieren. Ein Beispielobjekt von Chrome könnte wie folgt aussehen:

{
  configVersion: "chrome.1",
  modelVersion: "1",
  taxonomyVersion: "1",
  topic: 43,
  version: "chrome.1:1:1"
}

Ausnahmen

NotAllowedError DOMException

Wird ausgelöst, wenn:

Die Nutzung der Topics API durch eine browsing-topics Berechtigungsrichtlinie nicht erlaubt ist.
Die aufrufende Seite die Topics API nicht in einem erfolgreichen Privacy Sandbox Einschreibungsprozess beinhaltet.

Beispiele

// Get an array of top topics for this user
const topics = await document.browsingTopics();

// Request an ad creative
const response = await fetch("https://ads.example/get-creative", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify(topics),
});

// Get the JSON from the response
const creative = await response.json();

// Display ad

Topics API