Dokument: browsingTopics() Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Nicht standardisiert: Diese Funktion ist nicht standardisiert und befindet sich nicht auf dem Weg zur Standardisierung. Verwenden Sie sie nicht auf Produktionsseiten, die dem Web ausgesetzt sind: Sie funktioniert nicht für alle Benutzer. Es kann auch große Inkompatibilitäten zwischen Implementierungen geben, und das Verhalten kann sich in Zukunft ändern.

Warnung: Diese Funktion wird derzeit von zwei Browserherstellern abgelehnt. Einzelheiten zur Ablehnung finden Sie im Abschnitt Standards positions unten.

Hinweis: Um diese Funktion in Ihren Anwendungen nutzen zu können, ist ein Anmeldeprozess erforderlich.

Die browsingTopics() Methode des Document Interfaces 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 Ad-Tech-Plattform zurückgegeben werden. Standardmäßig führt die Methode auch dazu, dass der Browser den aktuellen Seitenbesuch aufzeichnet, wie vom Aufrufer beobachtet, sodass der Hostname der Seite später bei der Themenermittlung verwendet werden kann.

Weitere Einzelheiten finden Sie unter Using the Topics API.

Hinweis: browsingTopics() verlässt sich nicht auf HTTP-Header, um Themen zu senden und als beobachtet zu markieren, wie die anderen Funktionen zur Aktivierung der Topics API, aber es ist etwas weniger performant. Es wird empfohlen, eine der HTTP-Header-nutzenden Funktionen zu verwenden und nur dann 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, dazu führt, dass der Browser keine Themen 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 aktuell ausgewählten Themen des Benutzers für die letzten drei Epochen darstellen. Jedes Objekt enthält die folgenden Eigenschaften:

configVersion: Eine Zeichenkette, die den Algorithmus (außer dem Modellanteil) identifiziert, der zur Berechnung des Themas verwendet wird.
modelVersion: Eine Zeichenkette, die das Modell repräsentiert, das zur Klassifizierung eines Strings (wie des Hostnamens einer Webseite) in Themen-IDs verwendet wird.
taxonomyVersion: Eine Zeichenkette, die die verwendete Taxonomieversion 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 Taxonomie von Interessen).
version: Die configVersion, modelVersion und taxonomyVersion, mit Doppelpunkten (:) dazwischen verkettet.

Die genauen Eigenschaftswerte können je nach Browserimplementierung 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 untersagt ist.
Die aufrufende Seite die Topics API nicht in einem erfolgreichen Anmeldeprozess für die Privacy Sandbox aufgenommen hat.

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