GPT-Referenz

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

Typausdruck
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 in dieser Reihenfolge eine Zahl und einen String 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 .

Typanmerkungen

Ein Doppelpunkt nach einer Variablen, einem Parameternamen, einem Attributnamen oder einer Funktionssignatur kennzeichnet eine Typanmerkung. Typanmerkungen beschreiben die Typen, die das Element links vom Doppelpunkt akzeptieren oder zurückgeben kann. Die folgende Tabelle enthält Beispiele für Typanmerkungen, die in dieser Referenz vorkommen 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 ein String akzeptiert, wenn es angegeben wird. Diese Syntax wird für Parameter und Properties verwendet.
...params: Array<() => void> Gibt an, dass params ein Restparameter ist, der Funktionen akzeptiert. Rest-Parameter können eine unbegrenzte Anzahl von Werten des angegebenen Typs annehmen.

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 Enumerationstypen verwendet.
events
Dies ist der Namespace, den GPT für Ereignisse verwendet.
secureSignals
Dies ist der Namespace, den GPT zum Verwalten sicherer Signale verwendet.
Schnittstellen
CommandArray
Das Befehls-Array akzeptiert eine Folge von Funktionen und ruft sie in der angegebenen Reihenfolge auf.
CompanionAdsService
Companion-Anzeigen-Dienst
PrivacySettingsConfig
Konfigurationsobjekt für Datenschutzeinstellungen.
PubAdsService
Publisher-Anzeigendienst.
ResponseInformation
Ein Objekt, das eine einzelne Anzeigenantwort darstellt.
RewardedPayload
Ein Objekt, das die mit einer Anzeige mit Prämie verknüpfte Prämie darstellt.
Service
Basisdienstklasse mit Methoden, die für alle Dienste üblich sind.
SizeMappingBuilder
Builder für Spezifikationsobjekte für die Größenanpassung.
Slot
Ein Slot ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt.
Typaliasse
GeneralSize
Eine gültige Größenkonfiguration für einen Slot, die eine oder mehrere Größen umfassen kann.
MultiSize
Eine Liste mit einzelnen gültigen Größen.
NamedSize
Benannte Größen, die ein Slot haben kann.
SingleSize
Eine gültige Größe für einen Slot.
SingleSizeArray
Array mit zwei Zahlen, die [Breite, Höhe] darstellen.
SizeMapping
Eine Zuordnung von Darstellungsbereichsgröße zu Anzeigengrößen.
SizeMappingArray
Eine Liste der Größen-Mappings.
Variablen
apiReady
Flag, das angibt, dass die GPT API geladen wurde und aufgerufen werden kann.
cmd
Referenz zur globalen 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
Löscht die angegebenen Slots und entfernt alle zugehörigen Objekte und Verweise dieser Slots 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 allgemeine Konfigurationsoptionen für die Seite ab, die mit setConfig festgelegt wurde.
getVersion
Gibt die aktuelle Version von GPT zurück.
openConsole
Öffnet die Google Publisher Console.
pubads
Gibt einen Verweis auf 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


GeneralSize

GeneralSize: SingleSize | MultiSize
Eine gültige Größenkonfiguration für einen Slot, die eine oder mehrere Größen umfassen kann.

MultiSize

MultiSize: SingleSize[]
Eine Liste mit einzelnen gültigen Größen.

NamedSize

NamedSize: "fluid" | ["fluid"]
Benannte Größen, die ein Slot haben kann. In den meisten Fällen ist die Größe ein Rechteck mit fester Größe. Es gibt jedoch einige Fälle, in denen wir andere Größenangaben benötigen. Nur die folgenden benannten Größen sind gültig:
  • Flexibel: Der Anzeigen-Container hat eine Breite von 100% des übergeordneten div-Elements und die Höhe wird an den Creative-Inhalt angepasst. Ähnlich wie bei normalen Blockelementen auf einer Seite. Wird für native Anzeigen verwendet (siehe zugehörigen Artikel). Sowohl fluid als auch ['fluid'] sind zulässige Formen, um eine Slotgröße als responsiv zu deklarieren.

SingleSize

Eine gültige Größe für einen Slot.

SingleSizeArray

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

SizeMapping

Eine Zuordnung von Darstellungsbereichsgröße zu Anzeigengrößen. Wird für responsive Anzeigen verwendet.

SizeMappingArray

SizeMappingArray: SizeMapping[]
Eine Liste der Größen-Mappings.

Variablen


Const apiReady

apiReady: boolean | undefined
Flag, das angibt, dass die GPT API geladen wurde und aufgerufen werden kann. Diese Eigenschaft ist einfach undefined, bis die API bereit ist.

Die empfohlene Methode für die asynchrone Verarbeitung ist die Verwendung von googletag.cmd, um Callbacks in die Warteschlange zu stellen, bis 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-Tag-Syntax auf der Seite in ein leeres JavaScript-Array initialisiert und cmd.push ist die Standardmethode Array.push, mit der ein Element am Ende des Arrays hinzugefügt wird. Wenn das GPT-JavaScript geladen wird, durchsucht es das Array und führt alle Funktionen in der richtigen Reihenfolge aus. Das Skript ersetzt dann cmd durch ein CommandArray-Objekt, dessen Push-Methode so definiert ist, dass das an sie übergebene Funktionsargument ausgeführt wird. Mit diesem Mechanismus kann GPT die wahrgenommene Latenz verringern, 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. Diese Property 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 Folge von signalgenerierenden Funktionen und ruft sie in der Reihenfolge auf. Es soll ein Standard-Array ersetzen, das verwendet wird, um signalgenerierende Funktionen in die Warteschlange zu stellen, die aufgerufen werden sollen, sobald 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

Funktionen


companionAds

companionAds(): CompanionAdsService
Gibt einen Verweis auf den CompanionAdsService zurück.
Ausgabe
CompanionAdsServiceDer Dienst für Companion-Anzeigen.

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 soll. Weitere Informationen finden Sie im Artikel zu Out-of-Page-Creatives.

Bei Out-of-Page-Anzeigen, die von GPT verwaltet werden, 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
Parameter
adUnitPath: stringVollständiger Anzeigenblock-Pfad mit dem Netzwerkcode und dem Anzeigenblockcode.
Optional div: string | OutOfPageFormatID des DIV-Elements, das diesen Anzeigenblock oder das Out-of-Page-Format enthält.
Ausgabe
Slot | nullDer neu erstellte Slot oder null, wenn kein Slot erstellt werden kann.

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
Erstellt eine Anzeigenfläche mit einem bestimmten Anzeigenblock-Pfad und einer bestimmten Größe und verknüpft sie mit der ID eines Div-Elements auf der Seite, das die Anzeige enthalten soll.
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
Parameter
adUnitPath: stringVollständiger Anzeigenblock-Pfad mit dem Netzwerkcode und dem Code des Anzeigenblocks.
size: GeneralSizeBreite und Höhe des hinzugefügten Slots. Diese Größe wird in der Anzeigenanfrage verwendet, wenn keine responsive Größenanpassung angegeben ist oder die Größe des Viewports kleiner ist als die kleinste Größe in der Anpassung.
Optional div: stringID des DIV-Elements, das diesen Anzeigenblock enthält.
Ausgabe
Slot | nullDer neu erstellte Slot oder null, wenn kein Slot erstellt werden kann.

destroySlots

destroySlots(slots?: Slot[]): boolean
Löscht die angegebenen Slots und entfernt alle zugehörigen Objekte und Verweise dieser Slots aus GPT. Diese API unterstützt keine Passback-Slots und Companion-Slots.

Wenn Sie diese API für einen Slot aufrufen, wird die Anzeige gelöscht und das Slot-Objekt aus dem internen Status entfernt, der von GPT verwaltet wird. Wenn Sie weitere Funktionen für das Slot-Objekt aufrufen, ist das Verhalten nicht definiert. Hinweis: Der Browser gibt den Speicher, der diesem Slot zugeordnet ist, möglicherweise nicht kostenlos, wenn die Publisher-Seite eine Referenz darauf beibehält. Durch den Aufruf dieser API wird das mit dieser Anzeigenfläche verknüpfte Div-Element zur Wiederverwendung verfügbar.

Wenn Sie eine Anzeigenfläche entfernen, wird die Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden daher nicht durch Roadblocks oder Ausschlüsse von konkurrierenden Anzeigen beeinflusst, die diese Anzeige betreffen. Wenn Sie diese Funktion nicht aufrufen, bevor Sie das DIV-Element eines Slots von der Seite entfernen, kann das zu einem nicht definierten Verhalten führen.
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 Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots zerstört.
Ausgabe
booleantrue, wenn Slots zerstört wurden, andernfalls false.

disablePublisherConsole

disablePublisherConsole(): void
Deaktiviert die Google Publisher Console.
Weitere Informationen

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 sein und einen zugehörigen Dienst haben, bevor sie angezeigt werden. Der Aufruf zum Anzeigen darf erst erfolgen, wenn das Element im DOM vorhanden ist. Normalerweise wird das so erreicht, dass es in einem Script-Block innerhalb des Div-Elements platziert wird, das im Methodenaufruf angegeben ist.

Wenn die Einzelanfrage-Architektur (Single Request Architecture, SRA) verwendet wird, werden alle Anzeigenflächen, die zum Zeitpunkt des Aufrufs dieser Methode noch nicht abgerufen wurden, gleichzeitig abgerufen. Wenn ein Anzeigen-Slot nicht ausgeliefert werden soll, muss das gesamte Div-Element entfernt werden.
Weitere Informationen
Parameter
divOrSlot: string | Element | SlotEntweder die ID des div-Elements, das den Anzeigenblock enthält, oder das div-Element oder das Slot-Objekt. Wenn ein div-Element angegeben wird, muss es ein „id“-Attribut haben, das mit der ID übereinstimmt, die an defineSlot übergeben wird.

enableServices

enableServices(): void
Aktiviert alle GPT-Dienste, die für Anzeigenflächen auf der Seite definiert wurden.

getConfig

getConfig(keys: string | string[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">
Ruft allgemeine Konfigurationsoptionen für die Seite ab, die mit setConfig festgelegt wurden.

Nicht alle setConfig()-Properties werden von dieser Methode unterstützt. Unterstützte Eigenschaften:
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
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">Die Konfigurationsoptionen für den Slot.

getVersion

getVersion(): string
Gibt die aktuelle Version von GPT zurück.
Weitere Informationen
Ausgabe
stringDer String der aktuell ausgeführten GPT-Version.

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
Parameter
Optional div: stringDie ID eines Anzeigenflächen-Div. Dieser Wert ist optional. Wenn die Publisher Console geöffnet wird, werden nach Möglichkeit Details zum angegebenen Anzeigenblock angezeigt.

pubads

pubads(): PubAdsService
Gibt einen Verweis auf PubAdsService zurück.
Ausgabe
PubAdsServiceDer 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: stringDer neue Titel für alle Anzeigencontainer-IFrames.

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
Ausgabe
SizeMappingBuilderEin neuer Builder.

googletag.CommandArray

Das Befehls-Array akzeptiert eine Folge von Funktionen und ruft sie in der angegebenen Reihenfolge auf. Es soll ein Standard-Array ersetzen, das zum Einreihen von Funktionen verwendet wird, die aufgerufen werden sollen, sobald GPT geladen ist.
Methoden
push
Führt die Reihenfolge der in den Argumenten angegebenen Funktionen aus.

Methoden


push

push(...f: ((this: typeof globalThis) => void)[]): number
Führt die Reihenfolge der in den Argumenten angegebenen Funktionen 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 sollten eine Pfeilfunktion übergeben, um den this-Wert des einschließenden lexikalischen Kontexts beizubehalten.
Ausgabe
numberDie 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
Companion-Anzeigen-Dienst Dieser Dienst wird von Videoanzeigen verwendet, um Companion-Anzeigen zu präsentieren.
Methoden
addEventListener
Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt.
getSlots
Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
removeEventListener
Entfernt einen zuvor registrierten Listener.
setRefreshUnfilledSlots
Legt fest, ob Companion-Flächen, die nicht gefüllt wurden, automatisch mit Backfill-Anzeigen gefüllt werden.
Weitere Informationen

Methoden


setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void
Legt fest, ob Companion-Flächen, die nicht gefüllt wurden, automatisch mit einem Backfill versehen werden.

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 einem Backfill versehen. Aufgrund von Richtlinienbeschränkungen ist diese Methode nicht dafür vorgesehen, leere Companion-Slots 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: booleantrue – nicht ausgefüllte Slots werden automatisch mit Backfill-Anzeigen gefüllt. false – nicht ausgefüllte Slots bleiben unverändert.

googletag.PrivacySettingsConfig

Konfigurationsobjekt für Datenschutzeinstellungen.
Attribute
childDirectedTreatment?
limitedAds?
Ermöglicht die Anzeigenbereitstellung im Modus eingeschränkte Anzeigenausrichtung, um Publisher bei der Einhaltung gesetzlicher Auflagen zu unterstützen.
nonPersonalizedAds?
Ermöglicht die Auslieferung im Modus nicht personalisierte Anzeigen, um Publisher bei der Einhaltung von Vorschriften zu unterstützen.
restrictDataProcessing?
Ermöglicht die Anzeigenbereitstellung im Modus für eingeschränkte Verarbeitung, um Publisher bei der Einhaltung gesetzlicher Vorschriften zu unterstützen.
trafficSource?
Gibt an, ob Anfragen gekauften oder organischen Traffic darstellen.
underAgeOfConsent?
Gibt an, ob Anzeigenanfragen als von Nutzern unter dem gültigen Mindestalter stammend gekennzeichnet werden sollen.
Weitere Informationen

Attribute


Optional childDirectedTreatment

childDirectedTreatment?: boolean
Gibt an, ob die Seite als Inhalte für Kinder behandelt werden soll. Auf null gesetzt, um die Konfiguration zu löschen.

Optional limitedAds

limitedAds?: boolean
Ermöglicht die Anzeigenbereitstellung im Modus eingeschränkte Anzeigenausrichtung, um Publisher bei der Einhaltung von behördlichen Anforderungen zu unterstützen.

Sie können GPT auf zwei Arten anweisen, Anzeigen mit eingeschränkter Ausrichtung anzufordern:
  • Automatisch über ein Signal von einer IAB TCF 2.0-Plattform zur Einwilligungsverwaltung.
  • 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 das eingeschränkte Anzeigen-Targeting geladen wird. Wenn Sie versuchen, diese Einstellung zu ändern, nachdem 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, die eingeschränkte Anzeigenausrichtung 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

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean
Ermöglicht die Auslieferung im Modus nicht personalisierte Anzeigen, um Publisher bei der Einhaltung von Vorschriften zu unterstützen.

Optional restrictDataProcessing

restrictDataProcessing?: boolean
Ermöglicht die Anzeigenbereitstellung im Modus für eingeschränkte Verarbeitung, um Publisher bei der Einhaltung gesetzlicher Vorschriften zu unterstützen.

Optional trafficSource

trafficSource?: TrafficSource
Gibt an, ob Anfragen gekauften oder organischen Traffic darstellen. Mit diesem Wert wird die Dimension Traffic-Quelle in Ad Manager-Berichten gefüllt. Wenn nichts anderes festgelegt ist, wird in Berichten standardmäßig die Besucherquelle undefined 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 unter dem gültigen Mindestalter stammend gekennzeichnet werden sollen. Auf null gesetzt, um die Konfiguration zu löschen.

googletag.PubAdsService

Erweitert Service
Publisher-Anzeigendienst. Mit diesem Dienst werden Anzeigen aus Ihrem Google Ad Manager-Konto abgerufen und präsentiert.
Methoden
addEventListener
Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt.
clear
Entfernt die Anzeigen aus den angegebenen Slots und ersetzt sie durch leere Inhalte.
clearCategoryExclusions
Eingestellt. Entfernt alle Ausschluss-Labels für Anzeigenkategorien auf Seitenebene.
clearTargeting
Eingestellt. Löscht benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel.
collapseEmptyDivs
Eingestellt. Ermöglicht das Minimieren von Slot-Divs, sodass sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt angezeigt werden soll.
disableInitialLoad
Eingestellt. Deaktiviert Anfragen für Anzeigen beim Laden der Seite, ermöglicht aber, dass Anzeigen mit einem PubAdsService.refresh-Aufruf angefordert werden.
display
Erstellt und zeigt eine Anzeigenfläche mit dem angegebenen Anzeigenblockpfad und der angegebenen Größe an.
enableLazyLoad
Eingestellt. Aktiviert das Lazy Loading in GPT gemäß dem Konfigurationsobjekt.
enableSingleRequest
Eingestellt. Aktiviert den Einzelanforderungsmodus zum Abrufen mehrerer Anzeigen gleichzeitig.
enableVideoAds
Eingestellt. Signalisiert GPT, dass auf der Seite Videoanzeigen präsentiert werden.
get
Eingestellt. Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel verknüpft ist.
getAttributeKeys
Eingestellt. Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden.
getSlots
Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
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 anfängliche Anfragen für Anzeigen durch einen vorherigen Aufruf von PubAdsService.disableInitialLoad deaktiviert wurden.
refresh
Ruft neue Anzeigen für bestimmte oder alle Slots auf der Seite ab und zeigt sie an.
removeEventListener
Entfernt einen zuvor registrierten Listener.
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. Konfiguriert, ob alle Anzeigen auf der Seite in einem SafeFrame-Container gerendert werden sollen.
setLocation
Eingestellt. Übermittelt Standortinformationen von Websites, damit Sie Werbebuchungen geografisch auf bestimmte Standorte ausrichten können.
setPrivacySettings
Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzelne 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 zum Videocontent fest, die zusammen mit den Anzeigenanfragen für Targeting- und Content-Ausschlusszwecke gesendet werden sollen.
updateCorrelator
Ändert den Korrelator, der mit Anzeigenanfragen gesendet wird, wodurch effektiv ein neuer Seitenaufruf gestartet wird.

Methoden


clear

clear(slots?: Slot[]): boolean
Entfernt die Anzeigen aus den angegebenen Slots und ersetzt sie durch leere Inhalte. Die Slots werden als „nicht abgerufen“ markiert.

Wenn Sie einen Slot leeren, wird die Anzeige insbesondere aus dem langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden daher nicht durch Roadblocks oder Ausschlüsse von konkurrierenden Anzeigen beeinflusst, die diese Anzeige betreffen.
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 Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht.
Ausgabe
booleanGibt true zurück, wenn Slots gelöscht wurden, andernfalls false.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService
Entfernt alle Ausschluss-Labels für Anzeigenkategorien auf Seitenebene. Dies ist nützlich, wenn Sie den Slot aktualisieren möchten.
Beispiel

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

JavaScript (alt)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.
Weitere Informationen
Ausgabe
PubAdsServiceDas Dienstobjekt, für das die Methode aufgerufen wurde.

clearTargeting

clearTargeting(key?: string): PubAdsService
Löscht benutzerdefinierte Targeting-Parameter für einen bestimmten oder alle Schlüssel.
Beispiel

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

JavaScript (alt)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.
Weitere Informationen
Parameter
Optional key: stringSchlüssel des Targeting-Parameters. Der Schlüssel ist optional. Wenn er nicht angegeben wird, werden alle Targeting-Parameter gelöscht.
Ausgabe
PubAdsServiceDas Dienstobjekt, für das die Methode aufgerufen wurde.

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
Ermöglicht das Minimieren von Slot-Divs, sodass sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt angezeigt werden soll. Dieser Modus muss festgelegt werden, bevor der Dienst aktiviert wird.
Weitere Informationen
Parameter
Optional collapseBeforeAdFetch: booleanGibt an, ob die Slots minimiert werden sollen, bevor die Anzeigen abgerufen werden. Dieser Parameter ist optional. Wenn er nicht angegeben wird, wird false als Standardwert verwendet.
Ausgabe
booleanGibt true zurück, wenn der Modus zum Minimieren von DIVs aktiviert wurde, und false, wenn es nicht möglich ist, den Modus zum Minimieren zu aktivieren, da die Methode nach der Aktivierung des Dienstes aufgerufen wurde.

disableInitialLoad

disableInitialLoad(): void
Deaktiviert Anfragen für Anzeigen beim Seitenaufbau, ermöglicht aber, dass Anzeigen mit einem PubAdsService.refresh-Aufruf angefordert werden. Diese Einstellung sollte vor der Aktivierung des Dienstes festgelegt werden. Der asynchrone Modus muss verwendet werden. Andernfalls ist es nicht möglich, Anzeigen mit refresh anzufordern.
Weitere Informationen

Display

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
Erstellt und zeigt eine Anzeigenfläche mit dem angegebenen Anzeigenblockpfad und der angegebenen Größe an. Diese Methode funktioniert nicht im Einzelanfragemodus.

Hinweis:Wenn diese Methode aufgerufen wird, wird ein Snapshot des Slot- und Seitenstatus erstellt, um die Konsistenz beim Senden der Anzeigenanfrage und Rendern der Antwort zu gewährleisten. Alle Änderungen, die nach dem Aufrufen dieser Methode am Slot- 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
Parameter
adUnitPath: stringDer Anzeigenblock-Pfad des zu rendernden Slots.
size: GeneralSizeBreite und Höhe des Slots.
Optional div: string | ElementEntweder die ID des DIV-Elements, das den Slot enthält, oder das DIV-Element selbst.
Optional clickUrl: stringDie Klick-URL, die für diesen Slot verwendet werden soll.

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void
Aktiviert das Lazy Loading in GPT gemäß dem Konfigurationsobjekt. Ausführlichere Beispiele finden Sie im Beispiel für Lazy Loading.

Hinweis:Lazy Fetching in SRA funktioniert nur, wenn sich alle Slots außerhalb des Fetching-Rands befinden.
Beispiel

JavaScript

googletag.pubads().enableLazyLoad({
  // 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.pubads().enableLazyLoad({
  // 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.pubads().enableLazyLoad({
  // 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
Parameter
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}
Mit dem Konfigurationsobjekt kann das Lazy-Loading-Verhalten angepasst werden. Für alle ausgelassenen 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 der Anzeigenfläche vom aktuellen Darstellungsbereich, bevor die Anzeige abgerufen wird, als Prozentsatz der Darstellungsbereichsgröße. Ein Wert von 0 bedeutet „wenn die Anzeigenfläche in den Darstellungsbereich gelangt“, 100 bedeutet „wenn die Anzeige einen Darstellungsbereich entfernt ist“ usw.
  • renderMarginPercent

     Der Mindestabstand vom aktuellen Darstellungsbereich, den ein Slot haben muss, bevor eine Anzeige gerendert wird. So kann die Anzeige vorab abgerufen werden, aber mit dem Rendern und Herunterladen anderer untergeordneter Ressourcen wird gewartet. Der Wert funktioniert wie fetchMarginPercent als Prozentsatz des Viewports.
  • mobileScaling

     Ein Multiplikator, der auf Ränder auf Mobilgeräten angewendet wird. So können Sie unterschiedliche Ränder für Mobilgeräte und Computer festlegen. Ein Wert von 2,0 multipliziert beispielsweise alle Ränder auf Mobilgeräten mit 2.Dadurch wird der Mindestabstand erhöht, den ein Slot haben kann, bevor er abgerufen und gerendert wird.

enableSingleRequest

enableSingleRequest(): boolean
Aktiviert den Einzelanfragemodus zum gleichzeitigen Abrufen mehrerer Anzeigen. Dazu müssen alle Publisher-Anzeigen-Slots definiert und dem PubAdsService hinzugefügt werden, bevor der Dienst aktiviert wird. Der Einzelanfragemodus muss festgelegt werden, bevor der Dienst aktiviert wird.
Weitere Informationen
Ausgabe
booleanGibt true zurück, wenn der Einzelanfragemodus aktiviert wurde, und false, wenn der Einzelanfragemodus nicht aktiviert werden kann, weil die Methode nach der Aktivierung des Dienstes aufgerufen wurde.

enableVideoAds

enableVideoAds(): void
Signale an GPT, dass Videoanzeigen auf der Seite präsentiert werden. So können Sie Einschränkungen für Konkurrenzausschlüsse bei Display- und Videoanzeigen festlegen. Wenn der Videocontent bekannt ist, rufen Sie PubAdsService.setVideoContent auf, um den Ausschluss von Inhalten für Displayanzeigen zu verwenden.

get

get(key: string): string
Gibt den Wert für das AdSense-Attribut zurück, das dem angegebenen Schlüssel zugeordnet ist.
Beispiel

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (alt)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
Weitere Informationen
Parameter
key: stringName des Attributs, nach dem gesucht werden soll.
Ausgabe
stringAktueller 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.
Beispiel

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (alt)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
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.
Beispiel

JavaScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

JavaScript (alt)

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

TypeScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).
Parameter
key: stringDer Targeting-Schlüssel, nach dem gesucht werden soll.
Ausgabe
string[]Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn es keinen solchen Schlüssel gibt.

getTargetingKeys

getTargetingKeys(): string[]
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden.
Beispiel

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

JavaScript (alt)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// 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 Aufruf von PubAdsService.disableInitialLoad deaktiviert wurden.
Ausgabe
booleanGibt true zurück, wenn ein vorheriger Aufruf von PubAdsService.disableInitialLoad erfolgreich war, andernfalls false.

Aktualisieren

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void
Ruft neue Anzeigen für bestimmte oder alle Slots auf der Seite ab und zeigt sie an. Funktioniert nur im asynchronen Rendermodus.

Damit das Verhalten in allen Browsern korrekt ist, muss vor dem Aufrufen von refresh ein Aufruf von display für den Anzeigen-Slot erfolgen. Wenn der Aufruf von display weggelassen wird, kann es zu unerwartetem Verhalten kommen. Bei Bedarf kann mit der Methode PubAdsService.disableInitialLoad verhindert werden, dass display eine Anzeige abruft.

Wenn ein Slot aktualisiert wird, wird die alte Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden daher nicht durch Roadblocks oder Ausschlussklauseln für konkurrierende Anzeigen beeinflusst, die diese Anzeige betreffen.
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
Parameter
Optional slots: Slot[]Die zu aktualisierenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots aktualisiert.
Optional options: {
  changeCorrelator: boolean;
}
Konfigurationsoptionen, die diesem Aktualisierungsaufruf zugeordnet sind.
  • changeCorrelator

     Gibt an, ob ein neuer Korrelator zum Abrufen von Anzeigen generiert werden soll. Auf unseren Ad-Servern wird dieser Korrelatorwert kurzzeitig gespeichert (derzeit 30 Sekunden, kann sich aber ändern). Anfragen mit demselben Korrelatorwert, 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 von GPT, der automatisch die Anzeigen auf der Seite widerspiegelt und kein Ablaufdatum hat.

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 diese Funktion für denselben Schlüssel mehrmals aufgerufen wird, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen festgelegt werden, bevor display oder refresh aufgerufen wird.
Beispiel

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");

JavaScript (alt)

googletag.pubads().set("adsense_background_color", "#FFFFFF");

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
Weitere Informationen
Parameter
key: stringDer Name des Attributs.
value: stringAttributwert.
Ausgabe
PubAdsServiceDas 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.
Beispiel

JavaScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

JavaScript (alt)

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

TypeScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
Weitere Informationen
Parameter
categoryExclusion: stringDas Label für den Ausschluss von Anzeigenkategorien, das hinzugefügt werden soll.
Ausgabe
PubAdsServiceDas 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 Version von gpt_mobile.js ist die Zentrierung standardmäßig aktiviert.

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

JavaScript

// Make ads centered.
googletag.pubads().setCentering(true);

JavaScript (alt)

// Make ads centered.
googletag.pubads().setCentering(true);

TypeScript

// Make ads centered.
googletag.pubads().setCentering(true);
Parameter
centerAds: booleantrue zum Zentrieren von Anzeigen und false zum Linksbündig ausrichten.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
Konfiguriert, ob alle Anzeigen auf der Seite in einem SafeFrame-Container gerendert werden sollen.

Beachten Sie bei der Verwendung dieser API Folgendes:
  • Diese Einstellung wird nur für nachfolgende Anzeigenanfragen für die entsprechenden Slots 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 Art des Creatives und der Auswahl in der Google Ad Manager-Benutzeroberfläche 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 darauf angewiesen sind, direkt auf der Seite eines Publishers gerendert zu werden.
Beispiel

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(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.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(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.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setForceSafeFrame(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
Parameter
forceSafeFrame: booleantrue, 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 diese Einstellung auf false setzen, wenn sie zuvor nicht angegeben wurde, ändert sich nichts.
Ausgabe
PubAdsServiceDas Dienstobjekt, für das die Methode aufgerufen wurde.

setLocation

setLocation(address: string): PubAdsService
Gibt Standortinformationen von Websites weiter, damit Sie Line-Items auf bestimmte Standorte ausrichten können.
Beispiel

JavaScript

// Postal code:
googletag.pubads().setLocation("10001,US");

JavaScript (alt)

// Postal code:
googletag.pubads().setLocation("10001,US");

TypeScript

// Postal code:
googletag.pubads().setLocation("10001,US");
Parameter
address: stringAdresse im freien Format.
Ausgabe
PubAdsServiceDas Dienstobjekt, für das die Methode aufgerufen wurde.

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzelne 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
Parameter
privacySettings: PrivacySettingsConfigObjekt mit der Konfiguration der Datenschutzeinstellungen.
Ausgabe
PubAdsServiceDas 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
Parameter
ppid: stringEine alphanumerische ID, die vom Publisher bereitgestellt wird. Muss zwischen 32 und 150 Zeichen lang sein.
Ausgabe
PubAdsServiceDas Dienstobjekt, für das die Methode aufgerufen wurde.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest. Nicht erkannte 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 Slot-Ebene überschrieben, sofern diese angegeben sind.
Beispiel

JavaScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .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.pubads().setForceSafeFrame(true);

var pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .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.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig(slotConfig)
  .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
Parameter
config: SafeFrameConfigDas Konfigurationsobjekt.
Ausgabe
PubAdsServiceDas 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 Publisher Ads-Dienstes gelten. Wenn Sie diese Funktion mehrmals für denselben Schlüssel aufrufen, werden alte Werte überschrieben. Diese Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.
Beispiel

JavaScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

JavaScript (alt)

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

TypeScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);
Weitere Informationen
Parameter
key: stringSchlüssel des Targeting-Parameters.
value: string | string[]Zielgruppenparameterwert oder Array von Werten.
Ausgabe
PubAdsServiceDas Dienstobjekt, für das die Methode aufgerufen wurde.

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void
Legt die Informationen zum Videocontent fest, die zusammen mit den Anzeigenanfragen für Targeting- und Content-Ausschlusszwecke gesendet werden sollen. Videoanzeigen werden automatisch aktiviert, wenn diese Methode aufgerufen wird. Verwenden Sie für videoContentId und videoCmsId die Werte, die dem Google Ad Manager-Dienst für die Contentaufnahme bereitgestellt werden.
Weitere Informationen
Parameter
videoContentId: stringDie ID des Videoinhalts.
videoCmsId: stringDie CMS-ID des Videos.

updateCorrelator

updateCorrelator(): PubAdsService
Ändert den Korrelator, der mit Anzeigenanfragen gesendet wird, wodurch effektiv ein neuer Seitenaufruf gestartet wird. Der Korrelator ist für alle Anzeigenanfragen eines Seitenaufrufs gleich, bei verschiedenen Seitenaufrufen jedoch unterschiedlich. Gilt nur für den asynchronen Modus.

Hinweis:Dies hat keine Auswirkungen auf den langlebigen Seitenaufruf von GPT, der automatisch die tatsächlich auf der Seite vorhandenen Anzeigen 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
PubAdsServiceDas Dienstobjekt, für das die Funktion aufgerufen 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 Position.
Weitere Informationen

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 Position.

googletag.RewardedPayload

Ein Objekt, das die mit einer Anzeige mit Prämie verknüpfte Prämie darstellt.
Attribute
amount
Die Anzahl der Artikel, die in der Prämie enthalten sind.
type
Der Typ des in der Prämie enthaltenen Artikels, z. B. „Münze“.
Weitere Informationen

Attribute


amount

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

type

type: string
Der Typ des in der Prämie enthaltenen Artikels, z. B. „Münze“.

googletag.Service

Basisdienstklasse mit Methoden, die für alle Dienste üblich sind.
Methoden
addEventListener
Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt.
getSlots
Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft 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 eintritt. Die folgenden Ereignisse werden unterstützt: Dem Listener wird bei seinem Aufruf ein Objekt des entsprechenden Ereignistyps übergeben.
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
Parameter
eventType: KEin String, der den von GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet.
listener: ((arg: EventTypeMap[K]) => void)Funktion, die ein einzelnes Event-Objekt als Argument akzeptiert.
Ausgabe
ServiceDas Dienstobjekt, für das die Methode aufgerufen wurde.

getSlots

getSlots(): Slot[]
Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft 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: KEin String, der den von GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet.
listener: ((event: EventTypeMap[K]) => void)Funktion, die ein einzelnes Event-Objekt als Argument akzeptiert.

googletag.SizeMappingBuilder

Builder für Spezifikationsobjekte für die Größenanpassung. Dieser Builder soll Ihnen helfen, Größenangaben einfach zu erstellen.
Methoden
addSize
Fügt eine Zuordnung von einem Array mit einer Größe (das den Darstellungsbereich darstellt) zu einem Array mit einer oder mehreren Größen hinzu, das den Slot darstellt.
build
Erstellt eine Spezifikation für die Größenübersicht aus den Zuordnungen, die diesem Builder hinzugefügt wurden.
Weitere Informationen

Methoden


addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
Fügt eine Zuordnung von einem Array mit einer Größe (das den Darstellungsbereich darstellt) zu einem Array mit einer oder mehreren Größen hinzu, das den Slot 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 &lt; 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 &lt; 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 &lt; 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: SingleSizeArrayDie Größe des Darstellungsbereichs für diesen Zuordnungseintrag.
slotSize: GeneralSizeDie Größen des Slots für diesen Zuordnungseintrag.
Ausgabe
SizeMappingBuilderEin Verweis auf diesen Builder.

build

build(): SizeMappingArray
Erstellt eine Spezifikation für die Größenzuordnung 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 Aufrufen dieser Methode ist nicht definiert.
Ausgabe
SizeMappingArrayDas von diesem Builder erstellte Ergebnis. Kann null sein, wenn ungültige Größenzuordnungen angegeben wurden.

googletag.Slot

Ein Slot ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt.
Methoden
addService
Fügt diesem Slot einen Service hinzu.
clearCategoryExclusions
Eingestellt. Entfernt alle Ausschluss-Labels für Anzeigenkategorien auf Slot-Ebene für diesen Slot.
clearTargeting
Eingestellt. Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Slot-Ebene für diesen Slot.
defineSizeMapping
Legt ein Array von Zuordnungen von einer Mindestgröße des Darstellungsbereichs zur Slotgröße für diesen Slot fest.
get
Eingestellt. Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diesen Slot verknüpft 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 diesen Slot festgelegt sind.
getCategoryExclusions
Eingestellt. Gibt die Labels für den Anzeigenausschluss für diese Anzeigenfläche zurück.
getConfig
Ruft allgemeine Konfigurationsoptionen für den Slot ab, die mit setConfig festgelegt wurden.
getResponseInformation
Gibt die Informationen zur Anzeigenantwort zurück.
getSlotElementId
Gibt die ID des Slots div zurück, die bei der Definition des Slots angegeben wurde.
getTargeting
Eingestellt. Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diesen Slot festgelegt ist.
getTargetingKeys
Eingestellt. Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diesen Slot festgelegt sind.
set
Eingestellt. Legt einen Wert für ein AdSense-Attribut für diesen Anzeigenblock fest.
setCategoryExclusion
Eingestellt. Legt ein Label für den Ausschluss von Anzeigenkategorien auf Anzeigenflächenebene für diese Anzeigenfläche fest.
setClickUrl
Eingestellt. Legt die Klick-URL fest, zu der Nutzer nach dem Klicken auf die Anzeige weitergeleitet werden.
setCollapseEmptyDiv
Eingestellt. Legt fest, ob der Slot div ausgeblendet werden soll, wenn keine Anzeige im Slot vorhanden ist.
setConfig
Legt allgemeine Konfigurationsoptionen für diesen Slot fest.
setForceSafeFrame
Eingestellt. Konfiguriert, ob Anzeigen in dieser Anzeigenfläche in einem SafeFrame-Container gerendert werden sollen.
setSafeFrameConfig
Eingestellt. Legt die Einstellungen auf Slot-Ebene für die SafeFrame-Konfiguration fest.
setTargeting
Eingestellt. Legt einen benutzerdefinierten Targeting-Parameter für diesen Slot fest.
updateTargetingFromMap
Eingestellt. Legt benutzerdefinierte Targeting-Parameter für diesen Slot 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
Parameter
service: ServiceDer hinzuzufügende Dienst.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

clearCategoryExclusions

clearCategoryExclusions(): Slot
Entfernt alle Ausschluss-Labels für Anzeigenkategorien auf Ebene der Anzeigenfläche für diese Anzeigenfläche.
Beispiel

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("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.clearCategoryExclusions();

// 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")
  .setCategoryExclusion("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.clearCategoryExclusions();

// 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")!
  .setCategoryExclusion("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.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.
Ausgabe
SlotDas Slot-Objekt, 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.
Beispiel

JavaScript

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

JavaScript (alt)

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

TypeScript

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.
Weitere Informationen
Parameter
Optional key: stringSchlüssel des Targeting-Parameters. Der Schlüssel ist optional. Wenn er nicht angegeben wird, werden alle Targeting-Parameter gelöscht.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot
Legt ein Array von Zuordnungen von einer Mindest-Darstellungsbereichsgröße zur Slotgröße für diesen Slot 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
Parameter
sizeMapping: SizeMappingArrayArray von Größen-Mappings. Sie können SizeMappingBuilder verwenden, um sie zu erstellen. Jede Größen-Zuordnung ist ein Array mit zwei Elementen: SingleSizeArray und GeneralSize.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

get

get(key: string): string
Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diesen Slot verknüpft ist. Verwenden Sie PubAdsService.get, um Attribute auf Dienstebene zu sehen, die von diesem Slot übernommen wurden.
Beispiel

JavaScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (alt)

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.
Weitere Informationen
Parameter
key: stringName des Attributs, nach dem gesucht werden soll.
Ausgabe
stringAktueller 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
stringAnzeigenblock-Pfad.

getAttributeKeys

getAttributeKeys(): string[]
Gibt die Liste der Attributschlüssel zurück, die für diesen Slot festgelegt sind. Wenn Sie die Schlüssel der Attribute auf Dienstebene sehen möchten, die von diesem Slot übernommen wurden, verwenden Sie PubAdsService.getAttributeKeys.
Beispiel

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (alt)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
Ausgabe
string[]Array von Attributschlüsseln. Die Reihenfolge ist nicht definiert.

getCategoryExclusions

getCategoryExclusions(): string[]
Gibt die Ausschluss-Labels für Anzeigenkategorien für diese Anzeigenfläche zurück.
Beispiel

JavaScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (alt)

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].
Ausgabe
string[]Die Ausschluss-Labels für Anzeigenkategorien für diesen Slot oder ein leeres Array, wenn keine festgelegt wurden.

getConfig

getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">
Ruft allgemeine Konfigurationsoptionen für den Slot ab, die mit setConfig festgelegt wurden.

Nicht alle setConfig()-Attribute werden von dieser Methode unterstützt. Unterstützte Eigenschaften:
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
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">Die Konfigurationsoptionen für den Slot.

getResponseInformation

getResponseInformation(): ResponseInformation
Gibt die Informationen zur Anzeigenantwort zurück. Dies basiert auf der letzten Anzeigenantwort für den Slot. Wenn diese Funktion aufgerufen wird, während in der Anzeigenfläche keine Anzeige vorhanden ist, wird null zurückgegeben.
Ausgabe
ResponseInformationDie neuesten Informationen zur Anzeigenantwort oder null, wenn die Anzeigenfläche keine Anzeige enthält.

getSlotElementId

getSlotElementId(): string
Gibt die ID des Slots div zurück, die bei der Definition des Slots 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
stringID des Slots div.

getTargeting

getTargeting(key: string): string[]
Gibt einen bestimmten benutzerdefinierten Targeting-Parametersatz zurück, der für diesen Slot festgelegt ist. Parameter für das Targeting auf Dienstebene sind nicht enthalten.
Beispiel

JavaScript

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

JavaScript (alt)

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

TypeScript

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).
Parameter
key: stringDer Targeting-Schlüssel, nach dem gesucht werden soll.
Ausgabe
string[]Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn es keinen solchen Schlüssel gibt.

getTargetingKeys

getTargetingKeys(): string[]
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diesen Slot festgelegt sind. Schlüssel für das Targeting auf Dienstebene sind nicht enthalten.
Beispiel

JavaScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

JavaScript (alt)

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

TypeScript

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

slot.getTargetingKeys();
// 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 auf Dienstebene für diesen Schlüssel festgelegten Werte überschrieben.

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 festgelegt werden, bevor display oder refresh aufgerufen wird.
Beispiel

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

JavaScript (alt)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
Weitere Informationen
Parameter
key: stringDer Name des Attributs.
value: stringAttributwert.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot
Legt für diese Anzeigenfläche ein Ausschluss-Label für Anzeigenkategorien auf Anzeigenflächenebene fest.
Beispiel

JavaScript

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

JavaScript (alt)

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

TypeScript

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());
Weitere Informationen
Parameter
categoryExclusion: stringDas Label für den Ausschluss von Anzeigenkategorien, das hinzugefügt werden soll.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

setClickUrl

setClickUrl(value: string): Slot
Legt die Klick-URL fest, zu der Nutzer nach dem Klicken auf die Anzeige weitergeleitet werden.

Die Google Ad Manager-Server erfassen weiterhin einen Klick, auch wenn die Klick-URL ersetzt wird. Jede Landingpage-URL, die mit dem ausgelieferten Creative verknüpft ist, wird an den angegebenen Wert angehängt. Bei nachfolgenden Aufrufen wird der Wert überschrieben. Dies funktioniert nur für Anfragen ohne SRA.
Beispiel

JavaScript

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

JavaScript (alt)

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

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());
Parameter
value: stringDie festzulegende Klick-URL.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
Legt fest, ob der Slot div ausgeblendet werden soll, wenn keine Anzeige im Slot vorhanden ist. Dadurch werden die Einstellungen auf Dienstebene überschrieben.
Beispiel

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .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)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .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
Parameter
collapse: booleanGibt an, ob die Anzeigenfläche minimiert werden soll, wenn keine Anzeige zurückgegeben wird.
Optional collapseBeforeAdFetch: booleanGibt an, ob die Anzeigenfläche minimiert werden soll, noch bevor eine Anzeige abgerufen wird. Wird ignoriert, wenn „collapse“ nicht true ist.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

setConfig

setConfig(slotConfig: SlotSettingsConfig): void
Legt allgemeine Konfigurationsoptionen für diesen Slot fest.
Parameter
slotConfig: SlotSettingsConfigDas Konfigurationsobjekt.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
Konfiguriert, ob Anzeigen auf dieser Anzeigenfläche in einem SafeFrame-Container gerendert werden sollen.

Beachten Sie bei der Verwendung dieser API Folgendes:
  • Diese Einstellung wird nur für nachfolgende Anzeigenanfragen für die entsprechenden Slots 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 Art des Creatives und der Auswahl in der Google Ad Manager-Benutzeroberfläche 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 darauf angewiesen sind, direkt auf der Seite eines Publishers gerendert zu werden.
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
Parameter
forceSafeFrame: booleantrue, um zu erzwingen, dass alle Anzeigen in diesem Slot in SafeFrames gerendert werden, und false, um eine Einstellung auf Seitenebene zu deaktivieren (falls vorhanden). Wenn Sie diese Einstellung auf false setzen, wenn sie nicht auf Seitenebene angegeben ist, ändert sich nichts.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot
Legt die Einstellungen auf Slot-Ebene für die SafeFrame-Konfiguration fest. Nicht erkannte Schlüssel im Konfigurationsobjekt werden ignoriert. Die gesamte Konfiguration wird ignoriert, wenn ein ungültiger Wert für einen erkannten Schlüssel übergeben wird.

Diese Einstellungen auf Slot-Ebene überschreiben, sofern angegeben, alle Einstellungen auf Seitenebene.
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
Parameter
config: SafeFrameConfigDas Konfigurationsobjekt.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

setTargeting

setTargeting(key: string, value: string | string[]): Slot
Legt einen benutzerdefinierten Targeting-Parameter für diesen Slot fest. Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden alte Werte überschrieben. Hier festgelegte Werte überschreiben Targeting-Parameter, die auf Dienstebene festgelegt wurden. Diese Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.
Beispiel

JavaScript

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

JavaScript (alt)

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

TypeScript

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);
Weitere Informationen
Parameter
key: stringSchlüssel des Targeting-Parameters.
value: string | string[]Zielgruppenparameterwert oder Array von Werten.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot
Legt benutzerdefinierte Targeting-Parameter für diesen Slot aus einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt fest. Das entspricht dem Aufrufen von Slot.setTargeting für alle Schlüssel/Wert-Paare des Objekts. Diese Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.

Hinweise
  • Im Fall des Überschreibens wird nur der letzte Wert beibehalten.
  • Wenn der Wert ein Array ist, wird jeder vorherige Wert überschrieben, nicht zusammengeführt.
  • Hier festgelegte Werte überschreiben Targeting-Parameter, die auf Dienstebene festgelegt wurden.
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[];
}
Schlüssel/Wert-Paare für Targeting-Parameter.
Ausgabe
SlotDas Slot-Objekt, für das die Methode aufgerufen wurde.

googletag.config

Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.
Schnittstellen
AdExpansionConfig
Einstellungen zum Steuern der Anzeigenerweiterung.
AdSenseAttributesConfig
Einstellungen zur Steuerung des Verhaltens von AdSense-Anzeigen.
ComponentAuctionConfig
Ein Objekt, das eine einzelne Komponentenauktion in einer On-Device-Anzeigenauktion darstellt.
InterstitialConfig
Ein Objekt, das das Verhalten eines einzelnen Interstitial-Anzeigen-Slots definiert.
LazyLoadConfig
Einstellungen zur Steuerung der Verwendung von Lazy Loading in GPT.
PageSettingsConfig
Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.
PrivacyTreatmentsConfig
Einstellungen zum Steuern der Datenschutzmaßnahmen für Publisher.
PublisherProvidedSignalsConfig
Konfigurationsobjekt für vom Publisher bereitgestellte Signale (Publisher Provided Signals, PPS).
SafeFrameConfig
Einstellungen zum Steuern von SafeFrame in GPT.
SlotSettingsConfig
Hauptkonfigurationsoberfläche für Einstellungen auf Slot-Ebene.
TaxonomyData
Ein Objekt mit den Werten für eine einzelne Taxonomie.
VideoAdsConfig
Einstellungen zum Konfigurieren von Einstellungen für Videoanzeigen.
Typaliasse
CollapseDivBehavior
Unterstützte Werte zum Steuern des Minimierungsverhaltens von Anzeigenflächen.
InterstitialTrigger
Unterstützte Interstitial-Anzeigentrigger.
PrivacyTreatment
Unterstützte Publisher-Datenschutzbehandlungen.
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

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"
Unterstützte Interstitial-Anzeigentrigger.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
Unterstützte Publisher-Datenschutzbehandlungen.

Taxonomie

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
Unterstützte Taxonomien für vom Publisher bereitgestellte Signale (PPS).
Weitere Informationen

googletag.config.AdExpansionConfig

Einstellungen zum Steuern der Anzeigenerweiterung.
Attribute
enabled?
Gibt an, ob die Anzeigenerweiterung 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 Maximierung von Anzeigenflächen aktiviert oder deaktiviert ist.

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

googletag.config.AdSenseAttributesConfig

Einstellungen zur Steuerung des Verhaltens von AdSense-Anzeigen.

Mit diesen Attributen können serverseitige Einstellungen pro 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

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-Channel-IDs.

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

Beispiel: 271828183+314159265
Weitere Informationen

Optional adsense_test_mode

adsense_test_mode?: "on"
Gibt an, ob der Testmodus aktiviert ist.

Wenn der Wert auf on festgelegt ist, werden Anzeigen als „Nur für Testzwecke“ gekennzeichnet und nicht für die Zählung oder Abrechnung berücksichtigt. Diese Einstellung muss für Produktions- und Nicht-Test-Traffic 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

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.ComponentAuctionConfig

Ein Objekt, das eine einzelne Komponentenauktion in einer On-Device-Anzeigenauktion darstellt.
Attribute
auctionConfig
Ein Auktionskonfigurationsobjekt für diese Komponentenauktion.
configKey
Der Konfigurationsschlüssel, der mit dieser Komponentenauktion verknüpft ist.
Weitere Informationen

Attribute


auctionConfig

auctionConfig: {
  auctionSignals?: unknown;
  decisionLogicURL: string;
  interestGroupBuyers?: string[];
  perBuyerExperimentGroupIds?: {
    [buyer: string]: number;
  };
  perBuyerGroupLimits?: {
    [buyer: string]: number;
  };
  perBuyerSignals?: {
    [buyer: string]: unknown;
  };
  perBuyerTimeouts?: {
    [buyer: string]: number;
  };
  seller: string;
  sellerExperimentGroupId?: number;
  sellerSignals?: unknown;
  sellerTimeout?: number;
  trustedScoringSignalsURL?: string;
}
Ein Auktionskonfigurationsobjekt für diese Komponentenauktion.

Wenn dieser Wert auf null festgelegt ist, wird jede vorhandene Konfiguration für die angegebene configKey gelöscht.
Beispiel

JavaScript

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

JavaScript (alt)

var componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

TypeScript

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});
Weitere Informationen

configKey

configKey: string
Der Konfigurationsschlüssel, der mit dieser Komponentenauktion verknüpft ist.

Dieser Wert darf nicht leer sein und sollte eindeutig sein. Wenn zwei ComponentAuctionConfig-Objekte denselben configKey-Wert haben, wird die letzte Konfiguration, die festgelegt wird, die vorherigen Konfigurationen überschreiben.

googletag.config.InterstitialConfig

Ein Objekt, das das Verhalten eines einzelnen Interstitial-Anzeigen-Slots definiert.
Attribute
requireStorageAccess?
Gibt an, ob eine Einwilligung für die lokale Speicherung erforderlich ist, um dieses Interstitial zu präsentieren.
triggers?
Die Konfiguration des Interstitial-Triggers für diese Interstitial-Anzeige.

Attribute


Optional requireStorageAccess

requireStorageAccess?: boolean
Gibt an, ob eine Einwilligung zur lokalen Speicherung erforderlich ist, um dieses Interstitial auszuliefern.

GPT verwendet den lokalen Speicher, um ein Frequency Capping für Interstitials durchzusetzen. Nutzer, die keine Einwilligung zur lokalen Speicherung erteilt haben, können jedoch weiterhin Interstitial-Anzeigen sehen. Wenn Sie diese Eigenschaft auf true festlegen, 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

Optional Triggers

triggers?: Partial<Record<InterstitialTrigger, boolean>>
Die Konfiguration des Interstitial-Triggers für diese Interstitials.

Wenn Sie den Wert eines Interstitial-Triggers auf true setzen, wird er aktiviert. Wenn Sie ihn auf false setzen, wird er deaktiviert. Dadurch werden die in Google Ad Manager konfigurierten Standardwerte überschrieben.
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

googletag.config.LazyLoadConfig

Einstellungen zur Steuerung der Verwendung von Lazy Loading in GPT.
Attribute
fetchMarginPercent?
Der Mindestabstand einer Anzeigenfläche vom aktuellen Darstellungsbereich, bevor eine Anzeige angefordert wird. Er wird als Prozentsatz der Darstellungsbereichsgröße ausgedrückt.
mobileScaling?
Ein Multiplikator, der auf Ränder auf Mobilgeräten angewendet wird.
renderMarginPercent?
Der Mindestabstand einer Anzeigenfläche vom aktuellen Darstellungsbereich, bevor eine Anzeige gerendert wird. Er wird als Prozentsatz der Darstellungsbereichsgröße ausgedrückt.
Weitere Informationen

Attribute


Optional fetchMarginPercent

fetchMarginPercent?: number
Der Mindestabstand vom aktuellen Viewport, den ein Slot haben muss, bevor eine Anzeige angefordert wird, ausgedrückt als Prozentsatz der Viewport-Größe.

In Verbindung mit renderMarginPercent ermöglicht diese Einstellung das Vorabrufen einer Anzeige, aber das Warten auf das Rendern und Herunterladen anderer untergeordneter Ressourcen. Dieser Wert sollte daher immer größer oder gleich renderMarginPercent sein.

Ein Wert von 0 bedeutet „wenn der Slot in den sichtbaren Bereich gelangt“, 100 bedeutet „wenn die Anzeige einen sichtbaren Bereich 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 Ränder für Mobilgeräte und Computer festgelegt werden, da sich die Darstellungsbereiche und Scrollgeschwindigkeiten unterscheiden können. Bei einem Wert von 2,0 werden beispielsweise alle Ränder auf Mobilgeräten verdoppelt.Dadurch wird der Mindestabstand, den ein Slot vom Viewport haben kann, bevor er abgerufen und gerendert wird, erhöht.

Optional renderMarginPercent

renderMarginPercent?: number
Der Mindestabstand vom aktuellen Viewport, den ein Slot haben muss, bevor eine Anzeige gerendert wird. Er wird als Prozentsatz der Viewport-Größe ausgedrückt.

In Verbindung mit fetchMarginPercent ermöglicht diese Einstellung das Vorabrufen einer Anzeige, aber das Warten auf das Rendern und Herunterladen anderer untergeordneter Ressourcen. Dieser Wert sollte daher immer kleiner oder gleich fetchMarginPercent sein.

Ein Wert von 0 bedeutet „wenn der Slot in den sichtbaren Bereich gelangt“, 100 bedeutet „wenn die Anzeige einen sichtbaren Bereich 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. Die Gruppe von Funktionen finden Sie unten in den Feldern des Typs „PageSettingsConfig“.

Beispiele:
  • Es werden nur die Funktionen geändert, die im googletag.setConfig-Aufruf angegeben sind.
      // Configure feature alpha.
      googletag.setConfig({
          alpha: {...}
      });
    
      // Configure feature bravo. Feature alpha is unchanged.
      googletag.setConfig({
         bravo: {...}
      });
  • Alle Einstellungen für ein bestimmtes Feature werden mit 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 eine Funktion 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 zum Steuern der Anzeigenerweiterung.
adsenseAttributes?
Einstellung zum Konfigurieren von AdSense-Attributen.
adYield?
Eingestellt. 
categoryExclusion?
Einstellung zum Konfigurieren von Ausschlüssen für Anzeigenkategorien.
centering?
Einstellung zum Steuern der horizontalen Zentrierung von Anzeigen.
collapseDiv?
Mit dieser Einstellung lässt sich das Minimierungsverhalten von Anzeigenflächen steuern.
disableInitialLoad?
Einstellung, mit der gesteuert wird, wann Anzeigen angefordert werden.
lazyLoad?
Einstellungen zur Steuerung der Verwendung von Lazy Loading in GPT.
location?
Einstellung für das geografische Targeting von Werbebuchungen auf Standorte.
pps?
Einstellungen zum Steuern von vom Publisher bereitgestellten Signalen (PPS).
privacyTreatments?
Einstellungen zum Steuern der Datenschutzmaßnahmen für Publisher.
safeFrame?
Einstellungen zur Steuerung der Verwendung von SafeFrame in GPT.
singleRequest?
Einstellung zum Aktivieren oder Deaktivieren der Einzelanfrage-Architektur
targeting?
Einstellung zum Steuern des Schlüssel/Wert-Paar-Targetings.
threadYield?
Einstellung, mit der gesteuert wird, ob der JS-Thread von GPT freigegeben werden soll, wenn Creatives angefordert und gerendert werden.
videoAds?
Einstellungen zum Steuern von Videoanzeigen

Attribute


Optional adExpansion

adExpansion?: AdExpansionConfig
Einstellungen zum Steuern der Anzeigenerweiterung.

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
Einstellung zum Konfigurieren von AdSense-Attributen.

Über diese Einstellung konfigurierte AdSense-Attribute werden auf alle Anzeigenblöcke auf der Seite angewendet. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Attributwerte zu definieren oder vorhandene Werte zu überschreiben.

Änderungen an AdSense-Attributen werden nur auf Anzeigen angewendet, die nach dem Aufrufen dieser Methode angefordert werden. Aus diesem Grund wird empfohlen, diese Methode vor 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"

Optional categoryExclusion

categoryExclusion?: string[]
Einstellung zum Konfigurieren von Ausschlüssen für 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

Optional Zentrierung

centering?: boolean
Einstellung zum Steuern der horizontalen Zentrierung von Anzeigen. Die Zentrierung ist standardmäßig deaktiviert.

Horizontale Zentrierungsänderungen werden nur auf Anzeigen angewendet, die nach dem Aufrufen dieser Methode angefordert werden. Aus diesem Grund wird empfohlen, diese Methode vor 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 zur Steuerung des Minimierungsverhaltens von Anzeigenflächen.

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

Unterstützte Werte:
  • null (Standard): Der Slot wird nicht minimiert.
  • DISABLED: Die Anzeigenfläche wird nicht minimiert, unabhängig davon, ob eine Anzeige zurückgegeben wird.
  • 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

Optional disableInitialLoad

disableInitialLoad?: boolean
Einstellung, mit der gesteuert wird, wann Anzeigen angefordert werden.

Standardmäßig werden mit der Methode googletag.display sowohl Anzeigenflächen registriert als auch Anzeigen für sie angefordert. Es gibt jedoch Fälle, in denen es besser ist, diese Aktionen zu trennen, um genauer zu steuern, wann Anzeigeninhalte geladen werden.

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

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

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 detaillierteres Beispiel finden Sie im Lazy Loading-Beispiel.

Hinweis:Wenn singleRequest aktiviert ist, funktioniert das verzögerte Abrufen nur, wenn sich alle Slots außerhalb des Abrufrands befinden.

Für alle Lazy Loading-Einstellungen, die beim Aufrufen 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

Optional Standort

location?: string
Einstellung zum geografischen Targeting von Werbebuchungen auf 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

Optional pps

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

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig
Einstellungen zum Steuern der Datenschutzmaßnahmen für Publisher.

Optional safeFrame

safeFrame?: SafeFrameConfig
Einstellungen zur Steuerung der Verwendung von SafeFrame in GPT.

Über diese Einstellung konfigurierte Werte gelten für alle Anzeigenblöcke auf der Seite. Diese Werte können für einzelne Anzeigenflächen über SlotSettingsConfig.safeFrame überschrieben werden.
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 (Single Request Architecture, 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 und ist 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 Aufrufen 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

Optional Targeting

targeting?: Record<string, string | string[]>
Einstellung zum Steuern des Schlüssel/Wert-Targetings.

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

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
Mit dieser Einstellung wird gesteuert, ob der JS-Thread von GPT freigegeben werden soll, wenn Creatives angefordert und gerendert werden.

GPT gibt den Thread nur für Browser frei, die die API „Scheduler.postTask“ oder „Scheduler.yield“ unterstützen.

Unterstützte Werte:
  • null (Standard): GPT gibt den JS-Thread für Slots außerhalb des Darstellungsbereichs frei.
  • ENABLED_ALL_SLOTS: GPT gibt den JS-Thread für alle Slots frei, unabhängig davon, ob sich der Slot 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

Optional videoAds

videoAds?: VideoAdsConfig
Einstellungen zum Steuern 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

googletag.config.PrivacyTreatmentsConfig

Einstellungen zum Steuern der Datenschutzmaßnahmen für Publisher.
Attribute
treatments
Ein Array von Publisher Privacy Treatments, die aktiviert werden können.

Attribute


Behandlungen

treatments: "disablePersonalization"[]
Eine Reihe von Publisher Privacy Treatments, die aktiviert werden können.
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 (Publisher Provided Signals, PPS).
Attribute
taxonomies
Ein Objekt mit Taxonomy-Zuordnungen 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

Attribute


Taxonomien

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
Ein Objekt mit Taxonomy-Zuordnungen oder „null“, um die Konfiguration zu löschen.

googletag.config.SafeFrameConfig

Einstellungen zum Steuern von SafeFrame in GPT.
Attribute
allowOverlayExpansion?
Gibt an, ob Anzeigeninhalte in SafeFrames durch Überlagerung von Seiteninhalten erweitert werden dürfen.
allowPushExpansion?
Ob Anzeigeninhalte durch Verschieben von Seiteninhalten erweitert werden dürfen.
forceSafeFrame?
Gibt an, ob Anzeigen in einem SafeFrame-Container gerendert werden sollen.
sandbox?
Gibt an, ob SafeFrame das HTML5-Attribut „sandbox“ verwenden soll, um eine Navigation auf der obersten Ebene ohne Nutzerinteraktion zu verhindern.
useUniqueDomain?
Eingestellt. Gibt an, ob für Reservierungs-Creatives zufällige Subdomains verwendet werden sollen.
Weitere Informationen

Attribute


Optional allowOverlayExpansion

allowOverlayExpansion?: boolean
Gibt an, ob Anzeigeninhalte in SafeFrames durch Überlagerung von Seiteninhalten erweitert werden dürfen.

Optional allowPushExpansion

allowPushExpansion?: boolean
Ob Anzeigeninhalte durch Verschieben von Seiteninhalten erweitert werden dürfen.

Optional forceSafeFrame

forceSafeFrame?: boolean
Gibt an, ob Anzeigen in einem SafeFrame-Container gerendert werden sollen.

Optional sandbox

sandbox?: boolean
Gibt an, ob SafeFrame das HTML5-Attribut „sandbox“ verwenden soll, um eine Navigation auf der obersten Ebene ohne Nutzerinteraktion zu verhindern. Der einzige gültige Wert ist true (kann nicht auf false festgelegt werden). Beachten Sie, dass durch das Attribut „sandbox“ Plug-ins (z.B. Flash) deaktiviert werden.

Optional useUniqueDomain

useUniqueDomain?: boolean
Gibt an, ob für Reservierungs-Creatives zufällige Subdomains verwendet werden sollen. Übergeben Sie null, um den gespeicherten Wert zu löschen.

Hinweis: Diese Funktion ist standardmäßig aktiviert.
Weitere Informationen

googletag.config.SlotSettingsConfig

Hauptkonfigurationsoberfläche für Einstellungen auf Slot-Ebene.

Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf für einen einzelnen Slot.

Alle unten aufgeführten Attribute sind Beispiele und spiegeln nicht die tatsächlichen Funktionen wider, die „setConfig“ verwenden. Die Gruppe von Funktionen finden Sie unten in den Feldern des Typs „SlotSettingsConfig“.

Beispiele:
  • Es werden nur die Funktionen geändert, die im Slot.setConfig-Aufruf angegeben sind.
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);
    
      // Configure feature alpha.
      slot.setConfig({
          alpha: {...}
      });
    
      // Configure feature bravo. Feature alpha is unchanged.
      slot.setConfig({
         bravo: {...}
      });
  • Alle Einstellungen für ein bestimmtes Feature werden bei jedem Aufruf von Slot.setConfig 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 eine Funktion 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 Anzeigenerweiterung.
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 nach dem Klicken auf die Anzeige weitergeleitet werden.
collapseDiv?
Einstellung zum Konfigurieren des Minimierungsverhaltens des Anzeigen-Slots.
componentAuction?
Ein Array von Komponentenauktionen, die in eine On-Device-Anzeigenauktion aufgenommen werden sollen.
interstitial?
Einstellungen, mit denen das Verhalten von Interstitial-Anzeigen-Slots 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 Anzeigenerweiterung.
Weitere Informationen

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
Einstellung zum Konfigurieren von AdSense-Attributen.

Über diese Einstellung konfigurierte AdSense-Attribute gelten nur für den Anzeigen-Slot. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Attributwerte zu definieren oder vorhandene Werte zu überschreiben.

Änderungen an AdSense-Attributen werden nur auf Anzeigen angewendet, die nach dem Aufrufen dieser Methode angefordert werden. Aus diesem Grund wird empfohlen, diese Methode vor 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 für 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

Optional clickUrl

clickUrl?: string
Einstellung zum Konfigurieren der URL, an die Nutzer weitergeleitet werden, nachdem sie auf die Anzeige geklickt haben.

Die Google Ad Manager-Server erfassen weiterhin einen Klick, auch wenn die Klick-URL ersetzt wird. Jede Landingpage-URL, die mit dem ausgelieferten Creative verknüpft ist, wird an den angegebenen Wert angehängt. Wenn Sie diesen Wert mehr als einmal festlegen, wird jeder zuvor konfigurierte Wert überschrieben. Wenn Sie null übergeben, wird der Wert gelöscht.

Hinweis:Diese Einstellung gilt nur für Anfragen ohne SRA.
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): Der Slot wird nicht minimiert.
  • DISABLED: Die Anzeigenfläche wird nicht minimiert, unabhängig davon, ob eine Anzeige zurückgegeben wird.
  • 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

Optional componentAuction

componentAuction?: ComponentAuctionConfig[]
Ein Array von Komponentenauktionen, die in eine On-Device-Anzeigenauktion aufgenommen werden sollen.

Optional Interstitial

interstitial?: InterstitialConfig
Einstellungen, mit denen das Verhalten von Interstitial-Anzeigen-Slots konfiguriert wird.
Weitere Informationen

Optional safeFrame

safeFrame?: SafeFrameConfig
Einstellungen zum Konfigurieren der Verwendung von SafeFrame in GPT.

Über diese Einstellung konfigurierte Werte gelten nur für den Anzeigen-Slot 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 Schlüssel/Wert-Targetings.

Das über diese Einstellung konfigurierte Targeting wird nur auf die Anzeigenfläche 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

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

googletag.config.TaxonomyData

Ein Objekt mit den Werten für eine einzelne Taxonomie.
Attribute
values
Eine Liste mit Taxonomy-Werten.

Attribute


Werte

values: readonly string[]
Eine Liste mit Taxonomy-Werten.

googletag.config.VideoAdsConfig

Einstellungen zum Konfigurieren von Einstellungen für Videoanzeigen.
Attribute
enableVideoAds
Gibt an, ob Videoanzeigen auf der Seite ausgeliefert werden.
videoCmsId?
Die ID der Videoinhaltsquelle.
videoContentId?
Die ID des Videoinhalts.
Weitere Informationen

Attribute


enableVideoAds

enableVideoAds: boolean
Gibt an, ob Videoanzeigen auf der Seite präsentiert werden.

Wenn der Wert auf true gesetzt 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 dem Google Ad Manager-Dienst für die Aufnahme von Inhalten bereitgestellt werden, um den Ausschluss von Inhalten für Displayanzeigen zu nutzen.

Optional videoCmsId

videoCmsId?: string
Die ID der Videocontentquelle.

Dies ist ein eindeutiger Wert, der vom Google Ad Manager-Dienst für die Contentaufnahme zugewiesen wird, um die Quelle des Videocontents zu identifizieren, der durch videoContentId angegeben wird.
Weitere Informationen

Optional videoContentId

videoContentId?: string
Die ID des Videocontents.

Dies ist ein eindeutiger Wert, der ein bestimmtes Video aus der Contentquelle identifiziert, die durch videoCmsId angegeben wird. Dieser Wert wird vom CMS zugewiesen, das Ihren Videocontent hostet.
Weitere Informationen

googletag.enums

Dies ist der Namespace, den GPT für Enumerationstypen verwendet.
Aufzählungen
OutOfPageFormat
Von GPT unterstützte Out-of-Page-Formate
TrafficSource
Von GPT unterstützte Traffic-Quellen

Aufzählungen


OutOfPageFormat

OutOfPageFormat
Von GPT unterstützte Out-of-Page-Formate
Weitere Informationen
Enumerationsmitglieder
AD_INTENTS
Format für auf der Nutzerabsicht basierende Links, Chips und Anker
BOTTOM_ANCHOR
Ankerformat, bei dem der Slot am unteren Rand des Darstellungsbereichs bleibt.
GAME_MANUAL_INTERSTITIAL
Manuelles Interstitial-Format für Spiele.

Hinweis:Das manuelle Interstitial für Spiele ist ein Format mit eingeschränktem Zugriff.
INTERSTITIAL
Creative-Format für Web-Interstitial-Anzeigen.
LEFT_SIDE_RAIL
Format des seitlichen Anzeigenstreifens links.
REWARDED
Format mit Prämie.
RIGHT_SIDE_RAIL
Format des seitlichen Anzeigenstreifens rechts.
TOP_ANCHOR
Ankerformat, bei dem die Anzeigenfläche am oberen Rand des Darstellungsbereichs fixiert ist.

TrafficSource

TrafficSource
Von GPT unterstützte Traffic-Quellen.
Weitere Informationen
Enumerationsmitglieder
ORGANIC
Direkter URL-Eintrag, Websitesuche oder App-Download.
PURCHASED
Zugriffe, die von Properties weitergeleitet wurden, 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 ein manueller Interstitial-Slot für Spiele vom Nutzer geschlossen wurde.
GameManualInterstitialSlotReadyEvent
Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Anzeigenfläche für Spiele bereit ist, dem Nutzer präsentiert zu werden.
ImpressionViewableEvent
Dieses Ereignis wird ausgelöst, wenn eine Impression gemäß den Active View-Kriterien sichtbar wird.
RewardedSlotClosedEvent
Dieses Ereignis wird ausgelöst, wenn ein Nutzer einen Anzeigen-Slot mit Prämie schließt.
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 abgeschlossen ist.
SlotOnloadEvent
Dieses Ereignis wird ausgelöst, wenn das Load-Ereignis des iFrames des Creatives ausgelöst wird.
SlotRenderEndedEvent
Dieses Ereignis wird ausgelöst, wenn der Creative-Code in einen Slot eingefügt wird.
SlotRequestedEvent
Dieses Ereignis wird ausgelöst, wenn eine Anzeige für einen bestimmten Slot angefordert wurde.
SlotResponseReceived
Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für einen bestimmten Slot empfangen wurde.
SlotVisibilityChangedEvent
Dieses Ereignis wird immer dann ausgelöst, wenn sich der Prozentsatz der Fläche eines Anzeigen-Slots ändert, der auf dem Bildschirm zu sehen ist.

googletag.events.Event

Basisschnittstelle für alle GPT-Ereignisse. Alle GPT-Ereignisse unten haben 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

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 wird nur zu Referenz- und Typsicherheitszwecken dokumentiert.
Attribute
gameManualInterstitialSlotClosed
gameManualInterstitialSlotReady
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
rewardedSlotVideoCompleted
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

Attribute


gameManualInterstitialSlotClosed


gameManualInterstitialSlotReady


impressionViewable


rewardedSlotClosed


rewardedSlotGranted


rewardedSlotReady


rewardedSlotVideoCompleted


slotOnload


slotRenderEnded


slotRequested


slotResponseReceived

slotResponseReceived: SlotResponseReceived
Alias für events.SlotResponseReceived.

slotVisibilityChanged


googletag.events.GameManualInterstitialSlotClosedEvent

Erweitert Event
Dieses Ereignis wird ausgelöst, wenn ein manueller Interstitial-Anzeigen-Slot 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.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

googletag.events.GameManualInterstitialSlotReadyEvent

Erweitert Event
Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Anzeigenfläche für Spiele bereit ist, dem Nutzer präsentiert zu werden.

Hinweis:Manuelle Interstitials für Spiele sind ein Format mit eingeschränktem Zugriff.
Attribute
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
Methoden
makeGameManualInterstitialVisible
Zeigt dem Nutzer die manuelle Interstitial-Anzeige für Spiele an.
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

Methoden


makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void
Zeigt dem Nutzer die manuelle Interstitial-Anzeige für Spiele an.

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.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

googletag.events.RewardedSlotClosedEvent

Erweitert Event
Dieses Ereignis wird ausgelöst, wenn ein Nutzer einen Anzeigen-Slot mit Prämie schließt. 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.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

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.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

Attribute


payload

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 eine Option zum Ansehen der Anzeige zu präsentieren, bevor sie ausgeliefert wird.
Attribute
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

Methoden


makeRewardedVisible

makeRewardedVisible(): void
Die Anzeige mit Prämie wird eingeblendet. Diese Methode sollte erst aufgerufen werden, wenn der Nutzer der Anzeige zugestimmt hat.

googletag.events.RewardedSlotVideoCompletedEvent

Erweitert Event
Dieses Ereignis wird ausgelöst, wenn die Wiedergabe einer Videoanzeige mit Prämie abgeschlossen ist.
Attribute
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

googletag.events.SlotOnloadEvent

Erweitert Event
Dieses Ereignis wird ausgelöst, wenn das Load-Ereignis des iFrames des Creatives ausgelöst wird. Beim Rendern von Rich Media-Anzeigen im synchronen Renderingmodus wird kein iFrame verwendet. Daher wird kein SlotOnloadEvent ausgelöst.
Attribute
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

googletag.events.SlotRenderEndedEvent

Erweitert Event
Dieses Ereignis wird ausgelöst, wenn der Creative-Code in einen Slot eingefügt wird. Dieses Ereignis tritt auf, bevor die Ressourcen des Creatives abgerufen werden. Das Creative ist daher möglicherweise noch nicht sichtbar. Wenn Sie wissen müssen, wann alle Creative-Ressourcen für einen Slot geladen wurden, sollten Sie stattdessen events.SlotOnloadEvent verwenden.
Attribute
advertiserId
Werbetreibenden-ID der gerenderten Anzeige.
campaignId
Die Kampagnen-ID der gerenderten Anzeige.
companyIds
IDs der Unternehmen, die Gebote für die gerenderte Backfill-Anzeige abgegeben 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
Eingestellt. 
lineItemId
Werbebuchungs-ID der gerenderten Reservierungsanzeige.
responseIdentifier
Die Antwort-ID ist eine eindeutige Kennung für die Anzeigenantwort.
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
size
Gibt die Pixelgröße des gerenderten Creatives an.
slot
Der Slot, der das Ereignis ausgelöst hat.
slotContentChanged
Gibt an, ob der Slot-Content mit der gerenderten Anzeige geändert wurde.
sourceAgnosticCreativeId
Die 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

Attribute


advertiserId

advertiserId: number
Werbetreibenden-ID der gerenderten Anzeige. Der Wert ist null für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

campaignId

campaignId: number
Die Kampagnen-ID der gerenderten Anzeige. Der Wert ist null für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

companyIds

companyIds: number[]
IDs der Unternehmen, die Gebote für die gerenderte Backfill-Anzeige abgegeben haben. Der Wert ist null für leere Slots, 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 Slots, 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 Slots, 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[]

lineItemId

lineItemId: number
Werbebuchungs-ID der gerenderten Reservierungsanzeige. Der Wert ist null für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.

responseIdentifier

responseIdentifier: string
Die Antwort-ID ist eine eindeutige Kennung für die Anzeigenantwort. Dieser Wert kann verwendet werden, um die Anzeige im Überprüfungszentrum für Anzeigen zu finden und zu blockieren.

size

size: string | number[]
Gibt die Pixelgröße des gerenderten Creatives an. Beispiel: [728, 90]. Bei leeren Anzeigenflächen ist der Wert null.

slotContentChanged

slotContentChanged: boolean
Gibt an, ob der Slot-Content mit der gerenderten Anzeige geändert wurde. Der Wert ist true, wenn der Inhalt geändert wurde, andernfalls false.

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number
Die Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige. Der Wert ist null, wenn die Anzeige keine Reservierungs- oder Backfill-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 keine Reservierungs- oder Backfill-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 Slots, 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 einen bestimmten Slot angefordert wurde.
Attribute
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

googletag.events.SlotResponseReceived

Erweitert Event
Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für einen bestimmten Slot empfangen wurde.
Attribute
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

googletag.events.SlotVisibilityChangedEvent

Erweitert Event
Dieses Ereignis wird immer dann ausgelöst, wenn sich der Prozentsatz der Fläche eines Anzeigen-Slots ändert, der auf dem Bildschirm zu sehen ist. Das Ereignis wird gedrosselt und nicht häufiger als einmal alle 200 ms ausgelöst.
Attribute
inViewPercentage
Der Prozentsatz der Fläche der Anzeige, die sichtbar ist.
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
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

Attribute


inViewPercentage

inViewPercentage: number
Der Prozentsatz der Fläche der Anzeige, die sichtbar ist. Der Wert ist eine Zahl zwischen 0 und 100.

googletag.secureSignals

Dies 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 Schnittstelle zum Verwalten sicherer Signale.
Typaliasse
SecureSignalProvider
Schnittstelle zum Zurückgeben eines sicheren Signals für einen bestimmten Bieter oder Anbieter.

Typaliasse


SecureSignalProvider

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 für sichere Bietersignale besteht aus zwei Teilen:

  1. Eine Collector-Funktion, die ein Promise zurückgibt, das in ein sicheres Signal aufgelöst wird.
  2. Eine id, die den mit dem Signal verknüpften Bieter identifiziert.
 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 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

Attribute


collectorFunction

collectorFunction: (() => Promise<string>)
Eine Funktion, die ein Promise 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 Publisher-Signalanbieter besteht aus zwei Teilen:

  1. Eine Collector-Funktion, die ein Promise zurückgibt, das in ein sicheres Signal aufgelöst wird.
  2. Ein networkCode, das den mit dem Signal verknüpften Publisher identifiziert.
 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 zurückgibt, das in ein sicheres Signal aufgelöst wird.
networkCode
Der Netzwerkcode (wie im Anzeigenblockpfad 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

Attribute


collectorFunction

collectorFunction: (() => Promise<string>)
Eine Funktion, die ein Promise zurückgibt, das in ein sicheres Signal aufgelöst wird.

networkCode

networkCode: string
Der Netzwerkcode (wie im Anzeigenblockpfad zu sehen) für den Publisher, der mit diesem sicheren Signal verknüpft ist.

googletag.secureSignals.SecureSignalProvidersArray

Eine Schnittstelle zum Verwalten sicherer Signale.
Methoden
clearAllCache
Löscht alle Signale für alle Collectors aus dem Cache.
push
Fügt dem Signalanbieter-Array einen neuen secureSignals.SecureSignalProvider hinzu und startet die Signalerstellung.

Methoden


clearAllCache

clearAllCache(): void
Löscht alle Signale für alle Collector 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 Signalanbieter-Array einen neuen secureSignals.SecureSignalProvider hinzu und startet die Signalerstellung.
Parameter
provider: SecureSignalProviderDas Objekt secureSignals.SecureSignalProvider, das dem Array hinzugefügt werden soll.