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