GPT-Referenz

In dieser Referenz wird die TypeScript-Notation zum Beschreiben von Typen verwendet. Die folgende Tabelle enthält eine kurze beispielhafte Erläuterung.

Ausdruck eingeben
string Der primitive Stringtyp.
string[] Ein Arraytyp, bei dem Werte nur Strings sein können.
number | string Ein Union-Typ, bei dem der Wert entweder eine Zahl oder ein String sein kann.
Array<number | string> Ein Arraytyp, wobei Werte ein komplexer Typ (Union) sind.
[number, string] Ein Tupeltyp, wobei der Wert ein Array aus zwei Elementen ist, das eine Zahl und einen String in dieser Reihenfolge enthalten muss.
Slot Ein Objekttyp, wobei 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 .

Anmerkungen eingeben

Ein Doppelpunkt nach einer Variablen, einem Parameternamen, einem Attributnamen oder einer Funktionssignatur bezeichnet eine Typanmerkung. Typanmerkungen beschreiben die Typen, die das Element links neben dem Doppelpunkt akzeptieren oder zurückgeben kann. Die folgende Tabelle enthält Beispiele für Typannotationen, die Sie in dieser Referenz sehen können.

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

Typdefinitionen

Typen
SingleSize | MultiSize

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

Eine Liste einzelner gültiger Größen.
"fluid" | ["fluid"]

Benannte Größen, die eine Anzeigenfläche haben kann. In den meisten Fällen ist die Größe ein Rechteck mit fester Größe. Es gibt aber auch Fälle, in denen andere Größenspezifikationen erforderlich sind. Nur die folgenden sind gültige benannte Größen:

  • fluid: Der Anzeigencontainer nimmt die Breite von 100% des übergeordneten div-Elements ein und passt seine Höhe dann an den Creative-Content an. Ähnlich wie reguläre Blockelemente auf einer Seite. Wird für native Anzeigen verwendet (weitere Informationen). Sowohl fluid als auch ['fluid'] sind zulässige Formate, um eine Slotgröße als flexibel zu deklarieren.
SingleSizeArray | NamedSize

Eine gültige Größe für einen Slot.
[number, number]

Array aus zwei Zahlen, die für [Breite, Höhe] stehen.
[SingleSizeArray, GeneralSize]

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

Eine Liste von Größenzuordnungen.
"unhideWindow" | "navBar"

Unterstützte Trigger für Interstitial-Anzeigen.
"disablePersonalization"

Unterstützte Datenschutzmaßnahmen für Publisher.
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
BidderSignalProvider | PublisherSignalProvider

Schnittstelle zur Rückgabe eines sicheren Signals für einen bestimmten Bieter oder Anbieter. Sie müssen entweder id oder networkCode angeben, aber nicht beides.

Enum-Typen

Enums
googletag.enums.OutOfPageFormat
Von GPT unterstützte Out-of-Page-Formate.
googletag.enums.TrafficSource
Von GPT unterstützte Besucherquellen

googletag.enums.OutOfPageFormat

  • Von GPT unterstützte Out-of-Page-Formate.

  • Weitere Informationen
  • Werte
    BOTTOM_ANCHOR
    Ankerformat, bei dem die Anzeigenfläche am unteren Rand des Darstellungsbereichs fixiert ist.
    INTERSTITIAL
    Web-Interstitial-Creative-Format.
    LEFT_SIDE_RAIL
    Linker Anzeigenstreifen.
    REWARDED
    Anzeigen mit Prämie
    RIGHT_SIDE_RAIL
    Rechter Anzeigenstreifen im seitlichen Anzeigenstreifen.
    TOP_ANCHOR
    Ankerformat, bei dem die Anzeigenfläche am oberen Rand des Darstellungsbereichs fixiert ist.

googletag.enums.TrafficSource

  • Von GPT unterstützte Besucherquellen

  • Weitere Informationen
  • Werte
    ORGANIC
    Direkte URL-Eingabe, Websitesuche oder App-Download
    PURCHASED
    Zugriffe wurden von Properties weitergeleitet, die keine eigenen Properties sind (durch akquirierte oder auf andere Weise geförderte Aktivitäten).

googletag

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

Variablenzusammenfassung
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 GPT-bezogener Aufrufe
pubadsReady
Flag, das angibt, dass PubAdsService aktiviert, geladen und voll funktionsfähig ist.
secureSignalProviders
Referenz zum Array der Anbieter sicherer Signale.
Funktionsübersicht
companionAds
Gibt einen Verweis auf 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 Anzeigenblockgröße und verknüpft sie mit der ID eines div-Elements auf der Seite, die die Anzeige enthalten soll.
destroySlots
Zerstört die angegebenen Anzeigenflächen und entfernt alle zugehörigen Objekte und Verweise auf diese Anzeigenflächen aus den GPTs.
disablePublisherConsole
Deaktiviert die Google Publisher Console.
display
Weist Slotdienste an, die Anzeigenfläche zu rendern.
enableServices
Aktiviert alle GPT-Dienste, die für Anzeigenflächen auf der Seite definiert wurden.
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 von PubAdsService erstellten Anzeigencontainer-iFrames fest
setConfig
Legt allgemeine Konfigurationsoptionen für die Seite fest.
sizeMapping
Erstellt einen neuen SizeMappingBuilder.

googletag.apiReady

  • apiReady: boolean | undefined

  • Flag, das angibt, dass die GPT API geladen wurde und aufgerufen werden kann Diese Eigenschaft lautet einfach undefined, bis die API bereit ist.

    Beachten Sie, dass für den asynchronen Modus googletag.cmd empfohlen wird, um Callbacks in die Warteschlange zu stellen, wenn GPT bereit ist. Diese Callbacks müssen googletag.apiReady nicht prüfen, da sie garantiert ausgeführt werden, sobald die API eingerichtet ist.

  • Beispiel

    JavaScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    JavaScript (alte Version)

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    TypeScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

googletag.cmd

  • cmd: Array<(this: typeof globalThis) => void> | CommandArray

  • Verweis auf die globale Befehlswarteschlange für die asynchrone Ausführung GPT-bezogener Aufrufe.

    Die Variable googletag.cmd wird durch die GPT-Tag-Syntax auf der Seite für ein leeres JavaScript-Array initialisiert. cmd.push ist die Standardmethode Array.push, mit der am Ende des Arrays ein Element hinzugefügt wird. Wenn das GPT-JavaScript geladen wird, durchsucht es das Array und führt alle Funktionen der Reihe nach 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. Dieser Mechanismus ermöglicht es GPT, die gefühlte Latenz zu reduzieren, indem JavaScript asynchron abgerufen wird, während der Browser die Seite weiterhin rendert.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    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());
});

googletag.pubadsReady

  • pubadsReady: boolean | undefined

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

googletag.secureSignalProviders

  • secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

  • Verweis auf das Array der Anbieter sicherer Signale.

    Das Array der Anbieter sicherer Signale akzeptiert eine Reihe von Funktionen zur Signalgenerierung und ruft sie der Reihe nach auf. Es soll ein Standardarray ersetzen, mit dem signalerzeugende Funktionen in die Warteschlange gestellt werden, die nach dem Laden des GPT aufgerufen werden sollen.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    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

googletag.companionAds

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

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

  • Beispiel

    JavaScript

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

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

    JavaScript (alte Version)

    // 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: string
    Vollständiger Pfad für Anzeigenblock mit Netzwerkcode und Anzeigenblockcode
    div?: string | OutOfPageFormat
    ID des div-Elements, das diesen Anzeigenblock oder OutOfPageFormat enthält.
  • Rückgabe
    Slot | null
    Die neu erstellte Anzeigenfläche oder null, wenn ein Slot nicht erstellt werden kann.

googletag.defineSlot

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

  • Erstellt eine Anzeigenfläche mit einem bestimmten Anzeigenblockpfad und einer bestimmten Anzeigenblockgröße und verknüpft sie mit der ID eines div-Elements auf der Seite, die die Anzeige enthalten soll.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

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

    TypeScript

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    Weitere Informationen
  • Parameter
    adUnitPath: string
    Vollständiger Pfad des Anzeigenblocks mit Netzwerkcode und Blockcode
    size: GeneralSize
    Breite und Höhe der hinzugefügten Anzeigenfläche. Die Größe, die in der Anzeigenanfrage verwendet wird, wenn keine responsive Größenzuordnung angegeben wird oder der Darstellungsbereich kleiner als die kleinste Größe ist, die in der Zuordnung angegeben wurde.
    div?: string
    ID des div-Elements, das diesen Anzeigenblock enthalten wird.
  • Rückgabe
    Slot | null
    Die neu erstellte Anzeigenfläche oder null, wenn ein Slot nicht erstellt werden kann.

googletag.destroySlots

  • destroySlots(slots?: Slot[]): boolean

  • Zerstört die angegebenen Anzeigenflächen und entfernt alle zugehörigen Objekte und Verweise auf diese Anzeigenflächen aus den GPTs. Diese API unterstützt keine Rücksendungs- und Companion-Flächen.

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

    Insbesondere wird durch das Löschen einer Anzeigenfläche die Anzeige aus dem langlebigen Seitenaufruf des GPT entfernt. So werden zukünftige Anfragen nicht von Hindernissen oder Konkurrenzausschlüssen beeinflusst, die diese Anzeige betreffen. Wenn diese Funktion nicht aufgerufen wird, bevor das div-Element einer Anzeigenfläche von der Seite entfernt wird, führt dies zu einem undefinierten Verhalten.

  • Beispiel

    JavaScript

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

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

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

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

    JavaScript (alte Version)

    // 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
    slots?: Slot[]
    Das Array der zu löschenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht.
  • Rückgabe
    boolean
    true, wenn Slots gelöscht wurden, andernfalls false.

googletag.disablePublisherConsole

  • disablePublisherConsole(): void

  • Deaktiviert die Google Publisher Console.

  • Weitere Informationen

googletag.display

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

  • Weist Slotdienste an, die Anzeigenfläche zu rendern. Jede Anzeigenfläche sollte nur einmal pro Seite angezeigt werden. Alle Anzeigenflächen müssen definiert und mit einem Dienst verknüpft sein, bevor sie angezeigt werden können. Der Anzeigeaufruf darf erst erfolgen, wenn das Element im DOM vorhanden ist. Üblicherweise wird dies in einem Skriptblock innerhalb des im Methodenaufruf genannten div-Elements platziert.

    Wenn die Einzelanfrage-Architektur verwendet wird, werden alle nicht abgerufenen Anzeigenflächen zum Zeitpunkt des Aufrufs dieser Methode gleichzeitig abgerufen. Um zu erzwingen, dass eine Anzeigenfläche nicht angezeigt wird, muss das gesamte div-Element entfernt werden.

  • Beispiel

    JavaScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});

    JavaScript (alte Version)

    googletag.cmd.push(function () {
  googletag.display("div-1");
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    Weitere Informationen
  • Parameter
    divOrSlot: string | Element | Slot
    Entweder die ID des div-Elements, das die Anzeigenfläche oder das div-Element enthält, oder das Slot-Objekt. Wenn ein div-Element angegeben wird, muss es ein ID-Attribut haben, das mit der an defineSlot übergebenen ID übereinstimmt.

googletag.enableServices

  • enableServices(): void

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

googletag.getVersion

  • getVersion(): string

  • Gibt die aktuelle Version von GPT zurück.

  • Weitere Informationen
  • Rückgabe
    string
    Der aktuell ausgeführte GPT-Versionsstring.

googletag.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 (alte Version)

    // 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
    div?: string
    Die div-ID der Anzeigenfläche. Dieser Wert ist optional. Wenn Sie diese Informationen angeben, wird in der Publisher Console versucht, die Seite mit Details zur angegebenen Anzeigenfläche zu öffnen.

googletag.pubads

googletag.setAdIframeTitle

  • setAdIframeTitle(title: string): void

  • Legt den Titel für alle von PubAdsService erstellten Anzeigencontainer-iFrames fest

  • Beispiel

    JavaScript

    googletag.setAdIframeTitle("title");

    JavaScript (alte Version)

    googletag.setAdIframeTitle("title");

    TypeScript

    googletag.setAdIframeTitle("title");
  • Parameter
    title: string
    Der neue Titel für alle Anzeigencontainer-iFrames

googletag.setConfig

googletag.sizeMapping

googletag.CommandArray

Das Befehlsarray akzeptiert eine Reihe von Funktionen und ruft diese der Reihe nach auf. Es soll ein Standardarray ersetzen, mit dem Funktionen in die Warteschlange eingereiht werden, die nach dem Laden von GPT aufgerufen werden.

Methodenzusammenfassung
push
Führt die in den Argumenten angegebenen Funktionen der Reihe nach aus.

push

  • push(...f: Array<(this: typeof globalThis) => void>): number

  • Führt die in den Argumenten angegebenen Funktionen der Reihe nach aus.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    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
    ...f: Array<(this: typeof globalThis) => void>
    Eine auszuführende JavaScript-Funktion. Die Laufzeitbindung ist immer globalThis. Übergeben Sie gegebenenfalls eine Pfeilfunktion, um den this-Wert des einschließenden lexikalischen Kontexts beizubehalten.
  • Rückgabe
    number
    Die Anzahl der bisher verarbeiteten Befehle. Dies ist mit dem Rückgabewert von Array.push (der aktuellen Länge des Arrays) kompatibel.

googletag.CompanionAdsService

Verlängert Service

Companion-Anzeigendienst. Dieser Dienst wird von Videoanzeigen zur Auslieferung von Companion-Anzeigen verwendet.

Methodenzusammenfassung
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
Rufen Sie die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
removeEventListener
Entfernt einen zuvor registrierten Listener.
setRefreshUnfilledSlots
Legt fest, ob nicht gefüllte Companion-Flächen automatisch aufgefüllt werden.
Weitere Informationen

setRefreshUnfilledSlots

  • setRefreshUnfilledSlots(value: boolean): void

  • Sie können festlegen, ob Companion-Flächen, die nicht gefüllt wurden, automatisch aufgefüllt werden.

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

  • Beispiel

    JavaScript

    googletag.companionAds().setRefreshUnfilledSlots(true);

    JavaScript (alte Version)

    googletag.companionAds().setRefreshUnfilledSlots(true);

    TypeScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
  • Parameter
    value: boolean
    true, um freie Anzeigenflächen automatisch aufzufüllen, false, um sie unverändert zu lassen.

googletag.PrivacySettingsConfig

Konfigurationsobjekt für Datenschutzeinstellungen.

Property-Übersicht
childDirectedTreatment
Gibt an, ob die Seite als auf Kinder ausgerichtet behandelt werden soll.
limitedAds
Die Anzeigenbereitstellung wird im Modus Eingeschränkte Anzeigenausrichtung aktiviert, sodass Publisher die gesetzlichen Vorschriften einhalten können.
nonPersonalizedAds
Ermöglicht die Auslieferung im Modus für nicht personalisierte Anzeigen, um die Compliance-Anforderungen von Publishern zu erfüllen.
restrictDataProcessing
Ermöglicht die Ausführung der Bereitstellung im Modus mit eingeschränkter Verarbeitung, um die gesetzlichen Vorschriften von Publishern zu erfüllen.
trafficSource
Gibt an, ob Anfragen gekaufte oder organische Zugriffe betreffen.
underAgeOfConsent
Mit dieser Spalte wird angegeben, ob Anzeigenanfragen als von Nutzern stammend nicht volljährig gekennzeichnet werden sollen.
Weitere Informationen

childDirectedTreatment

limitedAds

  • limitedAds: boolean

  • Hiermit wird die Auslieferung im Modus Eingeschränkte Anzeigenausrichtung aktiviert, um die gesetzlichen Anforderungen von Publishern zu erfüllen.

    Sie haben zwei Möglichkeiten, GPT anzuweisen, die eingeschränkte Anzeigenausrichtung anzufordern:

    • Automatisch mithilfe eines Signals einer Plattform zur Einwilligungsverwaltung des IAB TCF 2.0
    • Manuell durch Festlegen des Werts dieses Felds auf true.
    Die eingeschränkte Anzeigenausrichtung kann nur manuell konfiguriert werden, wenn GPT über die URL für die eingeschränkte Anzeigenausrichtung geladen wird. Wenn Sie versuchen, die Einstellung zu ändern, nachdem GPT über die Standard-URL geladen wurde, wird eine Warnung in der Publisher Console angezeigt.

    Hinweis: Die eingeschränkte Anzeigenausrichtung muss nicht manuell aktiviert werden, wenn eine CMP verwendet wird.

  • 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 (alte Version)

    // 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

nonPersonalizedAds

  • nonPersonalizedAds: boolean

  • Ermöglicht die Auslieferung im Modus für nicht personalisierte Anzeigen, um die Compliance-Anforderungen von Publishern zu erfüllen.

restrictDataProcessing

trafficSource

  • trafficSource: TrafficSource

  • Gibt an, ob Anfragen gekaufte oder organische Zugriffe betreffen. Mit diesem Wert wird die Dimension Besucherquelle in der Ad Manager-Berichterstellung erfasst. Wenn nichts festgelegt ist, wird für die Besucherquelle in Berichten standardmäßig „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 (alte Version)

    // 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,
});

underAgeOfConsent

  • underAgeOfConsent: null | boolean

  • Mit dieser Spalte wird angegeben, ob Anzeigenanfragen als von Nutzern stammend nicht volljährig gekennzeichnet werden sollen. Legen Sie null fest, um die Konfiguration zu löschen.

googletag.PubAdsService

Verlängert Service

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

Methodenzusammenfassung
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 Anzeigenflächen und ersetzt sie durch leeren Inhalt.
clearCategoryExclusions
Löscht alle Ausschlusslabels für Anzeigenkategorien auf Seitenebene.
clearTargeting
Löscht die benutzerdefinierten Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel.
collapseEmptyDivs
Aktiviert die Minimierung von Anzeigenflächen-Divs, sodass sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt vorhanden ist.
disableInitialLoad
Hiermit werden Anzeigenanfragen beim Seitenaufbau deaktiviert, Anzeigen können jedoch über einen PubAdsService.refresh-Aufruf angefordert werden.
display
Erstellt eine Anzeigenfläche mit dem Pfad und der Größe des angegebenen Anzeigenblocks und zeigt sie an.
enableLazyLoad
Aktiviert das Lazy Loading in GPT gemäß der Definition im Konfigurationsobjekt.
enableSingleRequest
Aktiviert den Einzelanfragemodus zum gleichzeitigen Abrufen mehrerer Anzeigen.
enableVideoAds
Signalisiert GPT, dass Videoanzeigen auf der Seite vorhanden sind.
get
Gibt den Wert für das AdSense-Attribut zurück, das mit dem jeweiligen Schlüssel verknüpft ist.
getAttributeKeys
Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden.
getSlots
Rufen Sie die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
getTargeting
Gibt einen bestimmten benutzerdefinierten Targeting-Parameter auf Dienstebene zurück, der festgelegt wurde
getTargetingKeys
Gibt die Liste aller festgelegten benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück
isInitialLoadDisabled
Gibt zurück, ob die ersten Anfragen für Anzeigen durch einen vorherigen PubAdsService.disableInitialLoad-Aufruf deaktiviert wurden.
refresh
Ruft neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite ab und zeigt diese an.
removeEventListener
Entfernt einen zuvor registrierten Listener.
set
Legt Werte für AdSense-Attribute fest, die für alle Anzeigenflächen unter dem Publisher-Anzeigendienst gelten.
setCategoryExclusion
Legt einen Ausschluss von Anzeigenkategorien auf Seitenebene für den angegebenen Labelnamen fest.
setCentering
Aktiviert und deaktiviert die horizontale Zentrierung von Anzeigen.
setForceSafeFrame
Mit dieser Richtlinie wird konfiguriert, ob das Rendering aller Anzeigen auf der Seite mit einem SafeFrame-Container erzwungen werden soll.
setLocation
Gibt Standortinformationen von Websites weiter, sodass Sie Werbebuchungen per geografischem Targeting auf bestimmte Orte 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
Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest.
setTargeting
Legt benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel fest, die für alle Publisher-Anzeigen-Service-Anzeigenflächen gelten.
setVideoContent
Legt die Informationen zum Videocontent fest, die zusammen mit den Anzeigenanfragen für Targeting- und auszuschließende Inhalte gesendet werden sollen.
updateCorrelator
Ändert den Korrelator, der mit Anzeigenanfragen gesendet wird, wodurch ein neuer Seitenaufruf gestartet wird.

clear

  • clear(slots?: Slot[]): boolean

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

    Insbesondere wird die Anzeige durch das Löschen einer Anzeigenfläche aus dem langlebigen Seitenaufruf des GPT entfernt. So werden zukünftige Anfragen nicht von Hindernissen oder Konkurrenzausschlüssen 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 (alte Version)

    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
    slots?: Slot[]
    Das Array der zu löschenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht.
  • Rückgabe
    boolean
    Gibt true zurück, wenn Anzeigenflächen gelöscht wurden, andernfalls false.

clearCategoryExclusions

  • clearCategoryExclusions(): PubAdsService

  • Löscht alle Ausschlusslabels für Anzeigenkategorien auf Seitenebene. Dies ist nützlich, wenn Sie die Anzeigenfläche 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 (alte Version)

    // 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
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem die Methode aufgerufen wurde.

clearTargeting

  • clearTargeting(key?: string): PubAdsService

  • Löscht die benutzerdefinierten Targeting-Parameter für einen bestimmten Schlüssel oder für 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 (alte Version)

    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
    key?: string
    Parameterschlüssel für die Ausrichtung. Der Schlüssel ist optional. Wenn Sie ihn nicht angeben, werden alle Targeting-Parameter gelöscht.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem die Methode aufgerufen wurde.

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

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

  • Weitere Informationen
  • Parameter
    collapseBeforeAdFetch?: boolean
    Gibt an, ob die Anzeigenflächen minimiert werden sollen, noch bevor die Anzeigen abgerufen werden. Dieser Parameter ist optional. Wenn er nicht angegeben ist, wird false als Standardwert verwendet.
  • Rückgabe
    boolean
    Gibt true zurück, wenn der Div-Minimierungsmodus aktiviert wurde, und false, wenn der Minimierungsmodus nicht aktiviert werden kann, weil die Methode nach dem Aktivieren des Dienstes aufgerufen wurde.

disableInitialLoad

  • disableInitialLoad(): void

  • Hiermit werden Anzeigenanfragen beim Seitenaufbau deaktiviert, Anzeigen können jedoch über einen PubAdsService.refresh-Aufruf angefordert werden. Dies 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 eine Anzeigenfläche mit dem Pfad und der Größe des angegebenen Anzeigenblocks und zeigt sie an. Diese Methode funktioniert nicht im Einzelanfragemodus.

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

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

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

    TypeScript

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
    Weitere Informationen
  • Parameter
    adUnitPath: string
    Der Pfad zum Anzeigenblock der Anzeigenfläche, die gerendert werden soll.
    size: GeneralSize
    Breite und Höhe des Slots.
    div?: string | Element
    Entweder die ID des div -Elements, das die Anzeigenfläche enthält, oder das div-Element selbst.
    clickUrl?: string
    Die Klick-URL, die für diese Anzeigenfläche verwendet werden soll.

enableLazyLoad

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

  • Aktiviert das Lazy Loading in GPT gemäß der Definition im Konfigurationsobjekt. Detailliertere Beispiele finden Sie im Beispiel zum Lazy Loading.

    Hinweis:Das Lazy Loading funktioniert bei der Einzelanfrage-Architektur nur, wenn sich alle Slots außerhalb des Abrufbereichs 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 (alte Version)

    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
    config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
    Das Konfigurationsobjekt ermöglicht die Anpassung von Lazy-Verhalten. Für weggelassene Konfigurationen wird eine von Google festgelegte Standardkonfiguration verwendet, die 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 einer Anzeigenfläche vom aktuellen Darstellungsbereich, bevor die Anzeige abgerufen wird, angegeben als Prozentsatz der Größe des Darstellungsbereichs. Ein Wert von 0 bedeutet, dass die Anzeigenfläche in den Darstellungsbereich gelangt, 100 bedeutet, dass die Anzeige einen Darstellungsbereich entfernt ist, und so weiter.
    • renderMarginPercent

      Der Mindestabstand einer Anzeigenfläche zum aktuellen Darstellungsbereich, bevor eine Anzeige gerendert wird Dies ermöglicht das Vorabrufen der Anzeige, aber das Rendern und Herunterladen anderer Unterressourcen. Der Wert funktioniert genau wie fetchMarginPercent als Prozentsatz des Darstellungsbereichs.
    • mobileScaling

      Ein Multiplikator, der auf Ränder auf Mobilgeräten angewendet wird. Dadurch können auf Mobilgeräten und Computern verschiedene Margen erzielt werden. Ein Wert von 2,0 multipliziert beispielsweise alle Ränder auf Mobilgeräten mit 2, wodurch der Mindestabstand, den ein Slot sein kann, vor dem Abrufen und Rendern erhöht wird.

enableSingleRequest

  • enableSingleRequest(): boolean

  • Aktiviert den Einzelanfragemodus zum gleichzeitigen Abrufen mehrerer Anzeigen. Dazu müssen alle Publisher-Anzeigenflächen definiert und dem PubAdsService hinzugefügt werden, bevor der Dienst aktiviert wird. Der Einzelanfragemodus muss festgelegt werden, bevor der Dienst aktiviert wird.

  • Weitere Informationen
  • Rückgabe
    boolean
    Gibt 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

  • Signalisiert GPT, dass Videoanzeigen auf der Seite vorhanden sind. Dies ermöglicht Konkurrenzausschluss bei Display- und Videoanzeigen. Wenn die Videoinhalte bekannt sind, rufen Sie PubAdsService.setVideoContent auf, um Inhaltsausschlüsse für Displayanzeigen verwenden zu können.

get

  • get(key: string): null | string

  • Gibt den Wert für das AdSense-Attribut zurück, das mit dem jeweiligen Schlüssel verknüpft ist.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    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: string
    Name des zu suchenden Attributs.
  • Rückgabe
    null | string
    Aktueller Wert für den Attributschlüssel oder null, wenn der Schlüssel nicht vorhanden ist.

getAttributeKeys

  • getAttributeKeys(): string[]

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

  • 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 (alte Version)

    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'].
  • Rückgabe
    string[]
    Array von Attributschlüsseln, die für diesen Dienst festgelegt wurden. 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 (alte Version)

    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: string
    Der Targeting-Schlüssel, nach dem gesucht werden soll.
  • Rückgabe
    string[]
    Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, falls kein solcher Schlüssel vorhanden ist.

getTargetingKeys

  • getTargetingKeys(): string[]

  • Gibt die Liste aller festgelegten benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück

  • Beispiel

    JavaScript

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

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

    JavaScript (alte Version)

    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'].
  • Rückgabe
    string[]
    Array von Targeting-Schlüsseln Reihenfolge ist nicht definiert.

isInitialLoadDisabled

refresh

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

  • Ruft neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite ab und zeigt diese an. Funktioniert nur im asynchronen Renderingmodus.

    Damit die Funktion in allen Browsern richtig funktioniert, muss vor dem Aufruf von refresh ein Aufruf von display für die Anzeigenfläche erfolgen. Wenn der Aufruf von display weggelassen wird, kann die Aktualisierung zu einem unerwarteten Verhalten führen. Bei Bedarf kann die Methode PubAdsService.disableInitialLoad verwendet werden, um zu verhindern, dass display eine Anzeige abruft.

    Durch das Aktualisieren einer Anzeigenfläche wird die alte Anzeige aus dem langlebigen Seitenaufruf des GPT entfernt. So werden künftige Anfragen nicht von Hindernissen oder Konkurrenzausschlüssen 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 (alte Version)

    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
    slots?: null | Slot[]
    Die zu aktualisierenden Anzeigenflächen. Das Array ist optional. Wenn kein Array angegeben ist, werden alle Slots aktualisiert.
    options?: { changeCorrelator: boolean }
    Konfigurationsoptionen für diesen Aktualisierungsaufruf.
    • changeCorrelator

      Gibt an, ob ein neuer Korrelator zum Abrufen von Anzeigen generiert werden soll. Unsere Ad-Server behalten diesen Korrelatorwert kurz bei (derzeit für 30 Sekunden, dies kann sich jedoch ändern), sodass Anfragen mit demselben Korrelator, die nahe beieinander eingehen, als einzelner Seitenaufruf betrachtet werden. Standardmäßig wird für jede Aktualisierung ein neuer Korrelator generiert.

      Hinweis:Diese Option hat keine Auswirkungen auf den langlebigen Seitenaufruf von GPT, bei dem die Anzeigen, die sich derzeit auf der Seite befinden, automatisch wiedergegeben werden und keine Ablaufzeit haben.

set

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

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

    Wenn Sie dies mehrmals für denselben Schlüssel aufrufen, werden die zuvor festgelegten 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 (alte Version)

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

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    Weitere Informationen
  • Parameter
    key: string
    Der Name des Attributs.
    value: string
    Attributwert.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem die Methode aufgerufen wurde.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): PubAdsService

  • Legt einen Ausschluss von Anzeigenkategorien auf Seitenebene für den angegebenen Labelnamen fest.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

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

    TypeScript

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
    Weitere Informationen
  • Parameter
    categoryExclusion: string
    Das hinzuzufügende Ausschlusslabel für die Anzeigenkategorie.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem die Methode aufgerufen wurde.

setCentering

  • setCentering(centerAds: boolean): void

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

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

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

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

    TypeScript

    // Make ads centered.
googletag.pubads().setCentering(true);
  • Parameter
    centerAds: boolean
    true, um Anzeigen zu zentrieren, false, um sie linksbündig auszurichten.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

  • Mit der Richtlinie wird konfiguriert, ob das Rendering aller Anzeigen auf der Seite mit einem SafeFrame-Container erzwungen werden soll.

    Bei der Verwendung dieser API ist Folgendes zu beachten:

    • Diese Einstellung gilt nur für nachfolgende Anzeigenanfragen für die jeweiligen Anzeigenflächen.
    • Die Einstellung auf Anzeigenflächenebene überschreibt immer die Einstellung auf Seitenebene.
    • Wenn der Wert auf true (auf Anzeigenflächen- oder Seitenebene) festgelegt ist, wird die Anzeige unabhängig von der Auswahl auf der Google Ad Manager-Benutzeroberfläche immer mit einem SafeFrame-Container gerendert.
    • Wenn false festgelegt oder nicht angegeben ist, wird die Anzeige abhängig vom Creative-Typ und der Auswahl auf der Google Ad Manager-Benutzeroberfläche mit einem SafeFrame-Container gerendert.
    • Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken könnte, die versuchen, ihre iFrames zu überwinden oder sich darauf zu verlassen, dass sie direkt auf einer Publisher-Seite gerendert 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 (alte Version)

    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: boolean
    Mit true wird erzwungen, dass alle Anzeigen auf der Seite in SafeFrames gerendert werden. Mit false wird die vorherige Einstellung auf "false" geändert. Wird es auf false gesetzt, wenn nichts anderes angegeben wurde, ändert sich nichts.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, für das die Funktion aufgerufen wurde.

setLocation

  • setLocation(address: string): PubAdsService

  • Gibt Standortinformationen von Websites weiter, sodass Sie Werbebuchungen per geografischem Targeting auf bestimmte Orte ausrichten können.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

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

    TypeScript

    // Postal code:
googletag.pubads().setLocation("10001,US");
  • Parameter
    address: string
    Adresse im freien Format.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem 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 (alte Version)

    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: PrivacySettingsConfig
    Objekt, das die Konfiguration der Datenschutzeinstellungen enthält.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, für das die Funktion aufgerufen wurde.

setPublisherProvidedId

  • setPublisherProvidedId(ppid: string): PubAdsService

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

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

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

    TypeScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    Weitere Informationen
  • Parameter
    ppid: string
    Eine alphanumerische ID, die vom Publisher bereitgestellt wird. Muss zwischen 32 und 150 Zeichen lang sein.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem die Methode aufgerufen wurde.

setSafeFrameConfig

  • setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

  • Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest. Alle nicht erkannten 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 Seitenebene werden durch Einstellungen auf Anzeigenflächenebene überschrieben, sofern angegeben.

  • 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 (alte Version)

    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: SafeFrameConfig
    Das Konfigurationsobjekt.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem 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 Publisher-Anzeigen-Service-Anzeigenflächen gelten. Durch mehrfaches Aufrufen für denselben Schlüssel 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 (alte Version)

    // 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: string
    Parameterschlüssel für die Ausrichtung.
    value: string | string[]
    Wert des Targeting-Parameters oder Array von Werten.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, auf dem 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 auszuschließende Inhalte gesendet werden sollen. Videoanzeigen werden beim Aufruf dieser Methode automatisch aktiviert. Verwenden Sie für videoContentId und videoCmsId die Werte, die für den Google Ad Manager-Contentaufnahmedienst bereitgestellt werden.

  • Weitere Informationen
  • Parameter
    videoContentId: string
    Die ID des Videocontents.
    videoCmsId: string
    Die CMS-ID des Videos.

updateCorrelator

  • updateCorrelator(): PubAdsService

  • Ändert den Korrelator, der mit Anzeigenanfragen gesendet wird, wodurch ein neuer Seitenaufruf gestartet wird. Der Korrelator ist für alle Anzeigenanfragen, die von einem Seitenaufruf stammen, gleich und bei allen Seitenaufrufen eindeutig. Gilt nur für den asynchronen Modus.

    Hinweis:Dies hat keine Auswirkungen auf den langlebigen Seitenaufruf von GPT, da dieser automatisch die tatsächlichen Anzeigen auf der Seite widerspiegelt und keine Ablaufzeit hat.

  • Beispiel

    JavaScript

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

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

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

    JavaScript (alte Version)

    // 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.
  • Rückgabe
    PubAdsService
    Das Dienstobjekt, für das die Funktion aufgerufen wurde.

googletag.ResponseInformation

Ein Objekt, das eine einzelne Anzeigenantwort darstellt.

Property-Übersicht
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

advertiserId

  • advertiserId: null | number

  • Die ID des Werbetreibenden.

campaignId

  • campaignId: null | number

  • Die ID der Kampagne.

creativeId

  • creativeId: null | number

  • Die ID des Creatives.

creativeTemplateId

  • creativeTemplateId: null | number

  • Die Vorlagen-ID der Anzeige.

lineItemId

  • lineItemId: null | number

  • Die ID der Position.

googletag.RewardedPayload

Ein Objekt, das die mit einer Anzeige mit Prämie verknüpfte Prämie darstellt

Property-Übersicht
amount
Die Anzahl der Artikel, die in der Prämie enthalten sind.
type
Die Art des in der Prämie enthaltenen Artikels (z. B. „Münze“).
Weitere Informationen

amount

  • amount: number

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

type

  • type: string

  • Die Art des in der Prämie enthaltenen Artikels (z. B. „Münze“).

googletag.SafeFrameConfig

Konfigurationsobjekt für SafeFrame-Container.

Property-Übersicht
allowOverlayExpansion
Gibt an, ob SafeFrame zulassen soll, dass Anzeigencontent durch Überlagerung des Seitencontents maximiert wird
allowPushExpansion
Legt fest, ob SafeFrame die Maximierung des Anzeigencontents durch Übertragen des Seitencontents zulassen soll
sandbox
Gibt an, ob SafeFrame das HTML5-Sandbox-Attribut verwenden soll, um die Navigation auf oberster Ebene ohne Nutzerinteraktion zu verhindern.
useUniqueDomain
Veraltet. Gibt an, ob SafeFrame zufällig ausgewählte Subdomains für Reservierungs-Creatives verwenden soll
Weitere Informationen

allowOverlayExpansion

  • allowOverlayExpansion: boolean

  • Gibt an, ob SafeFrame zulassen soll, dass Anzeigencontent durch Überlagerung des Seitencontents maximiert wird

allowPushExpansion

  • allowPushExpansion: boolean

  • Legt fest, ob SafeFrame die Maximierung des Anzeigencontents durch Übertragen des Seitencontents zulassen soll

sandbox

  • sandbox: boolean

  • Gibt an, ob SafeFrame das HTML5-Sandbox-Attribut verwenden soll, um die Navigation auf oberster Ebene ohne Nutzerinteraktion zu verhindern. Der einzige gültige Wert ist true (kann nicht zu false geändert werden). Beachte, dass durch das Sandbox-Attribut Plug-ins wie Flash deaktiviert werden.

useUniqueDomain

  • useUniqueDomain: null | boolean

  • Gibt an, ob SafeFrame zufällig ausgewählte Subdomains für Reservierungs-Creatives verwenden soll Übergeben Sie null, um den gespeicherten Wert zu löschen.

    Hinweis: Diese Funktion ist standardmäßig aktiviert.

  • Weitere Informationen

googletag.Service

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

Methodenzusammenfassung
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
Rufen Sie die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
removeEventListener
Entfernt einen zuvor registrierten Listener.

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:

    Beim Aufruf wird ein Objekt des entsprechenden Ereignistyps an den Listener ü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 (alte Version)

    // 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: K
    Ein String, der den vom GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird zwischen Groß- und Kleinschreibung unterschieden.
    listener: (arg: EventTypeMap[K]) => void
    Funktion, die ein einzelnes Argument für das Ereignisobjekt annimmt.
  • Rückgabe
    Service
    Das Dienstobjekt, auf dem die Methode aufgerufen wurde.

getSlots

  • getSlots(): Slot[]

  • Rufen Sie die Liste der Slots ab, die mit diesem Dienst verknüpft sind.

  • Rückgabe
    Slot[]
    Slots werden in der Reihenfolge angezeigt, in der sie der Dienstleistung 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 (alte Version)

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

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

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

    TypeScript

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

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

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});
  • Parameter
    eventType: K
    Ein String, der den vom GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird zwischen Groß- und Kleinschreibung unterschieden.
    listener: (event: EventTypeMap[K]) => void
    Funktion, die ein einzelnes Argument für das Ereignisobjekt annimmt.

googletag.SizeMappingBuilder

Builder für Größenzuordnungsspezifikationsobjekte. Dieser Builder wird zur Verfügung gestellt, um Größenspezifikationen einfach zu erstellen.

Methodenzusammenfassung
addSize
Fügt eine Zuordnung von einem Array mit einfacher Größe, das den Darstellungsbereich darstellt, zu einem Array mit einer oder mehreren Größen hinzu, das die Anzeigenfläche darstellt.
build
Erstellt eine Größenzuordnungsspezifikation aus den Zuordnungen, die diesem Builder hinzugefügt wurden.
Weitere Informationen

addSize

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

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

  • Beispiel

    JavaScript

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

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

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

    JavaScript (alte Version)

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

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

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

    TypeScript

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

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

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
  • Parameter
    viewportSize: SingleSizeArray
    Die Größe des Darstellungsbereichs für diesen Zuordnungseintrag.
    slotSize: GeneralSize
    Die Größen der Anzeigenfläche für diesen Zuordnungseintrag.
  • Rückgabe
    SizeMappingBuilder
    Ein Verweis auf diesen Builder.

build

  • build(): null | 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.

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

googletag.Slot

Eine Anzeigenfläche ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt.

Methodenzusammenfassung
addService
Fügt diesem Slot ein Service hinzu.
clearCategoryExclusions
Löscht alle Ausschlusslabels für Anzeigenkategorien auf Anzeigenflächenebene für diese Anzeigenfläche.
clearTargeting
Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Anzeigenflächenebene für diese Anzeigenfläche.
defineSizeMapping
Legt ein Array von Zuordnungen von einer minimalen Größe des Darstellungsbereichs zur Anzeigenflächengröße für diese Anzeigenfläche fest.
get
Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diese Anzeigenfläche verknüpft ist.
getAdUnitPath
Gibt den vollständigen Pfad des Anzeigenblocks mit dem Netzwerkcode und dem Pfad des Anzeigenblocks zurück
getAttributeKeys
Gibt die Liste der für diese Anzeigenfläche festgelegten Attributschlüssel zurück
getCategoryExclusions
Gibt die Ausschlusslabels der Anzeigenkategorie für diese Anzeigenfläche zurück.
getResponseInformation
Gibt die Informationen zur Anzeigenantwort zurück.
getSlotElementId
Gibt die ID der Anzeigenfläche div zurück, die beim Definieren der Anzeigenfläche angegeben wurde.
getTargeting
Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diese Anzeigenfläche festgelegt ist.
getTargetingKeys
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diese Anzeigenfläche festgelegt sind.
set
Legt einen Wert für ein AdSense-Attribut für diese Anzeigenfläche fest.
setCategoryExclusion
Legt ein Ausschlusslabel für die Anzeigenkategorie auf Anzeigenflächenebene für diese Anzeigenfläche fest.
setClickUrl
Legt die Klick-URL fest, an die Nutzer weitergeleitet werden, nachdem sie auf die Anzeige geklickt haben.
setCollapseEmptyDiv
Legt fest, ob die Anzeigenfläche div ausgeblendet werden soll, wenn keine Anzeige in der Anzeigenfläche vorhanden ist.
setConfig
Legt allgemeine Konfigurationsoptionen für diesen Slot fest.
setForceSafeFrame
Mit dieser Richtlinie wird festgelegt, ob das Rendering von Anzeigen auf dieser Anzeigenfläche mit einem SafeFrame-Container erzwungen werden soll.
setSafeFrameConfig
Legt die Einstellungen auf Anzeigenflächenebene für die SafeFrame-Konfiguration fest.
setTargeting
Legt einen benutzerdefinierten Targeting-Parameter für diese Anzeigenfläche fest.
updateTargetingFromMap
Legt benutzerdefinierte Targeting-Parameter für diese Anzeigenfläche aus einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt fest.

addService

  • addService(service: Service): Slot

  • Fügt diesem Slot ein Service hinzu.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    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: Service
    Der Dienst, der hinzugefügt werden soll.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

clearCategoryExclusions

  • clearCategoryExclusions(): Slot

  • Löscht alle Ausschlusslabels für Anzeigenkategorien auf Anzeigenflächenebene 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 (alte Version)

    // 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.
  • Rückgabe
    Slot
    Das 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 (alte Version)

    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
    key?: string
    Parameterschlüssel für die Ausrichtung. Der Schlüssel ist optional. Wenn Sie ihn nicht angeben, werden alle Targeting-Parameter gelöscht.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

defineSizeMapping

  • defineSizeMapping(sizeMapping: SizeMappingArray): Slot

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

  • Beispiel

    JavaScript

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

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

slot.defineSizeMapping(mapping);

    JavaScript (alte Version)

    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: SizeMappingArray
    Array von Größenzuordnungen. Sie können sie mit SizeMappingBuilder erstellen. Jede Größenzuordnung besteht aus einem Array aus zwei Elementen: SingleSizeArray und GeneralSize.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

get

  • get(key: string): null | string

  • Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diese Anzeigenfläche verknüpft ist. Um die von dieser Anzeigenfläche übernommenen Attribute auf Dienstebene zu sehen, verwenden Sie PubAdsService.get.

  • 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 (alte Version)

    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: string
    Name des zu suchenden Attributs.
  • Rückgabe
    null | string
    Aktueller Wert für den Attributschlüssel oder null, wenn der Schlüssel nicht vorhanden ist.

getAdUnitPath

  • getAdUnitPath(): string

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

  • Beispiel

    JavaScript

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

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

    JavaScript (alte Version)

    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'.
  • Rückgabe
    string
    Pfad des Anzeigenblocks.

getAttributeKeys

  • getAttributeKeys(): string[]

  • Gibt die Liste der für diese Anzeigenfläche festgelegten Attributschlüssel zurück Um die Schlüssel der von dieser Anzeigenfläche übernommenen Attribute auf Dienstebene zu sehen, 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 (alte Version)

    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'].
  • Rückgabe
    string[]
    Array von Attributschlüsseln Reihenfolge ist nicht definiert.

getCategoryExclusions

  • getCategoryExclusions(): string[]

  • Gibt die Ausschlusslabels der Anzeigenkategorie 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 (alte Version)

    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'].
  • Rückgabe
    string[]
    Die Ausschlusslabels der Anzeigenkategorie für diese Anzeigenfläche oder ein leeres Array, wenn keine festgelegt wurden.

getResponseInformation

  • getResponseInformation(): null | ResponseInformation

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

  • Rückgabe
    null | ResponseInformation
    Die neuesten Informationen zur Anzeigenantwort oder null, wenn die Anzeigenfläche keine Anzeige enthält.

getSlotElementId

  • getSlotElementId(): string

  • Gibt die ID der Anzeigenfläche div zurück, die beim Definieren der Anzeigenfläche angegeben wurde.

  • Beispiel

    JavaScript

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

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

    JavaScript (alte Version)

    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'.
  • Rückgabe
    string
    ID der Anzeigenfläche div.

getTargeting

  • getTargeting(key: string): string[]

  • Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diese Anzeigenfläche festgelegt ist. Targeting-Parameter 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 (alte Version)

    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: string
    Der Targeting-Schlüssel, nach dem gesucht werden soll.
  • Rückgabe
    string[]
    Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, falls kein solcher Schlüssel vorhanden ist.

getTargetingKeys

  • getTargetingKeys(): string[]

  • Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diese Anzeigenfläche festgelegt sind. Targeting-Schlüssel 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 (alte Version)

    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'].
  • Rückgabe
    string[]
    Array von Targeting-Schlüsseln Reihenfolge ist nicht definiert.

set

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

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

    Wenn diese Methode mehrmals für denselben Schlüssel aufgerufen wird, werden die zuvor festgelegten 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 (alte Version)

    // 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: string
    Der Name des Attributs.
    value: string
    Attributwert.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): Slot

  • Legt ein Ausschlusslabel für die Anzeigenkategorie auf Anzeigenflächenebene für diese Anzeigenfläche fest.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    // 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: string
    Das hinzuzufügende Ausschlusslabel für die Anzeigenkategorie.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

setClickUrl

  • setClickUrl(value: string): Slot

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

    Die Google Ad Manager-Server erfassen auch dann einen Klick, wenn die Klick-URL ersetzt wird. Jede Landingpage-URL, die mit dem ausgelieferten Creative verknüpft ist, wird an den angegebenen Wert angehängt. Nachfolgende Aufrufe überschreiben den Wert. Dies funktioniert nur bei Anfragen, die sich nicht auf die Einzelanfrage-Architektur beziehen.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    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: string
    Die festzulegende Klick-URL.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

setCollapseEmptyDiv

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

  • Legt fest, ob die Anzeigenfläche div ausgeblendet werden soll, wenn keine Anzeige in der Anzeigenfläche 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 (alte Version)

    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: boolean
    Gibt an, ob die Anzeigenfläche minimiert werden soll, wenn keine Anzeige zurückgegeben wird.
    collapseBeforeAdFetch?: boolean
    Gibt an, ob die Anzeigenfläche minimiert werden soll, noch bevor eine Anzeige abgerufen wird. Wird ignoriert, wenn für die Minimierung nicht true festgelegt ist.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

setConfig

  • setConfig(slotConfig: SlotSettingsConfig): void

  • Legt allgemeine Konfigurationsoptionen für diesen Slot fest.

  • Parameter
    slotConfig: SlotSettingsConfig
    Das Konfigurationsobjekt.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): Slot

  • Mit der Richtlinie wird konfiguriert, ob das Rendering von Anzeigen auf dieser Anzeigenfläche mit einem SafeFrame-Container erzwungen werden soll.

    Beachten Sie bei der Verwendung dieser API Folgendes:

    • Diese Einstellung gilt nur für nachfolgende Anzeigenanfragen für die jeweiligen Anzeigenflächen.
    • Die Einstellung auf Anzeigenflächenebene überschreibt immer die Einstellung auf Seitenebene.
    • Wenn der Wert auf true (auf Anzeigenflächen- oder Seitenebene) festgelegt ist, wird die Anzeige unabhängig von der Auswahl auf der Google Ad Manager-Benutzeroberfläche immer mit einem SafeFrame-Container gerendert.
    • Wenn false festgelegt oder nicht angegeben ist, wird die Anzeige abhängig vom Creative-Typ und der Auswahl auf der Google Ad Manager-Benutzeroberfläche mit einem SafeFrame-Container gerendert.
    • Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken könnte, die versuchen, ihre iFrames zu überwinden oder sich darauf zu verlassen, dass sie direkt auf einer Publisher-Seite gerendert werden.

  • Beispiel

    JavaScript

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

    JavaScript (alte Version)

    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: boolean
    Mit true wird erzwungen, dass alle Anzeigen auf dieser Anzeigenfläche in SafeFrames gerendert werden, und false, um eine Einstellung auf Seitenebene (falls vorhanden) zu deaktivieren. Wird dieser Wert auf false gesetzt, wenn er nicht auf Seitenebene festgelegt ist, ändert sich nichts.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot

  • Legt die Einstellungen auf Anzeigenflächenebene für die SafeFrame-Konfiguration fest. Alle nicht erkannten 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 Anzeigenflächenebene überschreiben 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 (alte Version)

    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: null | SafeFrameConfig
    Das Konfigurationsobjekt.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

setTargeting

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

  • Legt einen benutzerdefinierten Targeting-Parameter für diese Anzeigenfläche fest. Durch mehrfaches Aufrufen dieser Methode für denselben Schlüssel werden alte Werte überschrieben. Die hier festgelegten Werte überschreiben die auf Dienstebene festgelegten Targeting-Parameter. 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 (alte Version)

    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: string
    Parameterschlüssel für die Ausrichtung.
    value: string | string[]
    Wert des Targeting-Parameters oder Array von Werten.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

updateTargetingFromMap

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

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

    Hinweise:

    • Beim Überschreiben wird nur der letzte Wert beibehalten.
    • Handelt es sich bei dem Wert um ein Array, werden alle vorherigen Werte überschrieben und nicht zusammengeführt.
    • Die hier festgelegten Werte überschreiben die auf Dienstebene festgelegten Targeting-Parameter.

  • Beispiel

    JavaScript

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

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

    JavaScript (alte Version)

    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-Zuordnung des Targeting-Parameters.
  • Rückgabe
    Slot
    Das Slot-Objekt, für das die Methode aufgerufen wurde.

googletag.config.AdExpansionConfig

Einstellungen zur Steuerung der Anzeigenexpansion.

Property-Übersicht
enabled
Gibt an, ob die Anzeigenexpansion aktiviert oder deaktiviert ist.
Beispiel

JavaScript

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

JavaScript (alte Version)

// 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 },
});

enabled

googletag.config.ComponentAuctionConfig

Ein Objekt, das eine Einzelkomponentenauktion in einer On-Device-Anzeigenauktion darstellt.

Property-Übersicht
auctionConfig
Ein Auktionskonfigurationsobjekt für diese Komponentenauktion.
configKey
Der Konfigurationsschlüssel, der dieser Komponentenauktion zugeordnet ist.
Weitere Informationen

auctionConfig

  • auctionConfig: null | { 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 gesetzt wird, werden alle vorhandenen Konfigurationen 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 (alte Version)

    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 dieser Komponentenauktion zugeordnet ist.

    Dieser Wert darf nicht leer und eindeutig sein. Wenn zwei ComponentAuctionConfig-Objekte denselben configKey-Wert haben, überschreibt das zuletzt festzulegende Objekt vorherige Konfigurationen.

googletag.config.InterstitialConfig

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

Property-Übersicht
triggers
Die Interstitial-Triggerkonfiguration für diese Interstitial-Anzeige.

triggers

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

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

    Wenn Sie den Wert eines Interstitial-Triggers auf true festlegen, wird er aktiviert und mit false 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 (alte Version)

    // 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.PageSettingsConfig

Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.

Hiermit können mit einem einzigen API-Aufruf mehrere Funktionen festgelegt werden.

Alle unten aufgeführten Attribute sind Beispiele. Sie stellen keine tatsächlichen Funktionen dar, für die „setConfig“ verwendet wird. Die einzelnen Funktionen finden Sie unten in den Feldern des Typs „PageSettingsConfig“.

Beispiele:

  • Es werden nur die im setConfig-Aufruf angegebenen Elemente geändert. 
      // Configure feature alpha.
  googletag.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });
  • Alle Einstellungen für eine bestimmte Funktion werden bei jedem Aufruf von 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
      }
  });
  • Sie können alle Einstellungen für ein Element löschen, indem Sie null übergeben. 
      // 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,
  });

Property-Übersicht
adExpansion
Einstellungen zur Steuerung der Anzeigenexpansion.
pps
Einstellungen zum Verwalten von vom Publisher bereitgestellten Signalen (Publisher Provided Signals, PPS).
privacyTreatments
Einstellungen zum Festlegen von Datenschutzeinstellungen für Publisher.

adExpansion

  • adExpansion: null | AdExpansionConfig

  • Einstellungen zur Steuerung der Anzeigenexpansion.

pps

  • Einstellungen zum Verwalten von vom Publisher bereitgestellten Signalen (Publisher Provided Signals, PPS).

privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig

  • Einstellungen zum Festlegen von Datenschutzeinstellungen für Publisher.

googletag.config.PrivacyTreatmentsConfig

Einstellungen zum Festlegen von Datenschutzeinstellungen für Publisher.

Property-Übersicht
treatments
Mehrere zu aktivierende Datenschutzmaßnahmen für Publisher

treatments

  • treatments: "disablePersonalization"[]

  • Mehrere zu aktivierende Datenschutzmaßnahmen für Publisher

  • Beispiel

    JavaScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    JavaScript (alte Version)

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    TypeScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

googletag.config.PublisherProvidedSignalsConfig

Konfigurationsobjekt für vom Publisher bereitgestellte Signale (PPS).

Property-Übersicht
taxonomies
Ein Objekt mit Taxonomie-Zuordnungen.
Beispiel

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript (alte Version)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '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 | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
Weitere Informationen

taxonomies

googletag.config.SlotSettingsConfig

Hauptkonfigurationsoberfläche für Einstellungen auf Anzeigenflächenebene.

Hiermit können Sie mit einem einzigen API-Aufruf für einen einzelnen Slot mehrere Funktionen festlegen.

Alle unten aufgeführten Attribute sind Beispiele. Sie stellen keine tatsächlichen Funktionen dar, für die setConfig verwendet wird. Die einzelnen Funktionen finden Sie unten in den Feldern des Typs „SlotSettingsConfig“.

Beispiele:

  • Es werden nur die im Slot.setConfig-Aufruf angegebenen Elemente geändert. 
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);

  // Configure feature alpha.
  slot.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });
  • Alle Einstellungen für eine bestimmte Funktion 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
      }
  });
  • Sie können alle Einstellungen für ein Element löschen, indem Sie null übergeben. 
      // 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,
  });

Property-Übersicht
adExpansion
Einstellungen zur Steuerung der Anzeigenexpansion.
componentAuction
Mehrere Komponentenauktionen, die in eine On-Device-Anzeigenauktion einbezogen werden
interstitial
Einstellungen, mit denen das Verhalten von Interstitial-Anzeigenflächen gesteuert wird.

adExpansion

componentAuction

  • componentAuction: ComponentAuctionConfig[]

  • Mehrere Komponentenauktionen, die in eine On-Device-Anzeigenauktion einbezogen werden

interstitial

  • interstitial: InterstitialConfig

  • Einstellungen, mit denen das Verhalten von Interstitial-Anzeigenflächen gesteuert wird.

googletag.config.TaxonomyData

Ein Objekt, das die Werte für eine einzelne Taxonomie enthält.

Property-Übersicht
values
Eine Liste von Taxonomiewerten.

values

googletag.events.Event

Basisoberfläche für alle GPT-Ereignisse Alle nachfolgenden GPT-Ereignisse haben die folgenden Felder.

Property-Übersicht
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
Weitere Informationen

serviceName

  • serviceName: string

  • Name des Dienstes, der das Ereignis ausgelöst hat.

slot

  • slot: Slot

  • Der Slot, der das Ereignis ausgelöst hat.

googletag.events.EventTypeMap

Dies ist ein Pseudotyp, der einen Ereignisnamen dem entsprechenden Ereignisobjekttyp für Service.addEventListener und Service.removeEventListener zuordnet. Sie ist nur zu Referenz- und Typsicherheitszwecken dokumentiert.

Property-Übersicht
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

googletag.events.ImpressionViewableEvent

Verlängert Event

Dieses Ereignis wird ausgelöst, wenn eine Impression gemäß den Active View-Kriterien sichtbar wird.

Property-Übersicht
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 (alte Version)

// 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

Verlängert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeigenfläche mit Prämie vom Nutzer geschlossen wird. Sie kann entweder vor oder nach der Gewährung einer Prämie ausgelöst werden. Wenn du feststellen möchtest, ob eine Prämie gewährt wurde, verwende stattdessen events.RewardedSlotGrantedEvent.

Property-Übersicht
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 user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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 (alte Version)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

Verlängert 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.

Property-Übersicht
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

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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 (alte Version)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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

payload

  • payload: null | RewardedPayload

  • Ein Objekt mit Informationen zur gewährten Prämie.

googletag.events.RewardedSlotReadyEvent

Verlängert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeige mit Prämie bereit zur Auslieferung ist. Der Publisher ist dafür verantwortlich, dass der Nutzer die Anzeige vor der Auslieferung sieht.

Property-Übersicht
serviceName
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
Der Slot, der das Ereignis ausgelöst hat.
Methodenzusammenfassung
makeRewardedVisible
Die Anzeige mit Prämie wird angezeigt.
Beispiel

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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 (alte Version)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
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.defineSlot("/1234567/example", [160, 600]);
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

makeRewardedVisible

  • makeRewardedVisible(): void

  • Die Anzeige mit Prämie wird angezeigt. Diese Methode sollte erst aufgerufen werden, wenn der Nutzer dem Ansehen der Anzeige zugestimmt hat.

googletag.events.SlotOnloadEvent

Verlängert Event

Dieses Ereignis tritt ein, wenn der iFrame des Creatives das zugehörige Ladeereignis auslöst. Beim Rendern von Rich Media-Anzeigen im synchronen Renderingmodus wird kein iFrame verwendet, sodass kein SlotOnloadEvent ausgelöst wird.

Property-Übersicht
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 (alte Version)

// 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

Verlängert Event

Dieses Ereignis wird ausgelöst, wenn der Creative-Code in eine Anzeigenfläche injiziert wird. Dieses Ereignis tritt ein, bevor die Ressourcen des Creatives abgerufen werden, sodass das Creative möglicherweise noch nicht sichtbar ist. Wenn Sie wissen möchten, wann alle Creative-Ressourcen für eine Anzeigenfläche geladen sind, verwenden Sie stattdessen die events.SlotOnloadEvent.

Property-Übersicht
advertiserId
Die Werbetreibenden-ID der gerenderten Anzeige.
campaignId
Die Kampagnen-ID der gerenderten Anzeige.
companyIds
IDs der Unternehmen, die auf die gerenderte Backfill-Anzeige bieten.
creativeId
Creative-ID der gerenderten Reservierungsanzeige.
creativeTemplateId
Die Creative-Vorlagen-ID der gerenderten Reservierungsanzeige.
isBackfill
Angabe, ob eine Anzeige eine Backfill-Anzeige war
isEmpty
Gibt an, ob eine Anzeige für die Anzeigenfläche zurückgegeben wurde.
labelIds
Label-IDs der gerenderten Anzeige.
lineItemId
Die Werbebuchungs-ID der gerenderten Reservierungsanzeige.
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 Inhalt der Anzeigenfläche mit der gerenderten Anzeige geändert wurde.
sourceAgnosticCreativeId
Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige.
sourceAgnosticLineItemId
Die 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("Label IDs:", event.labelIds);
  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 (alte Version)

// 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("Label IDs:", event.labelIds);
  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("Label IDs:", event.labelIds);
  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

advertiserId

  • advertiserId: null | number

  • Die Werbetreibenden-ID der gerenderten Anzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

campaignId

  • campaignId: null | number

  • Die Kampagnen-ID der gerenderten Anzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

companyIds

  • companyIds: null | number[]

  • IDs der Unternehmen, die auf die gerenderte Backfill-Anzeige bieten. Für leere Anzeigenflächen, Reservierungsanzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

creativeId

  • creativeId: null | number

  • Creative-ID der gerenderten Reservierungsanzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

creativeTemplateId

  • creativeTemplateId: null | number

  • Die Creative-Vorlagen-ID der gerenderten Reservierungsanzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

isBackfill

  • isBackfill: boolean

  • Angabe, 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 eine Anzeige für die Anzeigenfläche zurückgegeben wurde. Der Wert ist true, wenn keine Anzeige zurückgegeben wurde, andernfalls false.

labelIds

  • labelIds: null | number[]

  • Label-IDs der gerenderten Anzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

lineItemId

  • lineItemId: null | number

  • Die Werbebuchungs-ID der gerenderten Reservierungsanzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

size

  • size: null | string | number[]

  • Gibt die Pixelgröße des gerenderten Creatives an. Beispiel: [728, 90]. Bei leeren Anzeigenflächen beträgt der Wert null.

slotContentChanged

  • slotContentChanged: boolean

  • Gibt an, ob der Inhalt der Anzeigenfläche mit der gerenderten Anzeige geändert wurde. Der Wert ist true, wenn der Inhalt geändert wurde, andernfalls false.

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

  • Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige. Der Wert ist null, wenn die Anzeige kein Reservierungs- oder Werbebuchungs-Backfill ist oder das Creative von anderen Diensten als PubAdsService gerendert wird.

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

  • Die Werbebuchungs-ID der gerenderten Reservierungs- oder Backfill-Anzeige. Der Wert ist null, wenn die Anzeige kein Reservierungs- oder Werbebuchungs-Backfill ist oder das Creative von anderen Diensten als PubAdsService gerendert wird.

yieldGroupIds

  • yieldGroupIds: null | number[]

  • IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige. Für leere Anzeigenflächen, Reservierungsanzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert wurden, lautet der Wert null.

googletag.events.SlotRequestedEvent

Verlängert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeige für eine bestimmte Anzeigenfläche angefordert wurde.

Property-Übersicht
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 (alte Version)

// 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

Verlängert Event

Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für eine bestimmte Anzeigenfläche empfangen wird.

Property-Übersicht
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 (alte Version)

// 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

Verlängert Event

Dieses Ereignis wird immer dann ausgelöst, wenn sich der Bildschirmprozentsatz einer Anzeigenfläche ändert. Das Ereignis wird gedrosselt und nicht häufiger als einmal alle 200 ms ausgelöst.

Property-Übersicht
inViewPercentage
Prozentsatz des sichtbaren Anzeigenbereichs.
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 (alte Version)

// 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

inViewPercentage

  • inViewPercentage: number

  • Prozentsatz des sichtbaren Anzeigenbereichs. Wert ist eine Zahl zwischen 0 und 100.

googletag.secureSignals.BidderSignalProvider

Gibt ein sicheres Signal für einen bestimmten Bieter zurück.

Ein Anbieter sicherer Signale besteht aus zwei Teilen:

  1. Eine Collector-Funktion, die eine Promise zurückgibt, die in ein sicheres Signal aufgelöst wird.
  2. Ein id, der 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.

Property-Übersicht
collectorFunction
.
id
Eine eindeutige Kennung für den Collector, der diesem sicheren Signal zugeordnet ist und in Google Ad Manager registriert wurde.
Beispiel

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (alte Version)

// 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

collectorFunction

  • collectorFunction: () => Promise<string>

id

  • id: string

  • Eine eindeutige Kennung für den Collector, der diesem sicheren Signal zugeordnet ist und in Google Ad Manager registriert wurde.

googletag.secureSignals.PublisherSignalProvider

Gibt ein sicheres Signal für einen bestimmten Publisher zurück.

Ein Anbieter von Publisher-Signalen besteht aus zwei Teilen:

  1. Eine Collector-Funktion, die eine Promise zurückgibt, die in ein sicheres Signal aufgelöst wird.
  2. Ein networkCode, der 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.

Property-Übersicht
collectorFunction
.
networkCode
Der Netzwerkcode (wie im Anzeigenblockpfad zu sehen) für den Publisher, der diesem sicheren Signal zugeordnet ist.
Beispiel

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (alte Version)

// 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

collectorFunction

  • collectorFunction: () => Promise<string>

networkCode

  • networkCode: string

  • Der Netzwerkcode (wie im Anzeigenblockpfad zu sehen) für den Publisher, der diesem sicheren Signal zugeordnet ist.

googletag.secureSignals.SecureSignalProvidersArray

Eine Schnittstelle zum Verwalten sicherer Signale.

Methodenzusammenfassung
clearAllCache
Löscht alle Signale für alle Collectors aus dem Cache, wodurch die Wahrscheinlichkeit verringert wird, dass Signale für diese und möglicherweise spätere Seitenaufrufe in Anzeigenanfragen aufgenommen werden.
push
Fügt dem Array des Signalanbieters ein neues secureSignals.SecureSignalProvider hinzu und beginnt mit der Signalgenerierung.

clearAllCache

  • clearAllCache(): void

  • Löscht alle Signale für alle Collectors aus dem Cache, wodurch die Wahrscheinlichkeit verringert wird, dass Signale für diese und möglicherweise spätere Seitenaufrufe in Anzeigenanfragen aufgenommen werden. Sollte nur bei aussagekräftigen Statusänderungen verwendet werden, z. B. bei Ereignissen, die auf einen neuen Nutzer hinweisen (z. B. An-, Abmelden, Anmelden).

push