GPT-Referenz

In dieser Referenz wird die TypeScript-Notation verwendet, um Typen zu beschreiben. Die folgende Tabelle enthält eine kurze Erläuterung anhand eines Beispiels.

Ausdruck eingeben
string	Der primitive Stringtyp.
string[]	Ein Array-Typ, bei dem Werte nur Strings sein dürfen.
number | string	Ein Union-Typ, bei dem der Wert entweder eine Zahl oder ein String sein kann.
Array<number | string>	Ein Array-Typ, bei dem die Werte ein komplexer (Union-)Typ sind.
[number, string]	Ein Tupeltyp, bei dem der Wert ein Array mit zwei Elementen ist, das eine Zahl und einen String in dieser Reihenfolge enthalten muss.
Slot	Ein Objekttyp, bei dem der Wert eine Instanz von googletag.Slot ist.
() => void	Ein Funktionstyp ohne definierte Argumente und ohne Rückgabewert.

Weitere Informationen zu unterstützten Typen und Typausdrücken finden Sie im TypeScript-Handbuch .

Typannotationen

Ein Doppelpunkt nach einer Variable, einem Parameternamen, einem Attributnamen oder einer Funktionssignatur kennzeichnet eine Typannotation. Typannotationen beschreiben die Typen, die das Element links vom Doppelpunkt akzeptieren oder zurückgeben kann. Die folgende Tabelle enthält Beispiele für Typannotationen, die Sie in dieser Referenz finden können.

Typannotation
param: string	Gibt an, dass param einen Stringwert akzeptiert oder zurückgibt. Diese Syntax wird für Variablen, Parameter, Attribute und Rückgabetypen verwendet.
param?: number | string	Gibt an, dass param optional ist, aber entweder eine Zahl oder einen String akzeptiert, wenn angegeben. Diese Syntax wird für Parameter und Properties verwendet.
...params: Array<() => void>	Gibt an, dass params ein Restparameter ist, der Funktionen akzeptiert. Restparameter akzeptieren eine unbegrenzte Anzahl von Werten des angegebenen Typs.

---

googletag

Der globale Namespace, den das Google Publisher-Tag für seine API verwendet.

Namespaces
config	Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.
enums	Dies ist der Namespace, den GPT für Enum-Typen verwendet.
events	Dies ist der Namespace, den GPT für Ereignisse verwendet.
secureSignals	Das ist der Namespace, den GPT zum Verwalten sicherer Signale verwendet.

Schnittstellen
CommandArray	Das Befehlsarray akzeptiert eine Sequenz von Funktionen und ruft sie der Reihe nach auf.
CompanionAdsService	Werbedienst für Companion-Anzeigen
PrivacySettingsConfig	Konfigurationsobjekt für Datenschutzeinstellungen.
PubAdsService	Publisher-Werbedienst
RequestHook	Callback-Funktion, die vor jeder Anzeigenanfrage aufgerufen wird, wenn sie über PubAdsService.registerRequestHook registriert wurde.
ResponseInformation	Ein Objekt, das eine einzelne Anzeigenantwort darstellt.
RewardedPayload	Ein Objekt, das die Prämie darstellt, die mit einer Anzeige mit Prämie verknüpft ist.
Service	Basisdienstklasse, die Methoden enthält, die für alle Dienste gelten.
SizeMappingBuilder	Builder für Spezifikationsobjekte für die Größenzuordnung.
Slot	„Slot“ ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt.

Typaliasse
FluidSize	Der Größenstring, bei dem der Anzeigencontainer 100% der Breite des übergeordneten div-Elements einnimmt und dann seine Höhe an den Creative-Inhalt anpasst.
GeneralSize	Eine gültige Größenkonfiguration für eine Anzeigenfläche, die eine oder mehrere Größen umfassen kann.
MultiSize	Eine Liste mit einzelnen gültigen Größen.
NamedSize	Benannte Größen, die eine Anzeigenfläche haben kann.
SingleSize	Eine einzelne gültige Größe für eine Anzeigenfläche.
SingleSizeArray	Array mit zwei Zahlen, die [Breite, Höhe] darstellen.
SizeMapping	Eine Zuordnung der Größe des Darstellungsbereichs zu den Anzeigengrößen.
SizeMappingArray	Eine Liste der Größenzuordnungen.

Variablen
apiReady	Flag, das angibt, dass die GPT API geladen ist und aufgerufen werden kann.
cmd	Verweis auf die globale Befehlswarteschlange für die asynchrone Ausführung von GPT-bezogenen Aufrufen.
pubadsReady	Flag, das angibt, dass PubAdsService aktiviert, geladen und voll funktionsfähig ist.
secureSignalProviders	Verweis auf das Array der Anbieter sicherer Signale.

Funktionen
companionAds	Gibt einen Verweis auf den CompanionAdsService zurück.
defineOutOfPageSlot	Erstellt eine Out-of-Page-Anzeigenfläche mit dem angegebenen Anzeigenblockpfad.
defineSlot	Erstellt eine Anzeigenfläche mit einem bestimmten Anzeigenblockpfad und einer bestimmten Größe und verknüpft sie mit der ID eines div-Elements auf der Seite, das die Anzeige enthalten soll.
destroySlots	Zerstört die angegebenen Anzeigenflächen und entfernt alle zugehörigen Objekte und Verweise dieser Anzeigenflächen aus GPT.
disablePublisherConsole	Deaktiviert die Google Publisher Console.
display	Weist Slot-Dienste an, den Slot zu rendern.
enableServices	Aktiviert alle GPT-Dienste, die für Anzeigenflächen auf der Seite definiert wurden.
getConfig	Ruft eine eingefrorene Kopie der allgemeinen Konfigurationsoptionen für die Seite ab, die von setConfig festgelegt wurden.
getVersion	Gibt die aktuelle Version von GPT zurück.
openConsole	Öffnet die Google Publisher Console.
pubads	Gibt einen Verweis auf den PubAdsService zurück.
setAdIframeTitle	Legt den Titel für alle Anzeigencontainer-iFrames fest, die ab diesem Zeitpunkt von PubAdsService erstellt werden.
setConfig	Legt allgemeine Konfigurationsoptionen für die Seite fest.
sizeMapping	Erstellt einen neuen SizeMappingBuilder.

Typaliasse

---

FluidSize

FluidSize: "fluid"

Der Größenstring, bei dem der Anzeigencontainer 100% der Breite des übergeordneten div-Elements einnimmt und dann seine Höhe an den Creative-Inhalt anpasst. Ähnlich wie sich reguläre Blockelemente auf einer Seite verhalten. Wird für native Anzeigen und Banneranzeigen verwendet (siehe Mehr zum Thema).

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Eine gültige Größenkonfiguration für eine Anzeigenfläche, die eine oder mehrere Größen umfassen kann.

---

MultiSize

MultiSize: SingleSize[]

Eine Liste mit einzelnen gültigen Größen.

---

NamedSize

NamedSize: FluidSize | [FluidSize]

Benannte Größen, die eine Anzeigenfläche haben kann. In den meisten Fällen ist die Größe ein Rechteck mit fester Größe, aber in einigen Fällen sind andere Arten von Größenangaben erforderlich. Nur die folgenden benannten Größen sind gültig:

• fluid: Der Anzeigencontainer nimmt 100% der Breite des übergeordneten div-Elements ein und passt dann seine Höhe an den Creative-Inhalt an. Ähnlich wie sich normale Blockelemente auf einer Seite verhalten. Wird für native Anzeigen und Banneranzeigen verwendet (siehe Mehr zum Thema). Sowohl fluid als auch ['fluid'] sind zulässige Formen, um eine Anzeigenflächengröße als flexibel zu deklarieren.

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Eine einzelne gültige Größe für eine Anzeigenfläche.

---

SingleSizeArray

SingleSizeArray: [number, number]

Array mit zwei Zahlen, die [Breite, Höhe] darstellen.

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Eine Zuordnung der Größe des Darstellungsbereichs zu den Anzeigengrößen. Wird für responsive Anzeigen verwendet.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Eine Liste der Größenzuordnungen.

Variablen

---

Const apiReady

apiReady: boolean | undefined

Flag, das angibt, dass die GPT API geladen ist und aufgerufen werden kann. Dieses Attribut ist einfach undefined, bis die API bereit ist.

Hinweis: Die empfohlene Methode für die asynchrone Verarbeitung ist die Verwendung von googletag.cmd, um Callbacks in die Warteschlange zu stellen, wenn GPT bereit ist. Bei diesen Callbacks muss googletag.apiReady nicht geprüft werden, da sie garantiert ausgeführt werden, sobald die API eingerichtet ist.

---

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray

Verweis auf die globale Befehlswarteschlange für die asynchrone Ausführung von GPT-bezogenen Aufrufen.

Die Variable googletag.cmd wird durch die GPT-Snippet-Syntax auf der Seite mit einem leeren JavaScript-Array initialisiert. cmd.push ist die Standardmethode Array.push, mit der ein Element am Ende des Arrays hinzugefügt wird. Wenn das GPT-JavaScript geladen wird, wird das Array durchsucht und alle Funktionen werden der Reihe nach ausgeführt. Das Skript ersetzt dann cmd durch ein CommandArray-Objekt, dessen Push-Methode so definiert ist, dass das an sie übergebene Funktionsargument ausgeführt wird. Dadurch kann GPT die wahrgenommene Latenz reduzieren, indem das JavaScript asynchron abgerufen wird, während der Browser die Seite weiter rendert.

Beispiel

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (alt)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

---

Const pubadsReady

pubadsReady: boolean | undefined

Flag, das angibt, dass PubAdsService aktiviert, geladen und voll funktionsfähig ist. Dieses Attribut ist einfach undefined, bis enableServices aufgerufen und PubAdsService geladen und initialisiert wird.

---

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

Verweis auf das Array der Anbieter sicherer Signale.

Das Array der Anbieter sicherer Signale akzeptiert eine Sequenz von signalgenerierenden Funktionen und ruft sie in der entsprechenden Reihenfolge auf. Es soll ein Standard-Array ersetzen, das verwendet wird, um signalgenerierende Funktionen in die Warteschlange zu stellen, die aufgerufen werden, sobald das GPT geladen ist.

Beispiel

JavaScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

JavaScript (alt)

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    return Promise.resolve("signal");
  },
});

TypeScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

Weitere Informationen

• Sichere Signale für Bieter freigeben

Funktionen

---

companionAds

companionAds(): CompanionAdsService

Gibt einen Verweis auf den CompanionAdsService zurück.

Ausgabe
CompanionAdsService	Der Companion-Anzeigendienst.

---

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null

Erstellt eine Out-of-Page-Anzeigenfläche mit dem angegebenen Anzeigenblockpfad.

Bei benutzerdefinierten Out-of-Page-Anzeigen ist div die ID des div-Elements, das die Anzeige enthalten wird. Weitere Informationen finden Sie im Artikel zu Out-of-Page-Creatives.

Für von GPT verwaltete Out-of-Page-Anzeigen ist div ein unterstütztes OutOfPageFormat.

Beispiel

JavaScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

JavaScript (alt)

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

TypeScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

Weitere Informationen

• Anzeige mit Prämie einblenden
• Web-Interstitial-Anzeige einblenden
• Ankeranzeige einblenden
• Out-of-Page-Anzeige einblenden

Parameter
adUnitPath: string	Vollständiger Anzeigenblockpfad mit dem Netzwerkcode und dem Anzeigenblockcode.
Optional div: string | OutOfPageFormat	ID des div-Elements, das diesen Anzeigenblock oder dieses Out-of-Page-Format enthält.

Ausgabe
Slot | null	Der neu erstellte Slot oder null, wenn kein Slot erstellt werden kann.

---

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null

Eine Anzeigenfläche mit einem bestimmten Anzeigenblockpfad und einer bestimmten Größe wird erzeugt und mit der ID eines div-Elements auf der Seite verknüpft, das die Anzeige enthalten wird.

Beispiel

JavaScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

JavaScript (alt)

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

Weitere Informationen

• Erste Schritte mit Google Publisher-Tags

Parameter
adUnitPath: string	Vollständiger Anzeigenblockpfad mit Netzwerkcode und Blockcode.
size: GeneralSize	Breite und Höhe der hinzugefügten Anzeigenfläche. Diese Größe wird in der Anzeigenanfrage verwendet, wenn keine responsive Größenzuordnung angegeben ist oder die Größe des Darstellungsbereichs kleiner als die kleinste in der Zuordnung angegebene Größe ist.
Optional div: string	ID des div-Elements, das diesen Anzeigenblock enthält.

Ausgabe
Slot | null	Der neu erstellte Slot oder null, wenn kein Slot erstellt werden kann.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Zerstört die angegebenen Anzeigenflächen und entfernt alle zugehörigen Objekte und Verweise dieser Anzeigenflächen aus GPT. Diese API unterstützt keine Passback- und Companion-Anzeigenflächen.

Wenn Sie diese API für eine Anzeigenfläche aufrufen, wird die Anzeige gelöscht und das Anzeigenflächenobjekt aus dem internen Status entfernt, der von GPT verwaltet wird. Wenn Sie weitere Funktionen für das Anzeigenflächenobjekt aufrufen, führt dies zu einem nicht definierten Verhalten. Beachten Sie, dass der Browser den mit dieser Anzeigenfläche verknüpften Arbeitsspeicher möglicherweise nicht freigibt, wenn auf der Publisher-Seite ein Verweis darauf beibehalten wird. Wenn Sie diese API aufrufen, wird das mit diesem Anzeigenflächen-Slot verknüpfte div-Element zur Wiederverwendung verfügbar gemacht.

Insbesondere wird durch das Löschen eines Anzeigenflächen-Slots die Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden also nicht durch Roadblocks oder Konkurrenzausschlüsse im Zusammenhang mit dieser Anzeige beeinflusst. Wenn diese Funktion nicht aufgerufen wird, bevor das Div eines Anzeigenflächen-Slots von der Seite entfernt wird, führt dies zu einem nicht definierten Verhalten.

Beispiel

JavaScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

JavaScript (alt)

// The calls to construct an ad and display contents.
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

TypeScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

Parameter
Optional slots: Slot[]	Das Array der zu zerstörenden Anzeigenflächen. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Anzeigenflächen gelöscht.

Ausgabe
boolean	true, wenn Anzeigenflächen gelöscht wurden, andernfalls false.

---

disablePublisherConsole

disablePublisherConsole(): void

Deaktiviert die Google Publisher Console.

Weitere Informationen

• Google Publisher Console

---

Display

display(divOrSlot: string | Element | Slot): void

Weist Slot-Dienste an, den Slot zu rendern. Jede Anzeigenfläche sollte nur einmal pro Seite angezeigt werden. Alle Slots müssen definiert und mit einem Dienst verknüpft sein, bevor sie angezeigt werden. Der Displayaufruf darf erst erfolgen, wenn das Element im DOM vorhanden ist. Dazu wird er normalerweise in einem Skriptblock innerhalb des div-Elements platziert, das im Methodenaufruf angegeben ist.

Wenn die Einzelanfrage-Architektur verwendet wird, werden alle Anzeigenflächen, die zum Zeitpunkt des Aufrufs dieser Methode noch nicht abgerufen wurden, auf einmal abgerufen. Wenn eine Anzeigenfläche nicht angezeigt werden soll, muss das gesamte div-Element entfernt werden.

Weitere Informationen

• Erste Schritte mit Google Publisher-Tags
• Testanzeige einblenden
• Laden und Aktualisieren von Anzeigen steuern

Parameter
divOrSlot: string | Element | Slot	Entweder die ID des div-Elements, das die Anzeigenfläche enthält, oder das div-Element oder das Anzeigenflächenobjekt. Wenn ein div-Element angegeben wird, muss es ein id-Attribut haben, das mit der ID übereinstimmt, die an defineSlot übergeben wurde.

---

enableServices

enableServices(): void

Aktiviert alle GPT-Dienste, die für Anzeigenflächen auf der Seite definiert wurden.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>

Ruft eine eingefrorene Kopie der allgemeinen Konfigurationsoptionen für die Seite ab, die von setConfig festgelegt wurden.

Nicht alle setConfig()-Eigenschaften werden von dieser Methode unterstützt. Unterstützte Properties:

• adsenseAttributes
• disableInitialLoad
• targeting

Beispiel

JavaScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

JavaScript (alt)

// Get the value of the `targeting` setting.
var targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
var config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

Parameter
keys: string | string[]	Die Schlüssel der abzurufenden Konfigurationsoptionen.

Ausgabe
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>	Eine eingefrorene Kopie der Konfigurationsoptionen für die Seite.

---

getVersion

getVersion(): string

Gibt die aktuelle Version von GPT zurück.

Weitere Informationen

• GPT-Versionsverlauf

Ausgabe
string	Der aktuell ausgeführte GPT-Versionsstring.

---

openConsole

openConsole(div?: string): void

Öffnet die Google Publisher Console.

Beispiel

JavaScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

JavaScript (alt)

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

TypeScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

Weitere Informationen

• Google Publisher Console

Parameter
Optional div: string	Eine div-ID für die Anzeigenfläche. Dieser Wert ist optional. Wenn Sie diese Option angeben, wird die Publisher Console mit den Details der angegebenen Anzeigenfläche geöffnet.

---

pubads

pubads(): PubAdsService

Gibt einen Verweis auf den PubAdsService zurück.

Ausgabe
PubAdsService	Der Publisher Ads-Dienst.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

Legt den Titel für alle Anzeigencontainer-iFrames fest, die ab diesem Zeitpunkt von PubAdsService erstellt werden.

Beispiel

JavaScript

googletag.setAdIframeTitle("title");

JavaScript (alt)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Parameter
title: string	Der neue Titel für alle iFrames von Anzeigencontainern.

---

setConfig

setConfig(config: PageSettingsConfig): void

Legt allgemeine Konfigurationsoptionen für die Seite fest.

Parameter
config: PageSettingsConfig

---

sizeMapping

sizeMapping(): SizeMappingBuilder

Erstellt einen neuen SizeMappingBuilder.

Weitere Informationen

• Anzeigengrößen: Responsive Anzeigen

Ausgabe
SizeMappingBuilder	Ein neuer Builder.

---

googletag.CommandArray

Das Befehlsarray akzeptiert eine Sequenz von Funktionen und ruft sie der Reihe nach auf. Es soll ein Standard-Array ersetzen, das verwendet wird, um Funktionen in die Warteschlange zu stellen, die aufgerufen werden, sobald das GPT geladen ist.

Methoden
push	Führt die in den Argumenten angegebene Sequenz von Funktionen in der angegebenen Reihenfolge aus.

Methoden

---

push

push(...f: ((this: typeof globalThis) => void)[]): number

Führt die in den Argumenten angegebene Funktionsfolge in der angegebenen Reihenfolge aus.

Beispiel

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (alt)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

Parameter
Rest ...f: ((this: typeof globalThis) => void)[]	Eine auszuführende JavaScript-Funktion. Die Laufzeitbindung ist immer globalThis. Sie können eine Pfeilfunktion übergeben, um den this-Wert des umschließenden lexikalischen Kontexts beizubehalten.

Ausgabe
number	Die Anzahl der bisher verarbeiteten Befehle. Dies ist mit dem Rückgabewert von Array.push (der aktuellen Länge des Arrays) kompatibel.

---

googletag.CompanionAdsService

Erweitert Service

Werbedienst für Companion-Anzeigen Dieser Dienst wird von Videoanzeigen verwendet, um Companion-Anzeigen einzublenden.

Methoden
addEventListener	Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite auftritt. Von der Methode Service.addEventListener übernommen
getSlots	Rufen Sie die Liste der Slots ab, die diesem Dienst zugeordnet sind. Von der Methode Service.getSlots übernommen
removeEventListener	Entfernt einen zuvor registrierten Listener. Von der Methode Service.removeEventListener übernommen
setRefreshUnfilledSlots	Legt fest, ob für Companion-Flächen, die nicht gefüllt wurden, automatisch ein Backfill durchgeführt wird.

Weitere Informationen

• Companion-Anzeigen für Video- und Audioplayer

Methoden

---

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Legt fest, ob für Companion-Flächen, die nicht gefüllt wurden, automatisch ein Backfill durchgeführt wird.

Diese Methode kann während der Lebensdauer der Seite mehrmals aufgerufen werden, um den Backfill zu aktivieren und zu deaktivieren. Nur Flächen, die auch beim PubAdsService registriert sind, werden mit Backfill gefüllt. Aufgrund von Richtlinieneinschränkungen ist diese Methode nicht dafür vorgesehen, leere Companion-Anzeigenflächen zu füllen, wenn ein Ad Exchange-Video ausgeliefert wird.

Beispiel

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (alt)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Parameter
value: boolean	true, um nicht gefüllte Slots automatisch zu füllen, false, um sie unverändert zu lassen.

---

googletag.PrivacySettingsConfig

Konfigurationsobjekt für Datenschutzeinstellungen.

Attribute
childDirectedTreatment?	Gibt an, ob die Seite als für Kinder ausgerichtet behandelt werden soll.
limitedAds?	Ermöglicht die Bereitstellung im Modus eingeschränktes Anzeigen-Targeting, um Publisher bei der Einhaltung regulatorischer Anforderungen zu unterstützen.
nonPersonalizedAds?	Ermöglicht die Auslieferung im Modus für nicht personalisierte Anzeigen, um Publisher bei der Einhaltung regulatorischer Anforderungen zu unterstützen.
restrictDataProcessing?	Ermöglicht die Bereitstellung im Modus für eingeschränkte Verarbeitung, um Publisher bei der Einhaltung regulatorischer Anforderungen zu unterstützen.
tagForAgeTreatment?	Die Alterskennzeichnung, die angibt, ob die Anzeigenanfrage als Inhalt für Kinder, Jugendliche oder nicht näher bezeichnete Nutzer behandelt werden soll.
trafficSource?	Gibt an, ob Anfragen gekauften oder organischen Traffic darstellen.
underAgeOfConsent?	Gibt an, ob Anzeigenanfragen als von Nutzern stammend gekennzeichnet werden sollen, die das gültige Mindestalter noch nicht erreicht haben.

Weitere Informationen

• Datenschutzeinstellungen konfigurieren

Attribute

---

Optional childDirectedTreatment

childDirectedTreatment?: boolean

Gibt an, ob die Seite als für Kinder ausgerichtet behandelt werden soll. Legen Sie null fest, um die Konfiguration zu löschen.

---

Optional limitedAds

limitedAds?: boolean

Ermöglicht die Bereitstellung im Modus Eingeschränkte Anzeigen, um Publisher bei der Einhaltung regulatorischer Anforderungen zu unterstützen.

Sie können GPT auf zwei Arten anweisen, eingeschränkte Anzeigen anzufordern:

• Automatisch, indem ein Signal von einer Plattform zur Einwilligungsverwaltung verwendet wird, die das IAB TCF 2.0 unterstützt.
• Manuell, indem Sie den Wert dieses Felds auf true setzen.

Die manuelle Konfiguration der eingeschränkten Anzeigenausrichtung ist nur möglich, wenn GPT über die URL für die eingeschränkte Anzeigenausrichtung geladen wird. Wenn Sie versuchen, diese Einstellung zu ändern, wenn GPT über die Standard-URL geladen wurde, wird eine Warnung in der Publisher Console generiert.

Hinweis: Wenn eine CMP verwendet wird, ist es nicht erforderlich, eingeschränkte Anzeigen manuell zu aktivieren.

Beispiel

JavaScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

JavaScript (alt)

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

TypeScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

Weitere Informationen

• Eingeschränkte Anzeige ausliefern

---

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

Ermöglicht die Auslieferung im Modus für nicht personalisierte Anzeigen, um Publisher bei der Einhaltung regulatorischer Anforderungen zu unterstützen.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Ermöglicht die Bereitstellung im Modus für eingeschränkte Verarbeitung, um Publisher bei der Einhaltung regulatorischer Anforderungen zu unterstützen.

---

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

Die Alterskennzeichnung, die angibt, ob die Anzeigenanfrage als Inhalt für Kinder, Jugendliche oder nicht näher bezeichnete Nutzer behandelt werden soll.

Lassen Sie sich von Ihrem Rechtsbeistand beraten, um die Einstellungen für die Alterskennzeichnung für Ihre Nutzer basierend auf Ihren rechtlichen und regulatorischen Anforderungen festzulegen. Weitere Informationen zu dieser Einstellung finden Sie in diesem Hilfeartikel.

Durch Festlegen dieser Property bestätigen Sie, dass diese Benachrichtigung korrekt ist und Sie berechtigt sind, im Namen des Websiteinhabers zu handeln. Ihnen ist bewusst, dass jeglicher Missbrauch dieser Einstellung zu einer Schließung Ihres Google-Kontos führen kann.

Beispiel

JavaScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

JavaScript (alt)

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

TypeScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

---

Optional trafficSource

trafficSource?: TrafficSource

Gibt an, ob Anfragen gekauften oder organischen Traffic darstellen. Dieser Wert wird in Ad Manager-Berichten für die Dimension Traffic-Quelle verwendet. Wenn nichts anderes festgelegt ist, wird in Berichten standardmäßig undefined als Traffic-Quelle verwendet.

Beispiel

JavaScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

JavaScript (alt)

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

TypeScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

---

Optional underAgeOfConsent

underAgeOfConsent?: boolean

Gibt an, ob Anzeigenanfragen als von Nutzern stammend gekennzeichnet werden sollen, die das gültige Mindestalter noch nicht erreicht haben. Legen Sie null fest, um die Konfiguration zu löschen.

---

googletag.PubAdsService

Erweitert Service

Publisher-Werbedienst Mit diesem Dienst werden Anzeigen aus Ihrem Google Ad Manager-Konto abgerufen und ausgeliefert.

Methoden
addEventListener	Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite auftritt. Von der Methode Service.addEventListener übernommen
clear	Entfernt die Anzeigen aus den angegebenen Anzeigenflächen und ersetzt sie durch leere Inhalte.
clearCategoryExclusions	Eingestellt. Alle Anzeigenkategorie-Ausschlusslabels auf Seitenebene werden gelöscht.
clearTargeting	Eingestellt. Löscht benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel.
collapseEmptyDivs	Eingestellt. Aktiviert die Minimierung von Anzeigenflächen-Divs, damit sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt vorhanden ist.
disableInitialLoad	Eingestellt. Anfragen für Anzeigen beim Seitenaufbau werden deaktiviert, Anzeigen können aber mit einem PubAdsService.refresh-Aufruf angefordert werden.
display	Erstellt eine Anzeigenfläche mit dem angegebenen Anzeigenblockpfad und der angegebenen Größe und zeigt sie an.
enableLazyLoad	Eingestellt. Aktiviert das Lazy Loading in GPT, wie im Konfigurationsobjekt definiert.
enableSingleRequest	Eingestellt. Aktiviert den Einzelanfrage-Modus, um mehrere Anzeigen gleichzeitig abzurufen.
enableVideoAds	Eingestellt. Signalisiert GPT, dass auf der Seite Videoanzeigen vorhanden sind.
get	Eingestellt. Gibt den Wert für das AdSense-Attribut zurück, das dem angegebenen Schlüssel zugeordnet ist.
getAttributeKeys	Eingestellt. Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden.
getSlots	Rufen Sie die Liste der Slots ab, die diesem Dienst zugeordnet sind. Von der Methode Service.getSlots übernommen
getTargeting	Eingestellt. Gibt einen bestimmten benutzerdefinierten Targeting-Parameter auf Dienstebene zurück, der festgelegt wurde.
getTargetingKeys	Eingestellt. Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden.
isInitialLoadDisabled	Eingestellt. Gibt zurück, ob die ersten Anzeigenanfragen durch einen vorherigen PubAdsService.disableInitialLoad-Aufruf erfolgreich deaktiviert wurden.
refresh	Ruft neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite ab und zeigt sie an.
registerRequestHook	Registriert einen Hook, der parallel zu anderen registrierten Hooks vor jeder Anzeigenanfrage auf der Seite innerhalb eines globalen Zeitlimits ausgeführt wird.
removeEventListener	Entfernt einen zuvor registrierten Listener. Von der Methode Service.removeEventListener übernommen
set	Eingestellt. Legt Werte für AdSense-Attribute fest, die für alle Anzeigenflächen im Publisher Ads-Dienst gelten.
setCategoryExclusion	Eingestellt. Legt einen Ausschluss der Anzeigenkategorie auf Seitenebene für den angegebenen Labelnamen fest.
setCentering	Eingestellt. Aktiviert und deaktiviert die horizontale Zentrierung von Anzeigen.
setForceSafeFrame	Eingestellt. Damit wird konfiguriert, ob alle Anzeigen auf der Seite mithilfe eines SafeFrame-Containers gerendert werden sollen.
setLocation	Eingestellt. Standortinformationen von Websites werden weitergegeben, damit Sie Werbebuchungen auf bestimmte Standorte ausrichten können.
setPrivacySettings	Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzige API mithilfe eines Konfigurationsobjekts.
setPublisherProvidedId	Legt den Wert für die vom Publisher bereitgestellte ID fest.
setSafeFrameConfig	Eingestellt. Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest.
setTargeting	Eingestellt. Legt benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel fest, die für alle Anzeigenflächen des Publisher Ads-Dienstes gelten.
setVideoContent	Eingestellt. Legt die Informationen zu Videoinhalten fest, die zusammen mit den Anzeigenanfragen für die Ausrichtung und den Ausschluss von Inhalten gesendet werden sollen.
updateCorrelator	Ändert den Korrelator, der mit Anzeigenanfragen gesendet wird, und startet so einen neuen Seitenaufruf.

Methoden

---

clear

clear(slots?: Slot[]): boolean

Entfernt die Anzeigen aus den angegebenen Anzeigenflächen und ersetzt sie durch leere Inhalte. Die Anzeigenflächen werden als nicht abgerufen markiert.

Insbesondere wird durch das Löschen einer Anzeigenfläche die Anzeige aus dem langlebigen Seitenaufruf des GPT entfernt, sodass zukünftige Anfragen nicht durch Roadblocks oder Konkurrenzausschlüsse im Zusammenhang mit dieser Anzeige beeinflusst werden.

Beispiel

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

JavaScript (alt)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

Parameter
Optional slots: Slot[]	Das Array der zu löschenden Anzeigenflächen. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Anzeigenflächen gelöscht.

Ausgabe
boolean	Gibt true zurück, wenn Slots gelöscht wurden, andernfalls false.

---

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Löscht alle Labels für den Ausschluss von Anzeigenkategorien auf Seitenebene. Das ist nützlich, wenn Sie die Anzeigenfläche aktualisieren möchten.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.categoryExclusion.

Beispiel

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

JavaScript (alt)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

Weitere Informationen

• Benutzerdefinierte Labels zum Blockieren von Anzeigen

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

clearTargeting

clearTargeting(key?: string): PubAdsService

Löscht benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.targeting.

Beispiel

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript (alt)

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Weitere Informationen

• Targeting auf Schlüssel/Wert-Paare

Parameter
Optional key: string	Targeting-Parameterschlüssel. Der Schlüssel ist optional. Wenn er nicht angegeben ist, werden alle Targeting-Parameter gelöscht.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Aktiviert das Minimieren von Anzeigenflächen-Divs, damit sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt vorhanden ist. Dieser Modus muss festgelegt werden, bevor der Dienst aktiviert wird.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.collapseDiv.

Weitere Informationen

• Leere Anzeigenflächen minimieren
• Layoutverschiebungen minimieren

Parameter
Optional collapseBeforeAdFetch: boolean	Gibt an, ob die Anzeigenflächen auch vor dem Abrufen der Anzeigen minimiert werden sollen. Dieser Parameter ist optional. Wenn er nicht angegeben wird, wird false als Standardwert verwendet.

Ausgabe
boolean	Gibt true zurück, wenn der Modus zum Minimieren von Div-Elementen aktiviert wurde, und false, wenn der Modus zum Minimieren nicht aktiviert werden kann, weil die Methode nach der Aktivierung des Dienstes aufgerufen wurde.

---

disableInitialLoad

disableInitialLoad(): void

Deaktiviert Anfragen für Anzeigen beim Seitenaufbau, ermöglicht aber das Anfordern von Anzeigen mit einem PubAdsService.refresh-Aufruf. Dies sollte vor der Aktivierung des Dienstes festgelegt werden. Der asynchrone Modus muss verwendet werden, da es sonst nicht möglich ist, Anzeigen mit refresh anzufordern.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.disableInitialLoad.

Weitere Informationen

• Laden und Aktualisieren von Anzeigen steuern
• SRA-Batching steuern

---

Display

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void

Erstellt eine Anzeigenfläche mit dem angegebenen Anzeigenblockpfad und der angegebenen Größe und zeigt sie an.

Diese Methode ist eine Kurzform für den Aufruf von googletag.defineSlot, gefolgt von googletag.display.

Das Verhalten dieser Methode hängt davon ab, ob die Einzelanfrage-Architektur (SRA) aktiviert ist:

• Einzelanfrage-Architektur aktiviert:Alle bis zu diesem Aufruf definierten Anzeigenflächen werden zusammengefasst und gemeinsam angefordert.
• Einzelanfrage-Architektur deaktiviert (Standardeinstellung): Die Anzeigenfläche wird einzeln angefragt.

Hinweis: Wenn diese Methode aufgerufen wird, wird ein Snapshot des Anzeigenflächen- und Seitenstatus erstellt, um die Konsistenz beim Senden der Anzeigenanfrage und beim Rendern der Antwort zu gewährleisten. Alle Änderungen, die nach dem Aufruf dieser Methode am Anzeigenflächen- oder Seitenstatus vorgenommen werden (einschließlich Targeting, Datenschutzeinstellungen, SafeFrame erzwingen usw.), gelten nur für nachfolgende display()- oder refresh()-Anfragen.

Beispiel

JavaScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

JavaScript (alt)

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

Weitere Informationen

• Testanzeige einblenden
• Laden und Aktualisieren von Anzeigen steuern

Parameter
adUnitPath: string	Der Anzeigenblockpfad der zu rendernden Anzeigenfläche.
size: GeneralSize	Breite und Höhe der Anzeigenfläche.
Optional div: string | Element	Entweder die ID des div-Elements, das die Anzeigenfläche enthält, oder das div-Element selbst.
Optional clickUrl: string	Die Klick-URL, die für diesen Anzeigenflächen-Slot verwendet werden soll.

---

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void

Aktiviert Lazy Loading in GPT, wie im Konfigurationsobjekt definiert. Ausführlichere Beispiele finden Sie im Beispiel für Lazy Loading.

Hinweis: Lazy Fetching in der Einzelanfrage-Architektur funktioniert nur, wenn sich alle Anzeigenflächen außerhalb des Abrufrands befinden.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.lazyLoad.

Beispiel

JavaScript

googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

JavaScript (alt)

googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

TypeScript

googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

Weitere Informationen

• Best Practices für Anzeigen: „Wichtige“ Anzeigenflächen priorisieren
• Lazy Loading

Parameter

Optional config: {   fetchMarginPercent?: number;   mobileScaling?: number;   renderMarginPercent?: number; }

Das Konfigurationsobjekt ermöglicht die Anpassung des Lazy-Verhaltens. Für alle nicht angegebenen Konfigurationen wird ein von Google festgelegter Standardwert verwendet, der im Laufe der Zeit angepasst wird. Wenn Sie eine bestimmte Einstellung deaktivieren möchten, z. B. eine Abrufmarge, setzen Sie den Wert auf -1. fetchMarginPercent Der Mindestabstand, den eine Anzeigenfläche vom aktuellen Darstellungsbereich haben muss, bevor die Anzeige abgerufen wird, als Prozentsatz der Größe des Darstellungsbereichs. Der Wert 0 bedeutet „wenn die Anzeigenfläche den Darstellungsbereich erreicht“, 100 bedeutet „wenn die Anzeige einen Darstellungsbereich entfernt ist“ usw. renderMarginPercent Der Mindestabstand, den eine Anzeigenfläche vom aktuellen Darstellungsbereich haben muss, bevor eine Anzeige gerendert wird. So kann die Anzeige vorab abgerufen werden, während das Rendern und Herunterladen anderer Unterressourcen verzögert wird. Der Wert funktioniert genau wie fetchMarginPercent als Prozentsatz des Darstellungsbereichs. mobileScaling Ein Multiplikator, der auf die Ränder auf Mobilgeräten angewendet wird. So können Sie auf Mobilgeräten und Computern unterschiedliche Margen festlegen. Bei einem Wert von 2, 0 werden beispielsweise alle Ränder auf Mobilgeräten mit 2 multipliziert.Dadurch wird der Mindestabstand vergrößert, den eine Anzeigenfläche vor dem Abrufen und Rendern haben kann.

---

enableSingleRequest

enableSingleRequest(): boolean

Aktiviert den Einzelanfrage-Modus, um mehrere Anzeigen gleichzeitig abzurufen. Dazu müssen alle Publisher-Anzeigenflächen definiert und dem PubAdsService hinzugefügt werden, bevor der Dienst aktiviert wird. Der Einzelanfrage-Modus muss festgelegt werden, bevor der Dienst aktiviert wird.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.singleRequest.

Weitere Informationen

• Best Practices für Anzeigen: Einzelanfrage-Architektur richtig verwenden
• SRA-Batching steuern

Ausgabe
boolean	Gibt true zurück, wenn der Einzelanfrage-Modus aktiviert wurde, und false, wenn der Einzelanfrage-Modus nicht aktiviert werden kann, weil die Methode nach der Aktivierung des Dienstes aufgerufen wurde.

---

enableVideoAds

enableVideoAds(): void

Signalisiert GPT, dass auf der Seite Videoanzeigen vorhanden sind. Dadurch werden Einschränkungen für Konkurrenzausschlüsse für Display- und Videoanzeigen aktiviert. Wenn der Videoinhalt bekannt ist, rufen Sie PubAdsService.setVideoContent auf, um den Ausschluss von Inhalten für Displayanzeigen zu verwenden.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.videoAds.

---

get

get(key: string): string

Gibt den Wert für das AdSense-Attribut zurück, das dem angegebenen Schlüssel zugeordnet ist.

Eingestellt: Verwenden Sie stattdessen googletag.getConfig.

Beispiel

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript (alt)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Weitere Informationen

• AdSense-Attribute

Parameter
key: string	Name des Attributs, nach dem gesucht werden soll.

Ausgabe
string	Aktueller Wert für den Attributschlüssel oder null, wenn der Schlüssel nicht vorhanden ist.

---

getAttributeKeys

getAttributeKeys(): string[]

Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden.

Eingestellt: Verwenden Sie stattdessen googletag.getConfig.

Beispiel

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript (alt)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

Ausgabe
string[]	Array von Attributschlüsseln, die für diesen Dienst festgelegt sind. Die Reihenfolge ist nicht definiert.

---

getTargeting

getTargeting(key: string): string[]

Gibt einen bestimmten benutzerdefinierten Targeting-Parameter auf Dienstebene zurück, der festgelegt wurde.

Eingestellt: Verwenden Sie stattdessen googletag.getConfig.

Beispiel

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript (alt)

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["interests"]) || [];
// Returns ['sports'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

Parameter
key: string	Der gesuchte Targeting-Schlüssel.

Ausgabe
string[]	Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn kein solcher Schlüssel vorhanden ist.

---

getTargetingKeys

getTargetingKeys(): string[]

Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden.

Eingestellt: Verwenden Sie stattdessen googletag.getConfig.

Beispiel

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

JavaScript (alt)

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

Ausgabe
string[]	Array von Targeting-Schlüsseln. Die Reihenfolge ist nicht definiert.

---

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Gibt zurück, ob die ersten Anzeigenanfragen durch einen vorherigen PubAdsService.disableInitialLoad-Aufruf deaktiviert wurden.

Eingestellt: Verwenden Sie stattdessen googletag.getConfig.

Ausgabe
boolean	Gibt true zurück, wenn ein vorheriger Aufruf von PubAdsService.disableInitialLoad erfolgreich war, andernfalls false.

---

refresh

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void

Ruft neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite ab und zeigt sie an. Funktioniert nur im asynchronen Rendering-Modus.

Damit die Funktion in allen Browsern ordnungsgemäß funktioniert, muss vor dem Aufruf von refresh die Anzeigenfläche mit display aufgerufen werden. Wenn der Aufruf von display weggelassen wird, kann es zu unerwartetem Verhalten bei der Aktualisierung kommen. Bei Bedarf kann die Methode PubAdsService.disableInitialLoad verwendet werden, um zu verhindern, dass display eine Anzeige abruft.

Wenn ein Slot aktualisiert wird, wird die alte Anzeige aus der langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden also nicht durch Roadblocks oder Konkurrenzausschlüsse im Zusammenhang mit dieser Anzeige beeinflusst.

Beispiel

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

JavaScript (alt)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

Weitere Informationen

• Laden und Aktualisieren von Anzeigen steuern
• Anzeigenflächen aktualisieren

Parameter
Optional slots: Slot[]	Die zu aktualisierenden Anzeigenflächen. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Anzeigenflächen aktualisiert.
Optional options: {   changeCorrelator: boolean; }	Konfigurationsoptionen, die mit diesem Aktualisierungsaufruf verknüpft sind. changeCorrelator Gibt an, ob ein neuer Korrelator zum Abrufen von Anzeigen generiert werden soll. Unsere Ad-Server speichern diesen Korrelatorwert für kurze Zeit (derzeit 30 Sekunden, kann sich aber ändern). Anfragen mit demselben Korrelator, die kurz nacheinander eingehen, werden als ein einziger Seitenaufruf betrachtet. Standardmäßig wird bei jeder Aktualisierung ein neuer Korrelator generiert. Hinweis: Diese Option hat keine Auswirkungen auf den langlebigen Seitenaufruf des GPT, der automatisch die Anzeigen widerspiegelt, die sich derzeit auf der Seite befinden, und keine Ablaufzeit hat.

---

registerRequestHook

registerRequestHook(hook: RequestHook, hookId: string): (() => void)

Experimental Registriert einen Hook, der parallel zu anderen registrierten Hooks vor jeder Anzeigenanfrage auf der Seite innerhalb eines globalen Zeitlimits ausgeführt wird.

Beispiel

JavaScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

JavaScript (alt)

// Coming soon.

TypeScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

Parameter
hook: RequestHook	Eine Funktion, die ein Objekt mit der Liste der angeforderten Anzeigenflächen verwendet und ein Promise zurückgibt, das aufgelöst wird, sobald alle asynchronen Aktionen abgeschlossen sind.
hookId: string	Eine ID, um den Hook für eine bessere Diagnose zu kennzeichnen.

Ausgabe
(() => void)	Eine Funktion zum Abmelden des Hooks.

---

set

set(key: string, value: string): PubAdsService

Legt Werte für AdSense-Attribute fest, die für alle Anzeigenflächen im Publisher Ads-Dienst gelten.

Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen vor dem Aufruf von display oder refresh festgelegt werden.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.adsenseAttributes.

Beispiel

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

JavaScript (alt)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

Weitere Informationen

• AdSense-Attribute

Parameter
key: string	Der Name des Attributs.
value: string	Attributwert.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

Legt einen Ausschluss der Anzeigenkategorie auf Seitenebene für den angegebenen Labelnamen fest.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.categoryExclusion.

Beispiel

JavaScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

JavaScript (alt)

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

TypeScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

Weitere Informationen

• Benutzerdefinierte Labels zum Blockieren von Anzeigen

Parameter
categoryExclusion: string	Das Label für den Ausschluss von Anzeigenkategorien, das hinzugefügt werden soll.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

setCentering

setCentering(centerAds: boolean): void

Aktiviert und deaktiviert die horizontale Zentrierung von Anzeigen. Die Zentrierung ist standardmäßig deaktiviert. In der alten gpt_mobile.js ist die Zentrierung standardmäßig aktiviert.

Diese Methode sollte vor dem Aufruf von display oder refresh aufgerufen werden, da nur Anzeigen zentriert werden, die nach dem Aufruf dieser Methode angefordert werden.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.centering.

Beispiel

JavaScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

JavaScript (alt)

// Make ads centered.
googletag.setConfig({
  centering: true,
});

TypeScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

Parameter
centerAds: boolean	true, um Anzeigen zu zentrieren, und false, um sie linksbündig auszurichten.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Konfiguriert, ob alle Anzeigen auf der Seite mithilfe eines SafeFrame-Containers gerendert werden sollen.

Beachten Sie bei der Verwendung dieser API Folgendes:

• Diese Einstellung wird nur für nachfolgende Anzeigenanfragen für die entsprechenden Anzeigenflächen wirksam.
• Die Einstellung auf Anzeigenflächenebene überschreibt immer die Einstellung auf Seitenebene, sofern sie angegeben ist.
• Wenn der Wert auf true festgelegt ist (auf Anzeigenflächen- oder Seitenebene), wird die Anzeige immer mit einem SafeFrame-Container gerendert, unabhängig von der Auswahl in der Google Ad Manager-Benutzeroberfläche.
• Wenn der Wert jedoch auf false festgelegt oder nicht angegeben ist, wird die Anzeige je nach Creative-Typ und der in der Google Ad Manager-Benutzeroberfläche getroffenen Auswahl in einem SafeFrame-Container gerendert.
• Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken kann, die versuchen, aus ihren iFrames auszubrechen, oder die darauf angewiesen sind, dass sie direkt auf der Seite eines Publishers gerendert werden.

Verworfen: Verwenden Sie stattdessen PageSettingsConfig.safeFrame.

Beispiel

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (alt)

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      forceSafeFrame: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Weitere Informationen

• Creatives mit SafeFrame rendern

Parameter
forceSafeFrame: boolean	true, um zu erzwingen, dass alle Anzeigen auf der Seite in SafeFrames gerendert werden, und false, um die vorherige Einstellung in „false“ zu ändern. Wenn Sie diesen Wert auf false setzen, obwohl er zuvor nicht angegeben wurde, ändert sich nichts.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

setLocation

setLocation(address: string): PubAdsService

Übergibt Standortinformationen von Websites, damit Sie Werbebuchungen auf bestimmte Standorte ausrichten können.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.location.

Beispiel

JavaScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

JavaScript (alt)

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

TypeScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

Parameter
address: string	Adresse im freien Format.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzige API mithilfe eines Konfigurationsobjekts.

Beispiel

JavaScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

JavaScript (alt)

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

TypeScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

Weitere Informationen

• Datenschutzeinstellungen konfigurieren
• Eingeschränkte Anzeige ausliefern

Parameter
privacySettings: PrivacySettingsConfig	Objekt mit der Konfiguration der Datenschutzeinstellungen.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Funktion aufgerufen wurde.

---

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Legt den Wert für die vom Publisher bereitgestellte ID fest.

Beispiel

JavaScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

JavaScript (alt)

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

Weitere Informationen

• PPIDs (Publisher Provided Identifiers)

Parameter
ppid: string	Eine vom Publisher bereitgestellte alphanumerische ID. Muss zwischen 22 und 150 Zeichen lang sein.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest. Unbekannte Schlüssel im Konfigurationsobjekt werden ignoriert. Die gesamte Konfiguration wird ignoriert, wenn für einen erkannten Schlüssel ein ungültiger Wert übergeben wird.

Diese Einstellungen auf Seitenebene werden durch Einstellungen auf Anzeigenflächenebene überschrieben, sofern angegeben.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.safeFrame.

Beispiel

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (alt)

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Weitere Informationen

• Creatives mit SafeFrame rendern

Parameter
config: SafeFrameConfig	Das Konfigurationsobjekt.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService

Legt benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel fest, die für alle Anzeigenflächen des Werbedienstes gelten. Wenn Sie diese Funktion mehrmals für denselben Schlüssel aufrufen, werden alte Werte überschrieben. Diese Schlüssel sind in Ihrem Google Ad Manager-Konto definiert.

Veraltet: Verwenden Sie stattdessen PageSettingsConfig.targeting.

Beispiel

JavaScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

JavaScript (alt)

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

Weitere Informationen

• Targeting auf Schlüssel/Wert-Paare

Parameter
key: string	Targeting-Parameterschlüssel.
value: string | string[]	Wert oder Array von Werten für den Targeting-Parameter.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void

Legt die Informationen zu Videoinhalten fest, die zusammen mit den Anzeigenanfragen für die Ausrichtung und den Ausschluss von Inhalten gesendet werden sollen. Videoanzeigen werden automatisch aktiviert, wenn diese Methode aufgerufen wird. Verwenden Sie für videoContentId und videoCmsId die Werte, die für den Dienst zur Contentaufnahme in Google Ad Manager bereitgestellt werden.

Eingestellt: Verwenden Sie stattdessen PageSettingsConfig.videoAds.

Weitere Informationen

• URL-Parameter für VAST-Anzeigen-Tags

Parameter
videoContentId: string	Die ID des Videoinhalts.
videoCmsId: string	Die CMS-ID des Videos.

---

updateCorrelator

updateCorrelator(): PubAdsService

Ändert den Korrelator, der mit Anzeigenanfragen gesendet wird, und startet so einen neuen Seitenaufruf. Der Korrelator ist für alle Anzeigenanfragen eines Seitenaufrufs immer gleich und für alle Seitenaufrufe eindeutig. Gilt nur für den asynchronen Modus.

Hinweis: Dies hat keine Auswirkungen auf die langlebige Seitenaufruf-ID von GPT, die automatisch die Anzeigen auf der Seite widerspiegelt und keine Ablaufzeit hat.

Beispiel

JavaScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

JavaScript (alt)

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

TypeScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

Ausgabe
PubAdsService	Das Dienstobjekt, für das die Funktion aufgerufen wurde.

---

googletag.RequestHook

Callback-Funktion, die vor jeder Anzeigenanfrage aufgerufen wird, wenn sie über PubAdsService.registerRequestHook registriert wurde.

---

googletag.ResponseInformation

Ein Objekt, das eine einzelne Anzeigenantwort darstellt.

Attribute
advertiserId	Die ID des Werbetreibenden.
campaignId	Die ID der Kampagne.
creativeId	Die ID des Creatives.
creativeTemplateId	Die Vorlagen-ID der Anzeige.
lineItemId	Die ID der Werbebuchung.

Weitere Informationen

• Slot.getResponseInformation

Attribute

---

advertiserId

advertiserId: number

Die ID des Werbetreibenden.

---

campaignId

campaignId: number

Die ID der Kampagne.

---

creativeId

creativeId: number

Die ID des Creatives.

---

creativeTemplateId

creativeTemplateId: number

Die Vorlagen-ID der Anzeige.

---

lineItemId

lineItemId: number

Die ID der Werbebuchung.

---

googletag.RewardedPayload

Ein Objekt, das die Prämie darstellt, die mit einer Anzeige mit Prämie verknüpft ist.

Attribute
amount	Die Anzahl der Artikel, die in der Prämie enthalten sind.
type	Der Typ des Elements, das in der Prämie enthalten ist (z. B. „Münze“).

Weitere Informationen

• Anzeige mit Prämie einblenden

Attribute

---

amount

amount: number

Die Anzahl der Artikel, die in der Prämie enthalten sind.

---

type

type: string

Der Typ des Elements, das in der Prämie enthalten ist, z. B. „Münze“.

---

googletag.Service

Basisdienstklasse, die Methoden enthält, die für alle Dienste gelten.

Methoden
addEventListener	Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite auftritt.
getSlots	Rufen Sie die Liste der Slots ab, die diesem Dienst zugeordnet sind.
removeEventListener	Entfernt einen zuvor registrierten Listener.

Methoden

---

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service

Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite auftritt. Die folgenden Ereignisse werden unterstützt:

• events.GameManualInterstitialSlotClosedEvent
• events.GameManualInterstitialSlotReadyEvent
• events.ImpressionViewableEvent
• events.RewardedSlotClosedEvent
• events.RewardedSlotGrantedEvent
• events.RewardedSlotReadyEvent
• events.SlotOnloadEvent
• events.SlotRenderEndedEvent
• events.SlotRequestedEvent
• events.SlotResponseReceived
• events.SlotVisibilityChangedEvent

Ein Objekt des entsprechenden Ereignistyps wird an den Listener übergeben, wenn er aufgerufen wird.

Beispiel

JavaScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (alt)

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

Weitere Informationen

• Anzeigenereignis-Listener

Parameter
eventType: K	Ein String, der den Typ des von GPT generierten Ereignisses darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet.
listener: ((arg: EventTypeMap[K]) => void)	Funktion, die ein einzelnes Ereignisobjektargument akzeptiert.

Ausgabe
Service	Das Dienstobjekt, für das die Methode aufgerufen wurde.

---

getSlots

getSlots(): Slot[]

Rufen Sie die Liste der Slots ab, die diesem Dienst zugeordnet sind.

Ausgabe
Slot[]	Slots in der Reihenfolge, in der sie dem Dienst hinzugefügt wurden.

---

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void

Entfernt einen zuvor registrierten Listener.

Beispiel

JavaScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

JavaScript (alt)

googletag.cmd.push(function () {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  var onViewableListener = function (event) {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(function () {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

TypeScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag
    .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
    .addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

Parameter
eventType: K	Ein String, der den Typ des von GPT generierten Ereignisses darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet.
listener: ((event: EventTypeMap[K]) => void)	Funktion, die ein einzelnes Ereignisobjektargument akzeptiert.

---

googletag.SizeMappingBuilder

Builder für Spezifikationsobjekte für die Größenzuordnung. Dieser Builder wird bereitgestellt, um die Erstellung von Größenspezifikationen zu vereinfachen.

Methoden
addSize	Fügt eine Zuordnung von einem Array mit einer einzelnen Größe (Darstellungsbereich) zu einem Array mit einer oder mehreren Größen (Anzeigenfläche) hinzu.
build	Erstellt eine Spezifikation für die Größenzuordnung aus den Zuordnungen, die diesem Builder hinzugefügt wurden.

Weitere Informationen

• Anzeigengrößen: Responsive Anzeigen

Methoden

---

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder

Fügt eine Zuordnung von einem Array mit einer einzelnen Größe (das den Darstellungsbereich darstellt) zu einem Array mit einer oder mehreren Größen hinzu, das die Anzeigenfläche darstellt.

Beispiel

JavaScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

JavaScript (alt)

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

TypeScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

Parameter
viewportSize: SingleSizeArray	Die Größe des Darstellungsbereichs für diesen Zuordnungseintrag.
slotSize: GeneralSize	Die Größen der Anzeigenfläche für diesen Zuordnungseintrag.

Ausgabe
SizeMappingBuilder	Eine Referenz auf diesen Builder.

---

build

build(): SizeMappingArray

Erstellt eine Größenzuordnungsspezifikation aus den Zuordnungen, die diesem Builder hinzugefügt wurden.

Wenn ungültige Zuordnungen angegeben wurden, gibt diese Methode null zurück. Andernfalls wird eine Spezifikation im richtigen Format zurückgegeben, die an Slot.defineSizeMapping übergeben werden kann.

Hinweis: Das Verhalten des Builders nach dem Aufruf dieser Methode ist nicht definiert.

Ausgabe
SizeMappingArray	Das von diesem Builder erstellte Ergebnis. Kann null sein, wenn ungültige Größenzuordnungen angegeben wurden.

---

googletag.Slot

„Slot“ ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt.

Methoden
addService	Fügt diesem Slot einen Dienst hinzu.
clearCategoryExclusions	Eingestellt. Alle Ausschlusslabels für Anzeigenkategorien auf Ebene der Anzeigenfläche werden für diese Anzeigenfläche gelöscht.
clearTargeting	Eingestellt. Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Anzeigenflächenebene für diese Anzeigenfläche.
defineSizeMapping	Legt ein Array von Zuordnungen von einer Mindestgröße des Darstellungsbereichs zur Anzeigenflächengröße für diese Anzeigenfläche fest.
get	Eingestellt. Gibt den Wert für das AdSense-Attribut zurück, das dem angegebenen Schlüssel für diese Anzeigenfläche zugeordnet ist.
getAdUnitPath	Gibt den vollständigen Pfad des Anzeigenblocks mit dem Netzwerkcode und dem Anzeigenblockpfad zurück.
getAttributeKeys	Eingestellt. Gibt die Liste der Attributschlüssel zurück, die für diese Anzeigenfläche festgelegt sind.
getCategoryExclusions	Eingestellt. Gibt die Ausschlusslabels für Anzeigenkategorien für diese Anzeigenfläche zurück.
getConfig	Ruft eine eingefrorene Kopie der allgemeinen Konfigurationsoptionen für den Anzeigenflächensatz ab, die mit setConfig festgelegt wurden.
getResponseInformation	Gibt die Informationen zur Anzeigenantwort zurück.
getSlotElementId	Gibt die ID des Anzeigenflächen-div zurück, die bei der Definition der Anzeigenfläche angegeben wurde.
getTargeting	Eingestellt. Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diese Anzeigenfläche festgelegt wurde.
getTargetingKeys	Eingestellt. Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diesen Anzeigenflächenbereich festgelegt wurden.
set	Eingestellt. Legt einen Wert für ein AdSense-Attribut für diese Anzeigenfläche fest.
setCategoryExclusion	Eingestellt. Legt ein Label für den Ausschluss von Anzeigenkategorien auf Ebene der Anzeigenfläche für diese Anzeigenfläche fest.
setClickUrl	Eingestellt. Legt die Klick-URL fest, zu der Nutzer weitergeleitet werden, wenn sie auf die Anzeige klicken.
setCollapseEmptyDiv	Eingestellt. Legt fest, ob die Anzeigenfläche div ausgeblendet werden soll, wenn sie keine Anzeige enthält.
setConfig	Legt allgemeine Konfigurationsoptionen für diesen Anzeigenflächen-Slot fest.
setForceSafeFrame	Eingestellt. Hiermit wird konfiguriert, ob Anzeigen auf dieser Anzeigenfläche mithilfe eines SafeFrame-Containers gerendert werden müssen.
setSafeFrameConfig	Eingestellt. Legt die Einstellungen auf Anzeigenflächenebene für die SafeFrame-Konfiguration fest.
setTargeting	Eingestellt. Legt einen benutzerdefinierten Targeting-Parameter für diese Anzeigenfläche fest.
updateTargetingFromMap	Eingestellt. Legt benutzerdefinierte Targeting-Parameter für diese Anzeigenfläche aus einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt fest.

Methoden

---

addService

addService(service: Service): Slot

Fügt diesem Slot einen Dienst hinzu.

Beispiel

JavaScript

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

JavaScript (alt)

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());

Weitere Informationen

• Erste Schritte mit Google Publisher-Tags
• Testanzeige einblenden

Parameter
service: Service	Der Dienst, der hinzugefügt werden soll.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

clearCategoryExclusions

clearCategoryExclusions(): Slot

Löscht alle Anzeigenkategorie-Ausschlusslabels auf Ebene der Anzeigenfläche für diese Anzeigenfläche.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.categoryExclusion.

Beispiel

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.

JavaScript (alt)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

clearTargeting

clearTargeting(key?: string): Slot

Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Anzeigenflächenebene für diese Anzeigenfläche.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.targeting.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Weitere Informationen

• Targeting auf Schlüssel/Wert-Paare

Parameter
Optional key: string	Targeting-Parameterschlüssel. Der Schlüssel ist optional. Wenn er nicht angegeben ist, werden alle Targeting-Parameter gelöscht.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Legt ein Array von Zuordnungen von einer Mindestgröße des Darstellungsbereichs zur Anzeigenflächengröße für diese Anzeigenfläche fest.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

var mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping!);

Weitere Informationen

• Anzeigengrößen: Responsive Anzeigen

Parameter
sizeMapping: SizeMappingArray	Array von Größenzuordnungen. Sie können es mit SizeMappingBuilder erstellen. Jede Größenzuordnung ist ein Array mit zwei Elementen: SingleSizeArray und GeneralSize.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

get

get(key: string): string

Gibt den Wert für das AdSense-Attribut zurück, das dem angegebenen Schlüssel für diese Anzeigenfläche zugeordnet ist. Wenn Sie die von dieser Anzeigenfläche übernommenen Attribute auf Dienstebene sehen möchten, verwenden Sie PubAdsService.get.

Eingestellt: Verwenden Sie stattdessen googletag.Slot.getConfig.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Weitere Informationen

• AdSense-Attribute

Parameter
key: string	Name des Attributs, nach dem gesucht werden soll.

Ausgabe
string	Aktueller Wert für den Attributschlüssel oder null, wenn der Schlüssel nicht vorhanden ist.

---

getAdUnitPath

getAdUnitPath(): string

Gibt den vollständigen Pfad des Anzeigenblocks mit dem Netzwerkcode und dem Anzeigenblockpfad zurück.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

Ausgabe
string	Anzeigenblockpfad.

---

getAttributeKeys

getAttributeKeys(): string[]

Gibt die Liste der Attributschlüssel zurück, die für diesen Anzeigenflächen-Slot festgelegt sind. Mit PubAdsService.getAttributeKeys können Sie die Schlüssel der von dieser Anzeigenfläche übernommenen Attribute auf Dienstebene aufrufen.

Eingestellt: Verwenden Sie stattdessen googletag.Slot.getConfig.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

Ausgabe
string[]	Array von Attributschlüsseln. Die Reihenfolge ist nicht definiert.

---

getCategoryExclusions

getCategoryExclusions(): string[]

Gibt die Ausschlusslabels für Anzeigenkategorien für diese Anzeigenfläche zurück.

Eingestellt: Verwenden Sie stattdessen googletag.Slot.getConfig.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (alt)

var _a;
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

var exclusions =
  ((_a = slot.getConfig("categoryExclusion")) === null || _a === void 0
    ? void 0
    : _a.categoryExclusion) || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

Ausgabe
string[]	Die Ausschlusslabels für Anzeigenkategorien für diese Anzeigenfläche oder ein leeres Array, wenn keine festgelegt wurden.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>

Ruft eine eingefrorene Kopie der allgemeinen Konfigurationsoptionen für den Slot ab, die von setConfig festgelegt wurden.

Nicht alle setConfig()-Eigenschaften werden von dieser Methode unterstützt. Unterstützte Properties:

• adsenseAttributes
• categoryExclusion
• targeting

Beispiel

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

JavaScript (alt)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
var targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
var config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

Parameter
keys: string | string[]	Die Schlüssel der abzurufenden Konfigurationsoptionen.

Ausgabe
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>	Eine eingefrorene Kopie der Konfigurationsoptionen für den Slot.

---

getResponseInformation

getResponseInformation(): ResponseInformation

Gibt die Informationen zur Anzeigenantwort zurück. Dies basiert auf der letzten Anzeigenantwort für die Anzeigenfläche. Wenn diese Methode aufgerufen wird, wenn die Anzeigenfläche keine Anzeige enthält, wird null zurückgegeben.

Ausgabe
ResponseInformation	Die neuesten Informationen zur Anzeigenantwort oder null, wenn die Anzeigenfläche keine Anzeige enthält.

---

getSlotElementId

getSlotElementId(): string

Gibt die ID des Anzeigenbereichs div zurück, die bei der Definition des Anzeigenbereichs angegeben wurde.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

Ausgabe
string	Slot-div-ID.

---

getTargeting

getTargeting(key: string): string[]

Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diese Anzeigenfläche festgelegt wurde. Targeting-Parameter auf Dienstebene sind nicht enthalten.

Eingestellt: Verwenden Sie stattdessen googletag.Slot.getConfig.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

var targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["allow_expandable"]) || [];
// Returns ['true'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

Parameter
key: string	Der gesuchte Targeting-Schlüssel.

Ausgabe
string[]	Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn kein solcher Schlüssel vorhanden ist.

---

getTargetingKeys

getTargetingKeys(): string[]

Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diesen Anzeigenflächenplatz festgelegt sind. Targeting-Schlüssel auf Dienstebene sind nicht enthalten.

Eingestellt: Verwenden Sie stattdessen googletag.Slot.getConfig.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

var targetingConfig = slot.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

Ausgabe
string[]	Array von Targeting-Schlüsseln. Die Reihenfolge ist nicht definiert.

---

set

set(key: string, value: string): Slot

Legt einen Wert für ein AdSense-Attribut für diese Anzeigenfläche fest. Dadurch werden alle Werte überschrieben, die auf Dienstebene für diesen Schlüssel festgelegt wurden.

Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen vor dem Aufruf von display oder refresh festgelegt werden.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.adsenseAttributes.

Beispiel

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

JavaScript (alt)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

Weitere Informationen

• AdSense-Attribute

Parameter
key: string	Der Name des Attributs.
value: string	Attributwert.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

Legt ein Ausschlusslabel für Anzeigenkategorien auf Ebene der Anzeigenfläche für diese Anzeigenfläche fest.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.categoryExclusion.

Beispiel

JavaScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

JavaScript (alt)

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

Weitere Informationen

• Benutzerdefinierte Labels zum Blockieren von Anzeigen

Parameter
categoryExclusion: string	Das Label für den Ausschluss von Anzeigenkategorien, das hinzugefügt werden soll.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

setClickUrl

setClickUrl(value: string): Slot

Legt die Klick-URL fest, zu der Nutzer weitergeleitet werden, nachdem sie auf die Anzeige geklickt haben.

Die Google Ad Manager-Server erfassen auch dann einen Klick, wenn die Klick-URL ersetzt wird. Alle Landingpage-URLs, die mit dem ausgelieferten Creative verknüpft sind, werden an den angegebenen Wert angehängt. Bei nachfolgenden Aufrufen wird der Wert überschrieben. Dies funktioniert nur bei Anfragen, die nicht über die Einzelanfrage-Architektur gestellt werden.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.clickUrl.

Beispiel

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

JavaScript (alt)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

Parameter
value: string	Die festzulegende Klick-URL.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

Legt fest, ob die Anzeigenfläche div ausgeblendet werden soll, wenn sie keine Anzeige enthält. Dadurch werden die Einstellungen auf Dienstebene überschrieben.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.collapseDiv.

Beispiel

JavaScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

JavaScript (alt)

var slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

var slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

Weitere Informationen

• Leere Anzeigenflächen minimieren
• Layoutverschiebungen minimieren

Parameter
collapse: boolean	Gibt an, ob die Anzeigenfläche minimiert werden soll, wenn keine Anzeige zurückgegeben wird.
Optional collapseBeforeAdFetch: boolean	Gibt an, ob die Anzeigenfläche minimiert werden soll, bevor eine Anzeige abgerufen wird. Wird ignoriert, wenn „collapse“ nicht true ist.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot

Legt allgemeine Konfigurationsoptionen für diesen Anzeigenflächen-Slot fest.

Parameter
slotConfig: SlotSettingsConfig	Das Konfigurationsobjekt.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Konfiguriert, ob Anzeigen auf dieser Anzeigenfläche mithilfe eines SafeFrame-Containers gerendert werden müssen.

Beachten Sie bei der Verwendung dieser API Folgendes:

• Diese Einstellung wird nur für nachfolgende Anzeigenanfragen für die entsprechenden Anzeigenflächen wirksam.
• Die Einstellung auf Anzeigenflächenebene überschreibt immer die Einstellung auf Seitenebene, sofern sie angegeben ist.
• Wenn der Wert auf true festgelegt ist (auf Anzeigenflächen- oder Seitenebene), wird die Anzeige immer mit einem SafeFrame-Container gerendert, unabhängig von der Auswahl in der Google Ad Manager-Benutzeroberfläche.
• Wenn der Wert jedoch auf false festgelegt oder nicht angegeben ist, wird die Anzeige je nach Creative-Typ und der in der Google Ad Manager-Benutzeroberfläche getroffenen Auswahl in einem SafeFrame-Container gerendert.
• Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken kann, die versuchen, aus ihren iFrames auszubrechen, oder die darauf angewiesen sind, dass sie direkt auf der Seite eines Publishers gerendert werden.

Verworfen: Verwenden Sie stattdessen SlotSettingsConfig.safeFrame.

Beispiel

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

JavaScript (alt)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

Weitere Informationen

• Creatives mit SafeFrame rendern

Parameter
forceSafeFrame: boolean	true, um zu erzwingen, dass alle Anzeigen auf dieser Fläche in SafeFrames gerendert werden, und false, um eine Einstellung auf Seitenebene (falls vorhanden) zu deaktivieren. Wenn Sie diesen Wert auf false setzen, ohne ihn auf Seitenebene anzugeben, ändert sich nichts.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Legt die Einstellungen für die SafeFrame-Konfiguration auf Ebene der Anzeigenfläche fest. Unbekannte Schlüssel im Konfigurationsobjekt werden ignoriert. Die gesamte Konfiguration wird ignoriert, wenn für einen erkannten Schlüssel ein ungültiger Wert übergeben wird.

Diese Einstellungen auf Anzeigenflächenebene überschreiben, sofern angegeben, alle Einstellungen auf Seitenebene.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.safeFrame.

Beispiel

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (alt)

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Weitere Informationen

• Creatives mit SafeFrame rendern

Parameter
config: SafeFrameConfig	Das Konfigurationsobjekt.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

setTargeting

setTargeting(key: string, value: string | string[]): Slot

Legt einen benutzerdefinierten Targeting-Parameter für diese Anzeigenfläche fest. Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden alte Werte überschrieben. Die hier festgelegten Werte überschreiben die auf Dienstebene festgelegten Targeting-Parameter. Diese Schlüssel sind in Ihrem Google Ad Manager-Konto definiert.

Eingestellt: Verwenden Sie stattdessen SlotSettingsConfig.targeting.

Beispiel

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

JavaScript (alt)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

Weitere Informationen

• Targeting auf Schlüssel/Wert-Paare

Parameter
key: string	Targeting-Parameterschlüssel.
value: string | string[]	Wert oder Array von Werten für den Targeting-Parameter.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot

Legt benutzerdefinierte Targeting-Parameter für diese Anzeigenfläche aus einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt fest. Dies entspricht dem Aufruf von Slot.setTargeting für alle Schlüsselwerte des Objekts. Diese Schlüssel sind in Ihrem Google Ad Manager-Konto definiert.

Hinweise:

• Beim Überschreiben wird nur der letzte Wert beibehalten.
• Wenn der Wert ein Array ist, wird jeder vorherige Wert überschrieben und nicht zusammengeführt.
• Die hier festgelegten Werte überschreiben die auf Dienstebene festgelegten Targeting-Parameter.

Verworfen: Verwenden Sie stattdessen SlotSettingsConfig.targeting.

Beispiel

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

JavaScript (alt)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

Parameter
map: {   [adUnitPath: string]: string | string[]; }	Targeting-Parameter-Schlüssel/Wert-Zuordnung.

Ausgabe
Slot	Das Anzeigenflächenobjekt, für das die Methode aufgerufen wurde.

---

googletag.config

Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.

Schnittstellen
AdExpansionConfig	Einstellungen zur Steuerung der Vergrößerung der Anzeigenfläche.
AdSenseAttributesConfig	Einstellungen, mit denen Sie das Verhalten von AdSense-Anzeigen steuern können.
AutoRefreshConfig	Konfigurationseinstellungen für die automatische Aktualisierung.
ContinueButtonConfig	Einstellungen zum Konfigurieren des Verhaltens der Schaltfläche „Weiter“.
InterstitialConfig	Ein Objekt, das das Verhalten einer einzelnen Interstitial-Anzeigenfläche definiert.
LazyLoadConfig	Einstellungen zum Steuern der Verwendung von Lazy Loading in GPT.
PageSettingsConfig	Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.
PrivacyTreatmentsConfig	Einstellungen zum Verwalten der Datenschutzbehandlungen für Publisher.
PublisherProvidedSignalsConfig	Konfigurationsobjekt für vom Publisher bereitgestellte Signale (PPS)
SafeFrameConfig	Einstellungen zum Steuern von SafeFrame in GPT.
SlotSettingsConfig	Hauptkonfigurationsoberfläche für Einstellungen auf Slot-Ebene.
TaxonomyData	Ein Objekt, das die Werte für eine einzelne Taxonomie enthält.
VideoAdsConfig	Einstellungen zum Konfigurieren von Einstellungen für Videoanzeigen.

Typaliasse
CollapseDivBehavior	Unterstützte Werte zum Steuern des Minimierungsverhaltens von Anzeigenflächen.
InterstitialTrigger	Unterstützte Trigger für Interstitial-Anzeigen.
PrivacyTreatment	Unterstützte Publisher Privacy Treatments.
Taxonomy	Unterstützte Taxonomien für vom Publisher bereitgestellte Signale (PPS)

Typaliasse

---

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"

Unterstützte Werte zum Steuern des Minimierungsverhaltens von Anzeigenflächen.

Weitere Informationen

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"

Unterstützte Trigger für Interstitial-Anzeigen.

Hinweis: Ab dem 15. Juni 2026 wird der Trigger backward nicht mehr unterstützt und das Aktivieren hat keine Auswirkungen. Weitere Informationen finden Sie in den Versionshinweisen zum GPT.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Unterstützte Publisher Privacy Treatments.

---

Taxonomie

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Unterstützte Taxonomien für vom Publisher bereitgestellte Signale (PPS).

Weitere Informationen

• IAB-Taxonomie für Zielgruppen 1.1
• IAB-Taxonomie für Inhalte 2.2

---

googletag.config.AdExpansionConfig

Einstellungen zum Steuern der Vergrößerung der Anzeigenfläche.

Attribute
enabled?	Gibt an, ob die Vergrößerung der Anzeigenfläche aktiviert oder deaktiviert ist.

Beispiel

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

JavaScript (alt)

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

Attribute

---

Optional aktiviert

enabled?: boolean

Gibt an, ob die Vergrößerung der Anzeigenfläche aktiviert oder deaktiviert ist.

Wenn Sie diesen Wert festlegen, wird die Standardeinstellung in Google Ad Manager überschrieben.

Weitere Informationen

• Anzeigen auf Computern und Tablets maximieren
• Maximierte Anzeigen im mobilen Web (Teilbildschirm)

---

googletag.config.AdSenseAttributesConfig

Einstellungen zum Steuern des Verhaltens von AdSense-Anzeigen.

Mit diesen Attributen können serverseitige Einstellungen für jede Anfrage überschrieben werden.

Attribute
adsense_ad_format?	AdSense-Anzeigenformat
adsense_channel_ids?	AdSense-Channel-IDs.
adsense_test_mode?	Gibt an, ob der Testmodus aktiviert ist.
document_language?	Sprache der Seite, auf der Anzeigen ausgeliefert werden.
page_url?	URL der Seite, auf der Anzeigen ausgeliefert werden.

Weitere Informationen

• PageSettingsConfig.adsenseAttributes
• SlotSettingsConfig.adsenseAttributes

Attribute

---

Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"

AdSense-Anzeigenformat

---

Optional adsense_channel_ids

adsense_channel_ids?: string

AdSense-Kanal-IDs.

Zulässige Werte sind Kanal-IDs, die durch „+“ getrennt sind.

Beispiel: 271828183+314159265

Weitere Informationen

• Anzeigenleistung mit benutzerdefinierten Channels erfassen

---

Optional adsense_test_mode

adsense_test_mode?: "on"

Gibt an, ob der Testmodus aktiviert ist.

Wenn der Wert auf on gesetzt ist, werden Anzeigen als reine Testanzeigen gekennzeichnet und nicht für die Zählung oder Abrechnung berücksichtigt. Diese Einstellung muss für den Produktionstraffic (kein Testtraffic) deaktiviert werden.

---

Optional document_language

document_language?: string

Sprache der Seite, auf der Anzeigen ausgeliefert werden.

Zulässige Werte sind gültige ISO 639-1-Sprachcodes.

Beispiel: en

Weitere Informationen

• Liste der Sprachcodes gemäß ISO 639

---

Optional page_url

page_url?: string

URL der Seite, auf der Anzeigen ausgeliefert werden.

Zulässige Werte sind gültige URLs.

Beispiel: http://www.example.com

---

googletag.config.AutoRefreshConfig

Konfigurationseinstellungen für die automatische Aktualisierung.

Attribute
backForwardCache?	Gibt an, ob GPT eine aktiv angezeigte Anzeigenfläche automatisch aktualisiert, wenn die Seite aus dem Back/Forward-Cache wiederhergestellt wird.
heavyAds?	Gibt an, ob GPT eine Anzeigenfläche automatisch aktualisiert, wenn die Heavy Ad Intervention von Chrome für den iFrame der Anzeige auf der Fläche ausgelöst wird.

Attribute

---

Optional backForwardCache

backForwardCache?: boolean

Gibt an, ob GPT eine aktiv angezeigte Anzeigenfläche automatisch aktualisiert, wenn die Seite aus dem Back/Forward-Cache wiederhergestellt wird. Die Standardeinstellung ist true.

Beispiel

JavaScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript (alt)

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Weitere Informationen

• Back-Forward-Cache

---

Optional heavyAds

heavyAds?: boolean

Gibt an, ob GPT eine Anzeigenfläche automatisch aktualisiert, wenn die Heavy Ad Intervention von Chrome für den iFrame der Anzeige auf der Fläche ausgelöst wird. Die Standardeinstellung ist true.

Beispiel

JavaScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript (alt)

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Weitere Informationen

• Informationen zu den Maßnahmen von Chrome gegen ressourcenintensive Anzeigen

---

googletag.config.ContinueButtonConfig

Einstellungen zum Konfigurieren des Verhaltens der Schaltfläche „Weiter“.

Attribute
backgroundColor?	Die Hintergrundfarbe des Buttons.
font?	Die Schriftfamilie des Schaltflächentexts.
fontColor?	Die Textfarbe der Schaltfläche.
freqCapIntervalMinutes?	Das Intervall für das Frequency Capping in Minuten.
targetId?	Die ID des HTML-Elements, auf dem die Schaltfläche „Weiter“ gerendert/ausgelöst werden soll.

Weitere Informationen

• SlotSettingsConfig.continueButton

Attribute

---

Optional backgroundColor

backgroundColor?: string

Die Hintergrundfarbe der Schaltfläche.

Beispiel: 'blue', '#94B1FF'

---

Optional Schriftart

font?: string

Die Schriftfamilie des Schaltflächentexts.

Beispiel: 'Arial'

---

Optional fontColor

fontColor?: string

Die Textfarbe der Schaltfläche.

Beispiel: 'white', '#B73B87'

---

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number

Das Intervall für das Frequency Capping in Minuten.

Muss eine Ganzzahl größer oder gleich 1 sein.

---

Optional targetId

targetId?: string

Die ID des HTML-Elements, auf dem die Schaltfläche „Weiter“ gerendert/ausgelöst werden soll.

---

googletag.config.InterstitialConfig

Ein Objekt, das das Verhalten einer einzelnen Interstitial-Anzeigenfläche definiert.

Attribute
requireStorageAccess?	Gibt an, ob für die Auslieferung dieser Interstitial-Anzeige eine Einwilligung für die lokale Speicherung erforderlich ist.
triggers?	Die Konfiguration des Interstitial-Triggers für diese Interstitial-Anzeige.

Attribute

---

Optional requireStorageAccess

requireStorageAccess?: boolean

Gibt an, ob für die Auslieferung dieser Interstitial-Anzeige eine Einwilligung zur lokalen Speicherung erforderlich ist.

In GPT wird der lokale Speicher verwendet, um ein Frequency Capping für Interstitial-Anzeigen durchzusetzen. Nutzer, die keine Einwilligung zur lokalen Speicherung erteilt haben, können jedoch weiterhin Interstitial-Anzeigen sehen. Wenn Sie diese Property auf true setzen, wird das Standardverhalten deaktiviert und Interstitial-Anzeigen werden nur Nutzern präsentiert, die der lokalen Speicherung zugestimmt haben.

Beispiel

JavaScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

JavaScript (alt)

// Opt out of showing interstitials to users
// without local storage consent.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

Weitere Informationen

• Trafficking von Web-Interstitials

---

Optional Trigger

triggers?: Partial<Record<InterstitialTrigger, boolean>>

Die Konfiguration des Interstitial-Triggers für diese Interstitial-Anzeige.

Wenn Sie den Wert eines Interstitial-Triggers auf true setzen, wird er aktiviert. Mit false wird er deaktiviert. Dadurch werden die Standardwerte überschrieben, die in Google Ad Manager konfiguriert wurden.

Beispiel

JavaScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

JavaScript (alt)

// Define a GPT managed web interstitial ad slot.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
var enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

TypeScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

Weitere Informationen

• Web-Interstitial-Anzeige einblenden

---

googletag.config.LazyLoadConfig

Einstellungen zum Steuern der Verwendung von Lazy Loading in GPT.

Attribute
fetchMarginPercent?	Der Mindestabstand, den eine Anzeigenfläche vom aktuellen Darstellungsbereich haben muss, bevor eine Anzeige angefordert wird, ausgedrückt als Prozentsatz der Größe des Darstellungsbereichs.
mobileScaling?	Ein Multiplikator, der auf Ränder auf Mobilgeräten angewendet wird.
renderMarginPercent?	Der Mindestabstand, den eine Anzeigenfläche vom aktuellen Darstellungsbereich haben muss, bevor eine Anzeige gerendert wird, ausgedrückt als Prozentsatz der Größe des Darstellungsbereichs.

Weitere Informationen

• PageSettingsConfig.lazyLoad

Attribute

---

Optional fetchMarginPercent

fetchMarginPercent?: number

Der Mindestabstand, den eine Anzeigenfläche vom aktuellen Darstellungsbereich haben muss, bevor eine Anzeige angefordert wird, ausgedrückt als Prozentsatz der Größe des Darstellungsbereichs.

In Verbindung mit renderMarginPercent ermöglicht diese Einstellung das Prefetching einer Anzeige, während das Rendern und Herunterladen anderer Unterressourcen verzögert wird. Dieser Wert sollte daher immer größer oder gleich renderMarginPercent sein.

Der Wert 0 bedeutet „wenn die Anzeigenfläche im Darstellungsbereich erscheint“, 100 bedeutet „wenn die Anzeige einen Darstellungsbereich entfernt ist“ usw.

---

Optional mobileScaling

mobileScaling?: number

Ein Multiplikator, der auf Ränder auf Mobilgeräten angewendet wird. Dieser Multiplikator wird sowohl auf fetchMarginPercent als auch auf renderMarginPercent angewendet.

So können unterschiedliche Margen für Mobilgeräte und Computer festgelegt werden, da sich die Größe des Darstellungsbereichs und die Scrollgeschwindigkeit unterscheiden können. Bei einem Wert von 2,0 werden beispielsweise alle Ränder auf Mobilgeräten mit 2 multipliziert.Dadurch wird der Mindestabstand, den eine Anzeigenfläche vor dem Abrufen und Rendern vom Darstellungsbereich haben kann, vergrößert.

---

Optional renderMarginPercent

renderMarginPercent?: number

Der Mindestabstand, den eine Anzeigenfläche vom aktuellen Darstellungsbereich haben muss, bevor eine Anzeige gerendert wird, ausgedrückt als Prozentsatz der Größe des Darstellungsbereichs.

In Verbindung mit fetchMarginPercent ermöglicht diese Einstellung das Prefetching einer Anzeige, während das Rendern und Herunterladen anderer Unterressourcen verzögert wird. Daher sollte dieser Wert immer kleiner oder gleich fetchMarginPercent sein.

Der Wert 0 bedeutet „wenn die Anzeigenfläche im Darstellungsbereich erscheint“, 100 bedeutet „wenn die Anzeige einen Darstellungsbereich entfernt ist“ usw.

---

googletag.config.PageSettingsConfig

Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.

Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf.

Alle unten aufgeführten Properties sind Beispiele und spiegeln nicht die tatsächlichen Funktionen wider, die „setConfig“ verwenden. Eine Liste der Funktionen finden Sie unten in den Feldern des Typs „PageSettingsConfig“.

Beispiele:

• Es werden nur die im Aufruf googletag.setConfig angegebenen Funktionen geändert.

    // Configure feature alpha.
    googletag.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    googletag.setConfig({
       bravo: {...}
    });

• Alle Einstellungen für eine bestimmte Funktion werden bei jedem Aufruf von googletag.setConfig aktualisiert.

    // Configure feature charlie to echo = 1, foxtrot = true.
    googletag.setConfig({
        charlie: {
            echo: 1,
            foxtrot: true,
        }
    });
  
    // Update feature charlie to echo = 2. Since foxtrot was not specified,
    // the value is cleared.
    googletag.setConfig({
        charlie: {
            echo: 2
        }
    });

• Alle Einstellungen für ein Feature können durch Übergabe von null gelöscht werden.

    // Configure features delta, golf, and hotel.
    googletag.setConfig({
        delta: {...},
        golf: {...},
        hotel: {...},
    });
  
    // Feature delta and hotel are cleared, but feature golf remains set.
    googletag.setConfig({
        delta: null,
        hotel: null,
    });

Attribute
adExpansion?	Einstellungen zur Steuerung der Vergrößerung der Anzeigenfläche.
adsenseAttributes?	Einstellung zum Konfigurieren von AdSense-Attributen.
adYield?	Verworfen.
autoRefresh?	Einstellung zum Konfigurieren des Verhaltens für die automatische Anzeigenaktualisierung.
categoryExclusion?	Einstellung zum Konfigurieren von Ausschlüssen für Anzeigenkategorien.
centering?	Einstellung zur Steuerung der horizontalen Zentrierung von Anzeigen.
collapseDiv?	Einstellung, mit der das Minimierungsverhalten von Anzeigenflächen gesteuert wird.
disableInitialLoad?	Einstellung, mit der gesteuert wird, wann Anzeigen angefordert werden.
lazyLoad?	Einstellungen zum Steuern der Verwendung von Lazy Loading in GPT.
location?	Einstellung für das geografische Targeting von Werbebuchungen auf geografische Standorte.
pps?	Einstellungen zum Steuern von vom Publisher bereitgestellten Signalen (PPS).
privacyTreatments?	Einstellungen zum Verwalten der Datenschutzbehandlungen für Publisher.
requestHookTimeoutMs?	Mit dieser Einstellung wird die maximale Zeit festgelegt, die das GPT auf den Abschluss aller registrierten Anfrage-Hooks wartet, bevor eine Anzeigenanfrage gesendet wird.
safeFrame?	Einstellungen zum Steuern der Verwendung von SafeFrame in GPT.
singleRequest?	Einstellung zum Aktivieren oder Deaktivieren der Einzelanfrage-Architektur (SRA).
targeting?	Einstellung zur Steuerung des Targetings nach Schlüssel/Wert-Paaren.
threadYield?	Mit dieser Einstellung wird festgelegt, ob GPT den JS-Thread beim Anfordern und Rendern von Creatives freigeben soll.
videoAds?	Einstellungen zum Steuern von Videoanzeigen.

Attribute

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Einstellungen zum Steuern der Vergrößerung der Anzeigenfläche.

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Einstellung zum Konfigurieren von AdSense-Attributen.

AdSense-Attribute, die über diese Einstellung konfiguriert werden, gelten für alle Anzeigenflächen auf der Seite. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Attributwerte zu definieren oder vorhandene Werte zu überschreiben.

Änderungen an AdSense-Attributen gelten nur für Anzeigenanfragen, die nach dem Aufruf dieser Methode gestellt werden. Daher wird empfohlen, diese Methode vor allen Aufrufen von googletag.display oder PubAdsService.refresh aufzurufen.

Beispiel

JavaScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

JavaScript (alt)

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

---

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Nicht mehr unterstützt: Verwenden Sie stattdessen threadYield. Diese werden in naher Zukunft entfernt.

---

Optional autoRefresh

autoRefresh?: AutoRefreshConfig

Einstellung zum Konfigurieren des Verhaltens für die automatische Anzeigenaktualisierung.

Beispiel

JavaScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

JavaScript (alt)

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Einstellung zum Konfigurieren von Ausschlüssen von Anzeigenkategorien.

Beispiel

JavaScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

JavaScript (alt)

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

Weitere Informationen

• Benutzerdefinierte Labels zum Blockieren von Anzeigen

---

Optional Zentrierung

centering?: boolean

Einstellung zur Steuerung der horizontalen Zentrierung von Anzeigen. Die Zentrierung ist standardmäßig deaktiviert.

Änderungen an der horizontalen Zentrierung gelten nur für Anzeigenanfragen, die nach dem Aufruf dieser Methode gestellt werden. Daher wird empfohlen, diese Methode vor allen Aufrufen von googletag.display oder PubAdsService.refresh aufzurufen.

Beispiel

JavaScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

JavaScript (alt)

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Einstellung, mit der das Minimierungsverhalten von Anzeigenflächen gesteuert wird.

Eine minimierte Anzeigenfläche nimmt keinen Platz auf der Seite ein.

Unterstützte Werte:

• null (Standard): Die Anzeigenfläche wird nicht minimiert.
• DISABLED: Die Anzeigenfläche wird nicht minimiert, unabhängig davon, ob eine Anzeige zurückgegeben wird oder nicht.
• BEFORE_FETCH: Die Anzeigenfläche ist anfangs minimiert und wird maximiert, wenn eine Anzeige zurückgegeben wird.
• ON_NO_FILL: Die Anzeigenfläche wird zuerst maximiert und dann minimiert, wenn keine Anzeige zurückgegeben wird.

Beispiel

JavaScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

JavaScript (alt)

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

TypeScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

Weitere Informationen

• Leere Anzeigenflächen minimieren
• Layoutverschiebungen minimieren

---

Optional disableInitialLoad

disableInitialLoad?: boolean

Mit dieser Einstellung können Sie festlegen, wann Anzeigen angefordert werden.

Standardmäßig werden mit der Methode googletag.display sowohl Anzeigenflächen registriert als auch Anzeigen dafür angefordert. Manchmal ist es jedoch besser, diese Aktionen zu trennen, um genauer zu steuern, wann Anzeigeninhalte geladen werden.

Wenn Sie diese Einstellung aktivieren, werden keine Anzeigen für registrierte Anzeigenflächen angefordert, wenn die Methode display() aufgerufen wird. Stattdessen muss ein separater Aufruf von PubAdsService.refresh erfolgen, um eine Anzeigenanfrage zu initiieren.

Diese Methode muss vor dem Aufruf von googletag.enableServices aufgerufen werden.

Beispiel

JavaScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

JavaScript (alt)

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

Weitere Informationen

• Laden und Aktualisieren von Anzeigen steuern
• SRA-Batching steuern

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

Einstellungen zur Steuerung der Verwendung von Lazy Loading in GPT.

Lazy Loading ist eine Technik, mit der das Anfordern und Rendern von Anzeigen verzögert wird, bis sie sich dem Darstellungsbereich des Nutzers nähern. Ein ausführlicheres Beispiel finden Sie im Beispiel Lazy Loading.

Hinweis: Wenn singleRequest aktiviert ist, funktioniert Lazy Loading nur, wenn sich alle Anzeigenflächen außerhalb des Abrufrands befinden.

Für alle Lazy Loading-Einstellungen, die beim Aufruf von setConfig() nicht angegeben werden, wird ein von Google festgelegter Standardwert verwendet. Diese Standardeinstellungen können im Laufe der Zeit angepasst werden. Wenn Sie eine bestimmte Einstellung deaktivieren möchten, setzen Sie den Wert auf null.

Beispiel

JavaScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

JavaScript (alt)

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

TypeScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

Weitere Informationen

• Best Practices für Anzeigen: „Wichtige“ Anzeigenflächen priorisieren
• Lazy Loading

---

Optional Standort

location?: string

Einstellung für das geografische Targeting von Werbebuchungen auf geografische Standorte.

Beispiel

JavaScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

JavaScript (alt)

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

TypeScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

Weitere Informationen

• Geografische Ausrichtung für die Auslieferung

---

Optional pps

pps?: PublisherProvidedSignalsConfig

Einstellungen zum Steuern von vom Publisher bereitgestellten Signalen (PPS).

---

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

Einstellungen zum Verwalten der Datenschutzbehandlungen für Publisher.

---

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

Mit dieser Einstellung wird die maximale Zeit festgelegt, die das GPT auf den Abschluss aller registrierten Anfrage-Hooks wartet, bevor eine Anzeigenanfrage gesendet wird.

Alle registrierten Anfrage-Hooks werden parallel ausgeführt. Dieses Zeitlimit definiert die Obergrenze für die Dauer, für die der Anzeigenanfrageprozess pausiert, während auf den Abschluss dieser parallelen Ausführungen gewartet wird.

Unterstützte Werte:

• Positive Zahl in Millisekunden: Die benutzerdefinierte Wartezeit.
• 'auto': GPT verwendet ein von Google optimiertes Zeitlimit.
• null: Zeitüberschreitungen werden deaktiviert. GPT wartet unbegrenzt, bis Hooks abgeschlossen sind.

Beispiel

JavaScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

JavaScript (alt)

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

TypeScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Einstellungen zur Steuerung der Verwendung von SafeFrame in GPT.

Werte, die über diese Einstellung konfiguriert werden, gelten für alle Anzeigenflächen auf der Seite. Einzelne Anzeigenflächen können diese Werte über SlotSettingsConfig.safeFrame überschreiben.

Beispiel

JavaScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

JavaScript (alt)

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

TypeScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

---

Optional singleRequest

singleRequest?: boolean

Einstellung zum Aktivieren oder Deaktivieren der Einzelanfrage-Architektur (SRA).

Wenn die SRA aktiviert ist, werden alle Anzeigenflächen, die vor einem googletag.display- oder PubAdsService.refresh-Aufruf definiert wurden, in einer einzigen Anzeigenanfrage zusammengefasst. Das bietet Leistungsvorteile, ist aber auch erforderlich, damit Roadblocks und Konkurrenzausschlüsse berücksichtigt werden.

Wenn die Einzelanfrage-Architektur deaktiviert ist, wird jede Anzeigenfläche einzeln angefordert. Das ist das Standardverhalten von GPT.

Diese Methode muss vor dem Aufruf von googletag.enableServices aufgerufen werden.

Beispiel

JavaScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

JavaScript (alt)

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

Weitere Informationen

• Roadblocks
• Best Practices für Anzeigen: Einzelanfrage-Architektur richtig verwenden
• SRA-Batching steuern

---

Optional Targeting

targeting?: Record<string, string | string[]>

Einstellung zum Steuern des Targetings mit Schlüssel/Wert-Paaren.

Das über diese Einstellung konfigurierte Targeting wird auf alle Anzeigenflächen auf der Seite angewendet. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Targeting-Schlüssel/Wert-Paare zu definieren oder vorhandene Werte zu überschreiben. Targeting-Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.

Beispiel

JavaScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

JavaScript (alt)

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

TypeScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

Weitere Informationen

• Targeting auf Schlüssel/Wert-Paare

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Einstellung, mit der gesteuert wird, ob GPT den JS-Thread beim Anfordern und Rendern von Creatives freigeben soll.

GPT gibt den Thread nur für Browser frei, die die Scheduler.postTask- oder Scheduler.yield-API unterstützen.

Unterstützte Werte:

• null (Standard): GPT gibt den JS-Thread für Anzeigenflächen außerhalb des Darstellungsbereichs frei.
• ENABLED_ALL_SLOTS: GPT gibt den JS-Thread für alle Anzeigenflächen frei, unabhängig davon, ob sich die Anzeigenfläche im Darstellungsbereich befindet.
• DISABLED: GPT gibt den JS-Thread nicht frei.

Beispiel

JavaScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

JavaScript (alt)

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

TypeScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

Weitere Informationen

• Planer

---

Optional videoAds

videoAds?: VideoAdsConfig

Einstellungen zum Verwalten von Videoanzeigen

Beispiel

JavaScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

JavaScript (alt)

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

TypeScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

Weitere Informationen

• Aufnahme von Videoinhalten

---

googletag.config.PrivacyTreatmentsConfig

Einstellungen zum Verwalten der Datenschutzmaßnahmen für Publisher.

Attribute
treatments	Ein Array von Publisher Privacy Treatments, die aktiviert werden sollen.

Attribute

---

Behandlungen

treatments: "disablePersonalization"[]

Ein Array von Publisher Privacy Treatments, die aktiviert werden sollen.

Beispiel

JavaScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

JavaScript (alt)

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

TypeScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

---

googletag.config.PublisherProvidedSignalsConfig

Konfigurationsobjekt für vom Publisher bereitgestellte Signale (PPS)

Attribute
taxonomies	Ein Objekt, das Taxonomie-Zuordnungen enthält, oder „null“, um die Konfiguration zu löschen.

Beispiel

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript (alt)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

Weitere Informationen

• Vom Publisher bereitgestellte Signale (Beta)
• IAB-Taxonomie für Zielgruppen 1.1
• IAB-Taxonomie für Inhalte 2.2

Attribute

---

Taxonomien

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Ein Objekt, das Taxonomie-Zuordnungen enthält, oder „null“, um die Konfiguration zu löschen.

---

googletag.config.SafeFrameConfig

Einstellungen zum Steuern von SafeFrame in GPT.

Attribute
allowOverlayExpansion?	Gibt an, ob SafeFrame zulassen soll, dass Anzeigeninhalte maximiert werden, indem sie Seiteninhalte überlagern.
allowPushExpansion?	Gibt an, ob SafeFrame zulassen soll, dass Anzeigeninhalte maximiert werden, indem Seiteninhalte verschoben werden.
forceSafeFrame?	Gibt an, ob Anzeigen mithilfe eines SafeFrame-Containers gerendert werden müssen.
sandbox?	Gibt an, ob SafeFrame das HTML5-Attribut „sandbox“ verwenden soll, um die Navigation auf der obersten Ebene ohne Nutzerinteraktion zu verhindern.
useUniqueDomain?	Eingestellt. Ob SafeFrame zufällige Subdomains für Reservierungs-Creatives verwenden soll.

Weitere Informationen

• PageSettingsConfig.safeFrame
• SlotSettingsConfig.safeFrame

Attribute

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Gibt an, ob SafeFrame zulassen soll, dass Anzeigeninhalte maximiert werden, indem sie Seiteninhalte überlagern.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

Gibt an, ob SafeFrame zulassen soll, dass Anzeigeninhalte maximiert werden, indem Seiteninhalte verschoben werden.

---

Optional forceSafeFrame

forceSafeFrame?: boolean

Gibt an, ob Anzeigen mithilfe eines SafeFrame-Containers gerendert werden müssen.

---

Optional Sandbox

sandbox?: boolean

Gibt an, ob SafeFrame das HTML5-Attribut „sandbox“ verwenden soll, um die Navigation auf der obersten Ebene ohne Nutzerinteraktion zu verhindern. Der einzige gültige Wert ist true (kann nicht auf false erzwungen werden). Beachten Sie, dass das Sandbox-Attribut Plug-ins (z.B. Flash) deaktiviert.

---

Optional useUniqueDomain

useUniqueDomain?: boolean

Gibt an, ob SafeFrame zufällige Subdomains für Reservierungs-Creatives verwenden soll. Übergeben Sie null, um den gespeicherten Wert zu löschen.

Hinweis: Diese Funktion ist standardmäßig aktiviert.

Eingestellt: Es ist nicht mehr möglich, diese Funktion zu deaktivieren. Das Festlegen von useUniqueDomain hat keine Auswirkungen.

Weitere Informationen

• Creatives mit SafeFrame rendern

---

googletag.config.SlotSettingsConfig

Hauptkonfigurationsoberfläche für Einstellungen auf Anzeigenflächenebene.

Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf für eine einzelne Anzeigenfläche.

Alle unten aufgeführten Properties sind Beispiele und spiegeln nicht die tatsächlichen Funktionen wider, die setConfig verwenden. Eine Liste der Funktionen finden Sie unten in den Feldern des Typs „SlotSettingsConfig“.

Beispiele:

• Es werden nur die im Aufruf Slot.setConfig angegebenen Funktionen geändert.

    const slot = googletag.defineSlot("/1234567/example", [160, 600]);
  
    // Configure feature alpha.
    slot.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    slot.setConfig({
       bravo: {...}
    });

• Bei jedem Aufruf von Slot.setConfig werden alle Einstellungen für eine bestimmte Funktion aktualisiert.

    // Configure feature charlie to echo = 1, foxtrot = true.
    slot.setConfig({
        charlie: {
            echo: 1,
            foxtrot: true,
        }
    });
  
    // Update feature charlie to echo = 2. Since foxtrot was not specified,
    // the value is cleared.
    slot.setConfig({
        charlie: {
            echo: 2
        }
    });

• Alle Einstellungen für ein Feature können durch Übergabe von null gelöscht werden.

    // Configure features delta, golf, and hotel.
    slot.setConfig({
        delta: {...},
        golf: {...},
        hotel: {...},
    });
  
    // Feature delta and hotel are cleared, but feature golf remains set.
    slot.setConfig({
        delta: null,
        hotel: null,
    });

Attribute
adExpansion?	Einstellungen zum Konfigurieren der Vergrößerung der Anzeigenfläche.
adsenseAttributes?	Einstellung zum Konfigurieren von AdSense-Attributen.
categoryExclusion?	Einstellung zum Konfigurieren von Ausschlüssen für Anzeigenkategorien.
clickUrl?	Einstellung zum Konfigurieren der URL, zu der Nutzer weitergeleitet werden, wenn sie auf die Anzeige klicken.
collapseDiv?	Einstellung zum Konfigurieren des Minimierungsverhaltens der Anzeigenfläche.
continueButton?	Einstellungen zum Konfigurieren des Verhaltens der Schaltfläche „Weiter“ für Pausenanzeigen.
interstitial?	Einstellungen, mit denen das Verhalten von Interstitial-Anzeigenflächen konfiguriert wird.
safeFrame?	Einstellungen zum Konfigurieren der Verwendung von SafeFrame in GPT.
targeting?	Einstellung zum Konfigurieren des Schlüssel/Wert-Targetings.

Attribute

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Einstellungen zum Konfigurieren der Vergrößerung der Anzeigenfläche.

Weitere Informationen

• Vergrößerung der Anzeigenfläche

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Einstellung zum Konfigurieren von AdSense-Attributen.

AdSense-Attribute, die über diese Einstellung konfiguriert werden, gelten nur für die Anzeigenfläche. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Attributwerte zu definieren oder vorhandene Werte zu überschreiben.

Änderungen an AdSense-Attributen gelten nur für Anzeigenanfragen, die nach dem Aufruf dieser Methode gestellt werden. Daher wird empfohlen, diese Methode vor allen Aufrufen von googletag.display oder PubAdsService.refresh aufzurufen.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Einstellung zum Konfigurieren von Ausschlüssen von Anzeigenkategorien.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

Weitere Informationen

• Benutzerdefinierte Labels zum Blockieren von Anzeigen

---

Optional clickUrl

clickUrl?: string

Einstellung zum Konfigurieren der URL, zu der Nutzer weitergeleitet werden, wenn sie auf die Anzeige klicken.

Die Google Ad Manager-Server erfassen auch dann einen Klick, wenn die Klick-URL ersetzt wird. Alle Landingpage-URLs, die mit dem ausgelieferten Creative verknüpft sind, werden an den angegebenen Wert angehängt. Wenn Sie diesen Wert mehrmals festlegen, wird der zuvor konfigurierte Wert überschrieben. Wenn Sie null übergeben, wird der Wert gelöscht.

Hinweis: Diese Einstellung gilt nur für Anfragen, die nicht über die Einzelanfrage-Architektur erfolgen.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Einstellung zum Konfigurieren des Minimierungsverhaltens der Anzeigenfläche.

Eine minimierte Anzeigenfläche nimmt keinen Platz auf der Seite ein.

Unterstützte Werte:

• null (Standard): Die Anzeigenfläche wird nicht minimiert.
• DISABLED: Die Anzeigenfläche wird nicht minimiert, unabhängig davon, ob eine Anzeige zurückgegeben wird oder nicht.
• BEFORE_FETCH: Die Anzeigenfläche ist anfangs minimiert und wird maximiert, wenn eine Anzeige zurückgegeben wird.
• ON_NO_FILL: Die Anzeigenfläche wird zuerst maximiert und dann minimiert, wenn keine Anzeige zurückgegeben wird.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

Weitere Informationen

• Leere Anzeigenflächen minimieren
• Layoutverschiebungen minimieren

---

Optional continueButton

continueButton?: ContinueButtonConfig

Einstellungen zum Konfigurieren des Verhaltens der Schaltfläche „Weiter“ für Pausenanzeigen.

Mit diesen Einstellungen können Sie das Erscheinungsbild und das Verhalten der Interaktionen zum Beenden und Weiterlesen anpassen, die mit Pausenanzeigen verknüpft sind.

Für alle Einstellungen der Schaltfläche „Weiter“, die beim Aufrufen von setConfig() nicht angegeben werden, wird ein von Google festgelegter Standardwert verwendet.

Wenn Sie alle Einstellungen der Schaltfläche „Weiter“ deaktivieren oder löschen möchten, übergeben Sie null.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

---

Optional Interstitial

interstitial?: InterstitialConfig

Einstellungen, mit denen das Verhalten von Interstitial-Anzeigenflächen konfiguriert wird.

Weitere Informationen

• Trafficking von Web-Interstitials

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Einstellungen zum Konfigurieren der Verwendung von SafeFrame in GPT.

Über diese Einstellung konfigurierte Werte gelten nur für die Anzeigenfläche und überschreiben Werte, die über PageSettingsConfig.safeFrame festgelegt wurden.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

---

Optional Targeting

targeting?: Record<string, string | string[]>

Einstellung zum Konfigurieren des Targetings mit Schlüssel/Wert-Paaren.

Das über diese Einstellung konfigurierte Targeting gilt nur für die Anzeigenfläche. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Targeting-Schlüssel/Wert-Paare zu definieren oder vorhandene Werte zu überschreiben. Targeting-Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.

Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

Weitere Informationen

• Targeting auf Schlüssel/Wert-Paare

---

googletag.config.TaxonomyData

Ein Objekt, das die Werte für eine einzelne Taxonomie enthält.

Attribute
values	Eine Liste mit Taxonomiewerten.

Attribute

---

Werte

values: readonly string[]

Eine Liste mit Taxonomiewerten.

---

googletag.config.VideoAdsConfig

Einstellungen zum Konfigurieren von Einstellungen für Videoanzeigen.

Attribute
enableVideoAds	Gibt an, ob Videoanzeigen auf der Seite vorhanden sind.
videoCmsId?	Die ID der Video-Contentquelle.
videoContentId?	Die ID des Videoinhalts.

Weitere Informationen

• PageSettingsConfig.videoAds

Attribute

---

enableVideoAds

enableVideoAds: boolean

Gibt an, ob Videoanzeigen auf der Seite vorhanden sind.

Wenn dieser Wert auf true festgelegt ist, werden Einschränkungen für auszuschließende Inhalte für Display- und Videoanzeigen aktiviert.

Wenn der Videoinhalt bekannt ist, legen Sie videoContentId und videoCmsId auf die Werte fest, die für den Dienst zur Contentaufnahme in Google Ad Manager bereitgestellt wurden, um auszuschließende Inhalte für Displayanzeigen zu verwenden.

---

Optional videoCmsId

videoCmsId?: string

Die ID der Video-Contentquelle.

Dies ist ein eindeutiger Wert, der vom Contentaufnahmedienst von Google Ad Manager zugewiesen wird, um die Quelle des Videocontents zu identifizieren, der durch videoContentId angegeben wird.

Weitere Informationen

• cmsid (ID der Contentquelle)

---

Optional videoContentId

videoContentId?: string

Die ID des Videocontents.

Dies ist ein eindeutiger Wert, der ein bestimmtes Video aus der durch videoCmsId angegebenen Contentquelle identifiziert. Dieser Wert wird vom CMS zugewiesen, das Ihre Videoinhalte hostet.

Weitere Informationen

• vid (Video-ID)

---

googletag.enums

Dies ist der Namespace, den GPT für Enum-Typen verwendet.

Aufzählungen
OutOfPageFormat	Von GPT unterstützte Out-of-Page-Formate.
TagForAgeTreatment	Von GPT unterstützte Einstellungen für die Alterskennzeichnung.
TrafficSource	Traffic-Quellen, die von GPT unterstützt werden.

Aufzählungen

---

OutOfPageFormat

OutOfPageFormat

Von GPT unterstützte Out-of-Page-Formate

Weitere Informationen

• defineOutOfPageSlot

Enumeration-Mitglieder
AD_INTENTS	Format für auf der Nutzerabsicht basierende Links, Chips und Anker
BOTTOM_ANCHOR	Ankerformat, bei dem die Anzeigenfläche am unteren Rand des Darstellungsbereichs fixiert ist.
GAME_MANUAL_INTERSTITIAL	Manuelles Interstitial-Format für Spiele. Hinweis: Manuelle Interstitials für Spiele sind ein Format mit eingeschränktem Zugriff.
INTERSTITIAL	Creative-Format für Web-Interstitials.
LEFT_SIDE_RAIL	Format für den seitlichen Anzeigenstreifen links.
REWARDED	Anzeigen mit Prämie
RIGHT_SIDE_RAIL	Format für den seitlichen Anzeigenstreifen rechts.
TOP_ANCHOR	Ankerformat, bei dem die Anzeigenfläche oben im Darstellungsbereich fixiert ist.

---

TagForAgeTreatment

TagForAgeTreatment

Von GPT unterstützte Einstellungen für die Alterskennzeichnung.

Weitere Informationen

• PrivacySettingsConfig.tagForAgeTreatment

Enumeration-Mitglieder
CHILD	Gibt an, dass Anzeigenanfragen eine Alterskennzeichnung für Kinder erhalten sollen.
TEEN	Gibt an, dass Anzeigenanfragen eine Alterskennzeichnung für Teenager erhalten sollen.
UNSPECIFIED	Standardwert. Gibt an, dass für die Anzeigenanfrage kein bestimmtes Signal für die Altersbeschränkung gilt.

---

TrafficSource

TrafficSource

Traffic-Quellen, die von GPT unterstützt werden.

Weitere Informationen

• PrivacySettingsConfig.trafficSource

Enumeration-Mitglieder
ORGANIC	Der Nutzer erreicht Sie über einen direkten URL-Eintrag, die Websitesuche oder einen App-Download.
PURCHASED	Traffic, der von Properties weitergeleitet wurde, die nicht den Status „Eigene“ haben, z. B. über Akquisitionen oder anderweitig auf Incentives basierende Aktivitäten.

---

googletag.events

Dies ist der Namespace, den GPT für Ereignisse verwendet. Ihr Code kann mit Service.addEventListener auf diese Ereignisse reagieren.

Schnittstellen
Event	Basisschnittstelle für alle GPT-Ereignisse.
EventTypeMap	Dies ist ein Pseudotyp, der einen Ereignisnamen dem entsprechenden Ereignisobjekttyp für Service.addEventListener und Service.removeEventListener zuordnet.
GameManualInterstitialSlotClosedEvent	Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Anzeigenfläche für Spiele vom Nutzer geschlossen wurde.
GameManualInterstitialSlotReadyEvent	Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Anzeigenfläche für Spiele zur Schaltung bereit ist.
ImpressionViewableEvent	Dieses Ereignis wird ausgelöst, wenn eine Impression gemäß den Active View-Kriterien sichtbar wird.
RewardedSlotClosedEvent	Dieses Ereignis wird ausgelöst, wenn eine Anzeigenfläche für Anzeigen mit Prämie vom Nutzer geschlossen wird.
RewardedSlotGrantedEvent	Dieses Ereignis wird ausgelöst, wenn eine Prämie für das Ansehen einer Anzeige mit Prämie gewährt wird.
RewardedSlotReadyEvent	Dieses Ereignis wird ausgelöst, wenn eine Anzeige mit Prämie bereit ist, angezeigt zu werden.
RewardedSlotVideoCompletedEvent	Dieses Ereignis wird ausgelöst, wenn die Wiedergabe einer Videoanzeige mit Prämie beendet ist.
SlotOnloadEvent	Dieses Ereignis wird ausgelöst, wenn der iFrame des Creatives sein Ladeereignis auslöst.
SlotRenderEndedEvent	Dieses Ereignis wird ausgelöst, wenn der Creative-Code in eine Anzeigenfläche eingefügt wird.
SlotRequestedEvent	Dieses Ereignis wird ausgelöst, wenn eine Anzeige für eine bestimmte Anzeigenfläche angefordert wurde.
SlotResponseReceived	Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für eine bestimmte Anzeigenfläche empfangen wurde.
SlotVisibilityChangedEvent	Dieses Ereignis wird immer dann ausgelöst, wenn sich der Prozentsatz der auf dem Bildschirm sichtbaren Fläche einer Anzeigenfläche ändert.

---

googletag.events.Event

Basisschnittstelle für alle GPT-Ereignisse. Alle unten aufgeführten GPT-Ereignisse enthalten die folgenden Felder.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat.
slot	Der Slot, der das Ereignis ausgelöst hat.

Weitere Informationen

• Anzeigenereignis-Listener

Attribute

---

serviceName

serviceName: string

Name des Dienstes, der das Ereignis ausgelöst hat.

---

slot

slot: Slot

Der Slot, der das Ereignis ausgelöst hat.

---

googletag.events.EventTypeMap

Dies ist ein Pseudotyp, der einen Ereignisnamen dem entsprechenden Ereignisobjekttyp für Service.addEventListener und Service.removeEventListener zuordnet. Sie ist nur zu Referenzzwecken und zur Typsicherheit dokumentiert.

Attribute
gameManualInterstitialSlotClosed	Alias für events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Alias für events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Alias für events.ImpressionViewableEvent.
rewardedSlotClosed	Alias für events.RewardedSlotClosedEvent.
rewardedSlotGranted	Alias für events.RewardedSlotGrantedEvent.
rewardedSlotReady	Alias für events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted	Alias für events.RewardedSlotVideoCompletedEvent.
slotOnload	Alias für events.SlotOnloadEvent.
slotRenderEnded	Alias für events.SlotRenderEndedEvent.
slotRequested	Alias für events.SlotRequestedEvent.
slotResponseReceived	Alias für events.SlotResponseReceived.
slotVisibilityChanged	Alias für events.SlotVisibilityChangedEvent.

Attribute

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Alias für events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Alias für events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

Alias für events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Alias für events.RewardedSlotClosedEvent.

---

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Alias für events.RewardedSlotGrantedEvent.

---

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Alias für events.RewardedSlotReadyEvent.

---

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent

Alias für events.RewardedSlotVideoCompletedEvent.

---

slotOnload

slotOnload: SlotOnloadEvent

Alias für events.SlotOnloadEvent.

---

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Alias für events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

Alias für events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Alias für events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Alias für events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Anzeigenfläche für Spiele vom Nutzer geschlossen wurde.

Hinweis: Manuelle Interstitials für Spiele sind ein Format mit eingeschränktem Zugriff.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (alt)

// This listener is called when a game manual interstitial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Weitere Informationen

• Anzeigenereignis-Listener
• Manuelle Interstitial-Anzeige für Spiele ausliefern

---

googletag.events.GameManualInterstitialSlotReadyEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Anzeigenfläche für Spiele zur Schaltung bereit ist.

Hinweis: Manuelle Interstitial-Anzeigen für Spiele sind ein Format mit eingeschränktem Zugriff.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Methoden
makeGameManualInterstitialVisible	Die manuelle Interstitial-Anzeige für Spiele wird dem Nutzer präsentiert.

Beispiel

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (alt)

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) {
    var slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    var displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Weitere Informationen

• Anzeigenereignis-Listener
• Manuelle Interstitial-Anzeige für Spiele ausliefern

Methoden

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean

Die manuelle Interstitial-Anzeige für Spiele wird dem Nutzer präsentiert. Gibt zurück, ob die Anzeige erfolgreich ausgeliefert wurde.

Ausgabe
boolean

---

googletag.events.ImpressionViewableEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine Impression gemäß den Active View-Kriterien sichtbar wird.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (alt)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Weitere Informationen

• Anzeigenereignis-Listener

---

googletag.events.RewardedSlotClosedEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeigenfläche für Anzeigen mit Prämie vom Nutzer geschlossen wird. Es kann entweder vor oder nach der Gewährung einer Prämie ausgelöst werden. Verwenden Sie stattdessen events.RewardedSlotGrantedEvent, um festzustellen, ob eine Prämie gewährt wurde.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (alt)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Weitere Informationen

• Anzeigenereignis-Listener
• Anzeige mit Prämie einblenden

---

googletag.events.RewardedSlotGrantedEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine Prämie für das Ansehen einer Anzeige mit Prämie gewährt wird. Wenn die Anzeige geschlossen wird, bevor die Kriterien für die Gewährung einer Prämie erfüllt sind, wird dieses Ereignis nicht ausgelöst.

Attribute
payload	Ein Objekt mit Informationen zur gewährten Prämie.
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (alt)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
    var _a, _b;
    var slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
    console.log(
      "Reward amount:",
      (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount,
    );
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Weitere Informationen

• Anzeigenereignis-Listener
• Anzeige mit Prämie einblenden

Attribute

---

payload

payload: RewardedPayload

Ein Objekt mit Informationen zur gewährten Prämie.

---

googletag.events.RewardedSlotReadyEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeige mit Prämie bereit ist, angezeigt zu werden. Der Publisher ist dafür verantwortlich, dem Nutzer die Möglichkeit zu geben, die Anzeige anzusehen, bevor sie eingeblendet wird.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Methoden
makeRewardedVisible	Die Anzeige mit Prämie wird eingeblendet.

Beispiel

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    const userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (alt)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
    var slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    var userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    const userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Weitere Informationen

• Anzeigenereignis-Listener
• Anzeige mit Prämie einblenden

Methoden

---

makeRewardedVisible

makeRewardedVisible(): boolean

Die Anzeige mit Prämie wird eingeblendet. Diese Methode sollte erst aufgerufen werden, wenn der Nutzer zugestimmt hat, die Anzeige zu sehen.

Ausgabe
boolean	Gibt an, ob die Anzeige mit Prämie erfolgreich ausgeliefert wurde.

---

googletag.events.RewardedSlotVideoCompletedEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn die Wiedergabe einer Videoanzeige mit Prämie beendet ist.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (alt)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", function (event) {
    var slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Weitere Informationen

• Anzeigenereignis-Listener
• Anzeige mit Prämie einblenden

---

googletag.events.SlotOnloadEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn der iFrame des Creatives sein Ladeereignis auslöst. Wenn Rich Media-Anzeigen im synchronen Rendering-Modus gerendert werden, wird kein iFrame verwendet. Daher wird kein SlotOnloadEvent ausgelöst.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (alt)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Weitere Informationen

• Anzeigenereignis-Listener

---

googletag.events.SlotRenderEndedEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn der Creative-Code in eine Anzeigenfläche eingefügt wird. Dieses Ereignis tritt auf, bevor die Ressourcen des Creatives abgerufen werden. Das Creative ist also möglicherweise noch nicht sichtbar. Wenn Sie wissen möchten, wann alle Creative-Ressourcen für eine Anzeigenfläche geladen wurden, sollten Sie stattdessen events.SlotOnloadEvent verwenden.

Attribute
advertiserId	Werbetreibenden-ID der gerenderten Anzeige.
campaignId	Kampagnen-ID der gerenderten Anzeige.
companyIds	IDs der Unternehmen, die auf die gerenderte Backfill-Anzeige geboten haben.
creativeId	Creative-ID der gerenderten Reservierungsanzeige.
creativeTemplateId	Creative-Vorlagen-ID der gerenderten Reservierungsanzeige.
isBackfill	Gibt an, ob eine Anzeige eine Backfill-Anzeige war.
isEmpty	Gibt an, ob für die Anzeigenfläche eine Anzeige zurückgegeben wurde.
labelIds	Veraltet.
lineItemId	Werbebuchungs-ID der gerenderten Reservierungsanzeige.
responseIdentifier	Die Antwortkennung ist eine eindeutige Kennung für die Anzeigenantwort.
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
size	Gibt die Pixelgröße des gerenderten Creatives an.
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen
slotContentChanged	Gibt an, ob der Inhalt der Anzeigenfläche mit der gerenderten Anzeige geändert wurde.
sourceAgnosticCreativeId	Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige.
sourceAgnosticLineItemId	Werbebuchungs-ID der gerenderten Reservierungs- oder Backfill-Anzeige.
yieldGroupIds	IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige.

Beispiel

JavaScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (alt)

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Weitere Informationen

• Anzeigenereignis-Listener

Attribute

---

advertiserId

advertiserId: number

Werbetreibenden-ID der gerenderten Anzeige. Der Wert ist null für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

---

campaignId

campaignId: number

Kampagnen-ID der gerenderten Anzeige. Der Wert ist null für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

---

companyIds

companyIds: number[]

IDs der Unternehmen, die auf die gerenderte Backfill-Anzeige geboten haben. Der Wert ist null für leere Anzeigenflächen, Reservierungsanzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

---

creativeId

creativeId: number

Creative-ID der gerenderten Reservierungsanzeige. Der Wert ist null für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

---

creativeTemplateId

creativeTemplateId: number

Creative-Vorlagen-ID der gerenderten Reservierungsanzeige. Der Wert ist null für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

---

isBackfill

isBackfill: boolean

Gibt an, ob eine Anzeige eine Backfill-Anzeige war. Der Wert ist true, wenn die Anzeige eine Backfill-Anzeige war, andernfalls false.

---

isEmpty

isEmpty: boolean

Gibt an, ob für die Anzeigenfläche eine Anzeige zurückgegeben wurde. Der Wert ist true, wenn keine Anzeige zurückgegeben wurde, andernfalls false.

---

labelIds

labelIds: number[]

Eingestellt: Dieses Feld wird nicht mehr ausgefüllt.

---

lineItemId

lineItemId: number

Werbebuchungs-ID der gerenderten Reservierungsanzeige. Der Wert ist null für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

---

responseIdentifier

responseIdentifier: string

Die Antwortkennung ist eine eindeutige Kennung für die Anzeigenantwort. Mit diesem Wert kann die Anzeige im Überprüfungszentrum für Anzeigen gefunden und blockiert werden.

---

size

size: string | number[]

Gibt die Pixelgröße des gerenderten Creatives an. Beispiel: [728, 90]. Der Wert ist null für leere Anzeigenflächen.

---

slotContentChanged

slotContentChanged: boolean

Gibt an, ob der Inhalt der Anzeigenfläche mit der gerenderten Anzeige geändert wurde. Der Wert ist true, wenn der Inhalt geändert wurde, andernfalls false.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige. Der Wert ist null, wenn die Anzeige kein Backfill für eine Reservierung oder Werbebuchung ist oder das Creative von anderen Diensten als PubAdsService gerendert wird.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number

Werbebuchungs-ID der gerenderten Reservierungs- oder Backfill-Anzeige. Der Wert ist null, wenn die Anzeige kein Backfill für eine Reservierung oder Werbebuchung ist oder das Creative von anderen Diensten als PubAdsService gerendert wird.

---

yieldGroupIds

yieldGroupIds: number[]

IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige. Der Wert ist null für leere Anzeigenflächen, Reservierungsanzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

---

googletag.events.SlotRequestedEvent

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeige für eine bestimmte Anzeigenfläche angefordert wurde.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (alt)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Weitere Informationen

• Anzeigenereignis-Listener

---

googletag.events.SlotResponseReceived

Erweitert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für eine bestimmte Anzeigenfläche empfangen wurde.

Attribute
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (alt)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Weitere Informationen

• Anzeigenereignis-Listener

---

googletag.events.SlotVisibilityChangedEvent

Erweitert Event

Dieses Ereignis wird immer dann ausgelöst, wenn sich der Prozentsatz der auf dem Bildschirm sichtbaren Fläche einer Anzeigenfläche ändert. Das Ereignis wird gedrosselt und nicht häufiger als alle 200 ms ausgelöst.

Attribute
inViewPercentage	Der Prozentsatz der sichtbaren Anzeigenfläche.
serviceName	Name des Dienstes, der das Ereignis ausgelöst hat. Von der Property Event.serviceName übernommen
slot	Der Slot, der das Ereignis ausgelöst hat. Von der Property Event.slot übernommen

Beispiel

JavaScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (alt)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Weitere Informationen

• Anzeigenereignis-Listener

Attribute

---

inViewPercentage

inViewPercentage: number

Der Prozentsatz der sichtbaren Anzeigenfläche. Der Wert ist eine Zahl zwischen 0 und 100.

---

googletag.secureSignals

Das ist der Namespace, den GPT zum Verwalten sicherer Signale verwendet.

Schnittstellen
BidderSignalProvider	Gibt ein sicheres Signal für einen bestimmten Bieter zurück.
PublisherSignalProvider	Gibt ein sicheres Signal für einen bestimmten Publisher zurück.
SecureSignalProvidersArray	Eine Oberfläche zum Verwalten sicherer Signale.

Typaliasse
SecureSignalProvider	Schnittstelle zum Zurückgeben eines sicheren Signals für einen bestimmten Bieter oder Anbieter.

Typaliasse

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Schnittstelle zum Zurückgeben eines sicheren Signals für einen bestimmten Bieter oder Anbieter. Es muss entweder id oder networkCode angegeben werden, aber nicht beides.

---

googletag.secureSignals.BidderSignalProvider

Gibt ein sicheres Signal für einen bestimmten Bieter zurück.

Ein Anbieter von sicheren Signalen für Bieter besteht aus zwei Teilen:

1. Eine Collector-Funktion, die ein Promise-Objekt zurückgibt, das in ein sicheres Signal aufgelöst wird.
2. Eine id, die den Bieter identifiziert, der mit dem Signal verknüpft ist.

Wenn Sie ein sicheres Signal für einen Publisher zurückgeben möchten, verwenden Sie stattdessen secureSignals.PublisherSignalProvider.

Attribute
collectorFunction	Eine Funktion, die ein Promise-Objekt zurückgibt, das in ein sicheres Signal aufgelöst wird.
id	Eine eindeutige Kennung für den Collector, der mit diesem sicheren Signal verknüpft ist, wie in Google Ad Manager registriert.

Beispiel

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (alt)

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

Weitere Informationen

• Sichere Signale für Bieter freigeben

Attribute

---

collectorFunction

collectorFunction: (() => Promise<string>)

Eine Funktion, die ein Promise-Objekt zurückgibt, das in ein sicheres Signal aufgelöst wird.

---

id

id: string

Eine eindeutige Kennung für den Collector, der mit diesem sicheren Signal verknüpft ist, wie in Google Ad Manager registriert.

---

googletag.secureSignals.PublisherSignalProvider

Gibt ein sicheres Signal für einen bestimmten Publisher zurück.

Ein Anbieter von Publisher-Signalen besteht aus zwei Teilen:

1. Eine Collector-Funktion, die ein Promise-Objekt zurückgibt, das in ein sicheres Signal aufgelöst wird.
2. Ein networkCode, das den Publisher identifiziert, der mit dem Signal verknüpft ist.

Wenn Sie ein sicheres Signal für einen Bieter zurückgeben möchten, verwenden Sie stattdessen secureSignals.BidderSignalProvider.

Attribute
collectorFunction	Eine Funktion, die ein Promise-Objekt zurückgibt, das in ein sicheres Signal aufgelöst wird.
networkCode	Der Netzwerkcode (wie im Pfad des Anzeigenblocks zu sehen) für den Publisher, der mit diesem sicheren Signal verknüpft ist.

Beispiel

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (alt)

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

Weitere Informationen

• Sichere Signale für Bieter freigeben

Attribute

---

collectorFunction

collectorFunction: (() => Promise<string>)

Eine Funktion, die ein Promise-Objekt zurückgibt, das in ein sicheres Signal aufgelöst wird.

---

networkCode

networkCode: string

Der Netzwerkcode (wie im Pfad des Anzeigenblocks zu sehen) für den Publisher, der mit diesem sicheren Signal verknüpft ist.

---

googletag.secureSignals.SecureSignalProvidersArray

Eine Oberfläche zum Verwalten sicherer Signale.

Methoden
clearAllCache	Löscht alle Signale für alle Collectors aus dem Cache.
push	Fügt dem Array der Signalanbieter einen neuen secureSignals.SecureSignalProvider hinzu und startet den Prozess der Signalgenerierung.

Methoden

---

clearAllCache

clearAllCache(): void

Löscht alle Signale für alle Collectors aus dem Cache.

Wenn Sie diese Methode aufrufen, werden Signale möglicherweise seltener in Anzeigenanfragen für den aktuellen und potenziell späteren Seitenaufruf einbezogen. Daher sollte sie nur aufgerufen werden, wenn sich der Status wesentlich ändert, z. B. bei Ereignissen, die auf einen neuen Nutzer hinweisen (Anmeldung, Abmeldung, Registrierung usw.).

---

push

push(provider: SecureSignalProvider): void

Fügt dem Array der Signalanbieter einen neuen secureSignals.SecureSignalProvider hinzu und startet den Prozess der Signalgenerierung.

Parameter
provider: SecureSignalProvider	Das secureSignals.SecureSignalProvider-Objekt, das dem Array hinzugefügt werden soll.