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. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.
Warnung: Diese Funktion wird derzeit von zwei Browserherstellern abgelehnt. Siehe den Abschnitt Standards positions unten für Details zur Ablehnung.
Hinweis: Ein Anmeldeprozess ist erforderlich, um diese Funktion 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 Nutzer darstellen, jeweils 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 sorgt die Methode auch dafür, dass der Browser den aktuellen Seitenbesuch als vom Aufrufer beobachtet aufzeichnet, sodass der Hostname der Seite später in die Themenberechnung einbezogen werden kann.
Weitere Informationen 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 Topics API ermöglichenden Funktionen, ist aber etwas weniger leistungsfähig. Sie sollten eine der Funktionen verwenden, die HTTP-Header verwenden, und nur in Situationen, in denen die Header nicht modifiziert werden können, auf browsingTopics()
zurückgreifen.
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 keine Themen beobachtet, wennbrowsingTopics()
aufgerufen wird. Der Standardwert istfalse
, was das Beobachten von Themen verursacht.
Rückgabewert
Ein Promise
, das mit einem Array von bis zu drei Objekten erfüllt wird, die die ausgewählten Themen des aktuellen Nutzers für die letzten drei Epochen darstellen. Jedes Objekt enthält die folgenden Eigenschaften:
configVersion
-
Eine Zeichenkette, die den Algorithmus (außer dem Modellteil) identifiziert, der zur Berechnung des Themas verwendet wurde.
modelVersion
-
Eine Zeichenkette, die das Modell repräsentiert, das verwendet wird, um eine Zeichenkette (wie den Hostnamen einer Webseite) in Themen-IDs zu klassifizieren.
taxonomyVersion
-
Eine Zeichenkette, die die verwendete Taxonomieversion repräsentiert.
topic
-
Eine Zahl, die die ID des Themas darstellt, die vom Browser verwendet werden kann, um das Thema aus der Taxonomie abzurufen (siehe ein Beispiel Taxonomie der Interessen).
version
-
Die
configVersion
,modelVersion
undtaxonomyVersion
, jeweils durch Doppelpunkte (:
) zwischen den einzelnen Werten verkettet.
Die genauen Eigenschaftswerte können je nach Browser-Implementierung variieren. Ein Beispielobjekt aus 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 hat die Topics API nicht im Rahmen eines erfolgreichen Anmeldeprozesses für die Datenschutz-Sandbox enthalten.
- Die Nutzung der Topics API durch eine
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
Spezifikationen
Diese Funktion ist kein Teil eines offiziellen Standards, obwohl sie im Topics API Unofficial Proposal Draft spezifiziert wird.