In dieser Referenz wird die TypeScript-Notation zum Beschreiben von Typen verwendet. In der folgenden Tabelle wird dies anhand eines Beispiels erläutert.
Ausdruck eingeben | |
---|---|
string |
Der primitive Stringtyp. |
string[] |
Ein Arraytyp, bei dem die Werte nur Strings sein dürfen. |
number | string |
Ein Union-Typ, bei dem der Wert entweder eine Zahl oder ein String sein kann. |
Array<number | string> |
Ein Arraytyp, bei dem die Werte einen komplexen (Union-)Typ haben. |
[number, string] |
Ein Tupeltyp, bei dem der Wert ein Array mit zwei Elementen ist, das in dieser Reihenfolge eine Zahl und einen String enthalten muss. |
Slot |
Ein Objekttyp, bei dem der Wert eine Instanz von googletag.Slot ist. |
() => void |
Ein Funktionstyp ohne definierte Argumente und ohne Rückgabewert. |
Weitere Informationen zu unterstützten Typen und Typausdrücken finden Sie im TypeScript-Handbuch .
Typanmerkungen
Ein Doppelpunkt nach einer Variablen, einem Parameternamen, einem Eigenschaftsnamen 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 Typanmerkungen, die Sie in diesem Leitfaden sehen können.
Typannotation | |
---|---|
param: string |
Gibt an, dass param einen Stringwert annimmt oder zurückgibt. Diese Syntax wird für Variablen, Parameter, Properties und Rückgabetypen verwendet.
|
param?: number | string |
Gibt an, dass param optional ist, aber bei Angabe entweder eine Zahl oder einen String akzeptiert. Diese Syntax wird für Parameter und Properties verwendet.
|
...params: Array<() => void> |
Gibt an, dass params ein
REST-Parameter
ist, der Funktionen akzeptiert. Restparameter können eine unbegrenzte Anzahl von Werten des angegebenen Typs annehmen.
|
googletag
Namespaces | |
---|---|
config | Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene. |
enums | Dies ist der Namespace, den GPT für enum-Typen verwendet. |
events | Dies ist der Namespace, den GPT für Ereignisse verwendet. |
secure | Dies ist der Namespace, den GPT für die Verwaltung sicherer Signale verwendet. |
Interfaces | |
---|---|
Command | Das Befehlsarray akzeptiert eine Reihe von Funktionen und ruft sie der Reihe nach auf. |
Companion | Companion-Anzeigendienst |
Privacy | Konfigurationsobjekt für Datenschutzeinstellungen. |
Pub | Publisher-Anzeigendienst |
Response | Ein Objekt, das eine einzelne Anzeigenantwort darstellt. |
Rewarded | Ein Objekt, das die Prämie darstellt, die mit einer Anzeigen mit Prämie verknüpft ist. |
Safe | Konfigurationsobjekt für SafeFrame-Container. |
Service | Basisdienstklasse, die Methoden enthält, die für alle Dienste gelten. |
Size | Builder für Objekte der Größenzuordnungsspezifikation. |
Slot | Eine Anzeigenfläche ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt. |
Typaliasse | |
---|---|
General | Eine gültige Größenkonfiguration für einen Slot, die eine oder mehrere Größen umfassen kann. |
Multi | Eine Liste einzelner gültiger Größen. |
Named | Benannte Größen, die ein Slot haben kann. |
Single | Eine einzelne gültige Größe für einen Slot. |
Single | Array aus zwei Zahlen, die für [Breite, Höhe] stehen. |
Size | Eine Zuordnung der Darstellungsgröße zu Anzeigengrößen. |
Size | Eine Liste der Größenzuordnungen. |
Variablen | |
---|---|
api | Flag, das angibt, dass die GPT API geladen und bereit zum Aufrufen ist. |
cmd | Referenz zur globalen Befehlswarteschlange für die asynchrone Ausführung GPT-bezogener Aufrufe |
pubads | Flag, das angibt, dass PubAdsService aktiviert, geladen und voll funktionsfähig ist. |
secure | Verweis auf das Array der Anbieter sicherer Signale. |
Funktionen | |
---|---|
companion | Gibt einen Verweis auf den CompanionAdsService zurück. |
define | Eine Out-of-Page-Anzeigenfläche wird erzeugt, die den Pfad des Anzeigenblocks erhält. |
define | 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. |
destroy | Die angegebenen Slots werden gelöscht und alle zugehörigen Objekte und Verweise auf diese Slots werden aus GPT entfernt. |
disable | Deaktiviert die Google Publisher Console. |
display | Weist Slot-Dienste an, den Slot zu rendern. |
enable | Hiermit werden alle GPT-Dienste aktiviert, die für Anzeigenflächen auf der Seite definiert wurden. |
get | Gibt die aktuelle Version von GPT zurück. |
open | Die Google Publisher Console wird geöffnet. |
pubads | Gibt einen Verweis auf den PubAdsService zurück. |
set | Legt den Titel für alle von PubAdsService erstellten Anzeigencontainer-iFrames fest. |
set | Legt allgemeine Konfigurationsoptionen für die Seite fest. |
size | Erstellt einen neuen SizeMappingBuilder. |
Typaliasse
GeneralSize
GeneralSize: SingleSize | MultiSize
Eine gültige Größenkonfiguration für einen Slot, die eine oder mehrere Größen umfassen kann.
MultiSize
MultiSize: SingleSize[]
Eine Liste einzelner gültiger Größen.
NamedSize
- 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 (siehe weiterführender Artikel). Sowohl
fluid
als auch['fluid']
sind zulässige Formen, um eine Slotgröße als variabel zu deklarieren.
NamedSize: "fluid" | ["fluid"]
Benannte Größen, die ein Slot haben kann. In den meisten Fällen ist die Größe ein Rechteck mit fester Größe. In einigen Fällen sind jedoch andere Größenangaben erforderlich. Nur die folgenden benannten Größen sind zulässig:
SingleSize
SingleSize: SingleSizeArray | NamedSize
Eine einzelne gültige Größe für einen Slot.
SingleSizeArray
SingleSizeArray: [number, number]
Array aus zwei Zahlen, die für [Breite, Höhe] stehen.
SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]
Eine Zuordnung der Darstellungsgröße zu Anzeigengrößen. Wird für responsive Anzeigen verwendet.
SizeMappingArray
SizeMappingArray: SizeMapping[]
Eine Liste der Größenzuordnungen.
Variablen
Const
apiReady
apiReady: boolean | undefined
Flag, das angibt, dass die GPT API geladen und bereit zum Aufrufen ist. 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. Bei diesen Rückrufen muss nicht geprüft werden, ob googletag.apiReady wahr ist, da sie garantiert ausgeführt werden, sobald die API eingerichtet ist.
Const
cmd
- Beispiel
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (alt)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
cmd: ((this: typeof globalThis) => void)[] | CommandArray
Verweis auf die globale Befehlswarteschlange für die asynchrone Ausführung von GPT-bezogenen Aufrufen.
Die Variable googletag.cmd
wird durch die GPT-Tag-Syntax auf der Seite als leeres JavaScript-Array initialisiert. cmd.push
ist die Standardmethode Array.push
, mit der dem Ende des Arrays ein Element hinzugefügt wird. Wenn das GPT-JavaScript geladen wird, wird das Array durchsucht und alle Funktionen werden der Reihe nach ausgeführt. Im Script wird cmd
dann durch ein CommandArray-Objekt ersetzt, dessen Push-Methode so definiert ist, dass das übergebene Funktionsargument ausgeführt wird. Mit diesem Mechanismus kann GPT die wahrgenommene Latenz reduzieren, indem das JavaScript asynchron abgerufen wird, während der Browser die Seite weiter rendert.
Const
pubadsReady
pubadsReady: boolean | undefined
Flag, das angibt, dass PubAdsService aktiviert, geladen und voll funktionsfähig ist. Diese Property hat den Wert „undefined
“, bis enableServices aufgerufen und PubAdsService geladen und initialisiert wurde.
secureSignalProviders
- Beispiel
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (alt)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- Weitere Informationen
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 Signalgenerierungsfunktionen in die Warteschlange gestellt werden, die nach dem Laden des GPT aufgerufen werden.
Funktionen
companionAds
companionAds(): CompanionAdsService
Gibt einen Verweis auf den CompanionAdsService zurück.
Gibt Folgendes zurück: | |
---|---|
CompanionAdsService | Der Companion-Anzeigendienst |
defineOutOfPageSlot
- Beispiel
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (alt)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Weitere Informationen
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
Eine Out-of-Page-Anzeigenfläche wird mit dem angegebenen Pfad zum Anzeigenblock erstellt.
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 vom GPT verwaltete Out-of-Page-Anzeigen ist div
ein unterstütztes OutOfPageFormat.
Parameter | |
---|---|
adUnitPath: string | Vollständiger Anzeigenblockpfad mit Netzwerkcode und Anzeigenblockcode |
| ID des div-Elements, das diesen Anzeigenblock oder OutOfPageFormat enthält. |
Gibt Folgendes zurück: | |
---|---|
Slot | null | Der neu erstellte Slot oder null , wenn kein Slot erstellt werden kann. |
defineSlot
- Beispiel
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (alt)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Weitere Informationen
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
Hiermit wird eine Anzeigenfläche mit einem bestimmten Anzeigenblockpfad und einer bestimmten Größe erstellt und mit der ID eines Div-Elements auf der Seite verknüpft, das die Anzeige enthalten soll.
Parameter | |
---|---|
adUnitPath: string | Vollständiger Pfad des Anzeigenblocks mit Netzwerkcode und Blockcode |
size: GeneralSize | Breite und Höhe des hinzugefügten Slots. Diese Größe wird in der Anzeigenanfrage verwendet, wenn keine Zuordnung für die responsive Größe angegeben ist oder die Größe des Darstellungsbereichs kleiner als die kleinste Größe in der Zuordnung ist. |
| ID des Div-Elements, das diesen Anzeigenblock enthält. |
Gibt Folgendes zurück: | |
---|---|
Slot | null | Die neu erstellte Anzeigenfläche oder null , wenn ein Slot nicht erstellt werden kann. |
destroySlots
- Beispiel
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (alt)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
destroySlots(slots?: Slot[]): boolean
Die angegebenen Slots werden gelöscht und alle zugehörigen Objekte und Verweise auf diese Slots werden aus GPT entfernt. Diese API unterstützt keine Passback- und Companion-Slots.
Wenn Sie diese API für einen Slot aufrufen, wird die Anzeige gelöscht und das Slot-Objekt wird aus dem von GPT verwalteten internen Status entfernt. Wenn Sie weitere Funktionen für das Steckplatzobjekt aufrufen, führt das zu undefiniertem Verhalten. Beachte, dass der Browser den mit diesem Slot verknüpften Arbeitsspeicher möglicherweise nicht freigibt, wenn über die Publisher-Seite ein Verweis darauf besteht. Wenn Sie diese API aufrufen, wird das mit dem Slot verknüpfte Div für die Wiederverwendung verfügbar gemacht.
Wenn Sie einen Slot löschen, wird die Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt. Daher werden zukünftige Anfragen nicht durch Blockierungen oder Wettbewerbsausschlüsse für diese Anzeige beeinflusst. Wenn diese Funktion nicht aufgerufen wird, bevor das div-Element eines Slots von der Seite entfernt wird, führt dies zu einem nicht definierten Verhalten.
Parameter | |
---|---|
| Das Array der Slots, die zerstört werden sollen. „Array“ ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht. |
Gibt Folgendes zurück: | |
---|---|
boolean | true , wenn Slots gelöscht wurden, false andernfalls. |
disablePublisherConsole
Display
- Weitere Informationen
display(divOrSlot: string | Element | Slot): void
Weist Slotdienste an, die Anzeigenfläche zu rendern. Jede Anzeigenfläche sollte nur einmal pro Seite ausgeliefert werden. Alle Slots 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. Normalerweise wird der Code in einem Scriptblock innerhalb des im Methodenaufruf genannten div-Elements platziert.
Wenn die Einzelanfrage-Architektur (Single Request Architecture, SRA) verwendet wird, werden alle Anzeigenflächen, die zum Zeitpunkt des Aufrufs dieser Methode noch nicht abgerufen wurden, gleichzeitig abgerufen. Wenn ein Anzeigen-Slot nicht angezeigt werden soll, muss das gesamte Div entfernt werden.
Parameter | |
---|---|
divOrSlot: string | Element | Slot | Entweder die ID des div-Elements, das den Anzeigen-Slot enthält, oder das div-Element oder das Slot-Objekt. Wenn ein Div-Element angegeben wird, muss es das Attribut „id“ haben, das mit der ID übereinstimmt, die an defineSlot übergeben wird. |
enableServices
getVersion
openConsole
- Beispiel
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (alt)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- Weitere Informationen
openConsole(div?: string): void
Die Google Publisher Console wird geöffnet.
Parameter | |
---|---|
| Die div-ID der Anzeigenfläche. Dieser Wert ist optional. Wenn Sie einen Anzeigenblock angeben, wird versucht, die Publisher Console mit den Details des angegebenen Anzeigenblocks zu öffnen. |
pubads
pubads(): PubAdsService
Gibt einen Verweis auf den PubAdsService zurück.
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Der Publisher-Anzeigendienst |
setAdIframeTitle
- Beispiel
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (alt)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
setAdIframeTitle(title: string): void
Hiermit wird der Titel für alle von PubAdsService erstellten Iframes von Anzeigencontainern festgelegt.
Parameter | |
---|---|
title: string | Der neue Titel für alle Iframes von Anzeigencontainern. |
setConfig
setConfig(config: PageSettingsConfig): void
Legt allgemeine Konfigurationsoptionen für die Seite fest.
Parameter | |
---|---|
config: PageSettingsConfig |
sizeMapping
- Weitere Informationen
sizeMapping(): SizeMappingBuilder
Erstellt einen neuen SizeMappingBuilder.
Gibt Folgendes zurück: | |
---|---|
SizeMappingBuilder | Ein neuer Builder. |
googletag.CommandArray
Methoden | |
---|---|
push | Führt die in den Argumenten angegebene Funktionssequenz in der angegebenen Reihenfolge aus. |
Methoden
push
- Beispiel
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (alt)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
push(...f: ((this: typeof globalThis) => void)[]): number
Führt die in den Argumenten angegebene Funktionssequenz in der angegebenen Reihenfolge aus.
Parameter | |
---|---|
| Eine JavaScript-Funktion, die ausgeführt werden soll. Die Laufzeitbindung ist immer globalThis . Sie können eine Pfeilfunktion übergeben, um den this -Wert des umschließenden lexikalischen Kontexts beizubehalten. |
Gibt Folgendes zurück: | |
---|---|
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
ErweitertMethoden | |
---|---|
add | Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt. Von |
get | Rufen Sie die Liste der Slots ab, die mit diesem Dienst verknüpft sind. Übernommen von |
remove | Entfernt einen zuvor registrierten Listener. Übernommen von |
set | Legt fest, ob nicht ausgefüllte Companion-Slots automatisch aufgefüllt werden. |
- Weitere Informationen
Methoden
setRefreshUnfilledSlots
- Beispiel
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (alt)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
setRefreshUnfilledSlots(value: boolean): void
Legt fest, 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 beim PubAdsService registriert sind, werden aufgefüllt. Aufgrund von Richtlinieneinschränkungen ist diese Methode nicht dafür vorgesehen, leere Companion-Slots zu füllen, wenn ein Ad Exchange-Video ausgeliefert wird.
Parameter | |
---|---|
value: boolean | true , um nicht besetzte Slots automatisch zu belegen, oder false , um sie unverändert zu lassen. |
googletag.PrivacySettingsConfig
Attribute | |
---|---|
child | Gibt an, ob die Seite als an Kinder gerichtet behandelt werden soll. |
limited | Ermöglicht die Auslieferung im Modus Eingeschränkte Anzeigenausrichtung, um die Einhaltung der gesetzlichen Auflagen für Publisher zu unterstützen. |
non | Ermöglicht die Auslieferung im Modus Nicht personalisierte Anzeigen, um die Einhaltung der rechtlichen Anforderungen von Publishern zu unterstützen. |
restrict | Ermöglicht die Anzeigenbereitstellung im Modus für die eingeschränkte Datenverarbeitung, um Publishern bei der Einhaltung regulatorischer Anforderungen zu helfen. |
traffic | Gibt an, ob Anfragen gekaufte oder organische Zugriffe betreffen. |
under | Mit dieser Spalte wird angegeben, ob Anzeigenanfragen als von Nutzern stammend nicht volljährig gekennzeichnet werden sollen. |
- Weitere Informationen
Attribute
Optional
childDirectedTreatment
childDirectedTreatment?: null | boolean
Gibt an, ob die Seite als an Kinder gerichtet behandelt werden soll. Legen Sie null
fest, um die Konfiguration zu löschen.
Optional
limitedAds
- Automatisch über ein Signal von einer Plattform zur Einwilligungsverwaltung für IAB TCF 2.0
- Manuell, indem Sie den Wert dieses Felds auf
true
festlegen. - Beispiel
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (alt)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- Weitere Informationen
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:
Hinweis: Die eingeschränkte Anzeigenausrichtung muss nicht manuell aktiviert werden, wenn eine CMP verwendet wird.
Optional
nonPersonalizedAds
nonPersonalizedAds?: boolean
Ermöglicht die Auslieferung im Modus Nicht personalisierte Anzeigen, um die Einhaltung der rechtlichen Anforderungen von Publishern zu unterstützen.
Optional
restrictDataProcessing
restrictDataProcessing?: boolean
Ermöglicht die Anzeigenbereitstellung im Modus für die eingeschränkte Datenverarbeitung, um Publishern bei der Einhaltung regulatorischer Anforderungen zu helfen.
Optional
trafficSource
- Beispiel
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (alt)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
trafficSource?: TrafficSource
Gibt an, ob Anfragen gekaufte oder organische Zugriffe betreffen. Anhand dieses Werts wird die Dimension Zugriffsquelle in Ad Manager-Berichten ausgefüllt. Wenn nichts festgelegt ist, wird für die Besucherquelle in Berichten standardmäßig „undefined
“ verwendet.
Optional
underAgeOfConsent
underAgeOfConsent?: null | boolean
Gibt an, ob Anzeigenanfragen als Anfragen von Nutzern gekennzeichnet werden sollen, die das erforderliche Mindestalter noch nicht erreicht haben. Legen Sie null
fest, um die Konfiguration zu löschen.
googletag.PubAdsService
ErweitertMethoden | |
---|---|
add | Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt. Übernommen von |
clear | Die Anzeigen werden aus den angegebenen Slots entfernt und durch leere Inhalte ersetzt. |
clear | Löscht alle Labels für den Ausschluss von Anzeigenkategorien auf Seitenebene. |
clear | Löscht die benutzerdefinierten Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel. |
collapse | Hiermit können Slot-Divs minimiert werden, damit sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigencontent zu sehen ist. |
disable | Deaktiviert Anzeigenanfragen beim Seitenaufbau, ermöglicht jedoch das Anfordern von Anzeigen über einen PubAdsService.refresh-Aufruf. |
display | Erstellt und zeigt eine Anzeigenfläche mit dem angegebenen Pfad und der angegebenen Größe des Anzeigenblocks an. |
enable | Aktiviert das Lazy-Loading in GPT gemäß der Definition im Konfigurationsobjekt. |
enable | Aktiviert den Einzelanfragemodus zum gleichzeitigen Abrufen mehrerer Anzeigen. |
enable | Signalisiert GPT, dass auf der Seite Videoanzeigen ausgeliefert werden. |
get | Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel verknüpft ist. |
get | Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden. |
get | Rufen Sie die Liste der Slots ab, die mit diesem Dienst verknüpft sind. Von |
get | Gibt einen bestimmten benutzerdefinierten Targeting-Parameter auf Dienstebene zurück, der festgelegt wurde. |
get | Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden. |
is | Gibt an, ob die ersten Anfragen für Anzeigen durch einen vorherigen Aufruf von PubAdsService.disableInitialLoad deaktiviert wurden. |
refresh | Ruft neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite ab und zeigt diese an. |
remove | Entfernt einen zuvor registrierten Listener. Übernommen von |
set | Hiermit werden Werte für AdSense-Attribute festgelegt, die für alle Anzeigenflächen im Publisher-Anzeigendienst gelten. |
set | Legt einen Ausschluss der Anzeigenkategorie auf Seitenebene für den angegebenen Labelnamen fest. |
set | Hiermit wird die horizontale Zentrierung von Anzeigen aktiviert oder deaktiviert. |
set | Hiermit wird konfiguriert, ob alle Anzeigen auf der Seite mit einem SafeFrame-Container gerendert werden sollen. |
set | Standortinformationen von Websites werden übergeben, damit Sie Werbebuchungen auf bestimmte Standorte ausrichten können. |
set | Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzelne API mithilfe eines Konfigurationsobjekts. |
set | Legt den Wert für die vom Publisher bereitgestellte ID fest. |
set | Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest. |
set | Legt benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel fest, die für alle Publisher-Anzeigen-Service-Anzeigenflächen gelten. |
set | Legt die Informationen zum Videocontent fest, die zusammen mit den Anzeigenanfragen für Targeting- und auszuschließende Inhalte gesendet werden sollen. |
update | Ändert den Korrelator, der mit den Anzeigenanfragen gesendet wird, wodurch ein neuer Seitenaufruf gestartet wird. |
Methoden
clear
- Beispiel
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (alt)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
clear(slots?: Slot[]): boolean
Die Anzeigen werden aus den angegebenen Slots entfernt und durch leere Inhalte ersetzt. Die Slots werden als nicht abgerufen gekennzeichnet.
Wenn Sie einen Slot löschen, wird die Anzeige insbesondere aus dem langlebigen Seitenaufruf des GPT entfernt. So werden zukünftige Anfragen nicht durch Blockaden oder Wettbewerbsausschlüsse für diese Anzeige beeinflusst.
Parameter | |
---|---|
| Das Array der Slots, die gelöscht werden sollen. „Array“ ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht. |
Gibt Folgendes zurück: | |
---|---|
boolean | Gibt true zurück, wenn die Slots gelöscht wurden, andernfalls false . |
clearCategoryExclusions
- Beispiel
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (alt)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- Weitere Informationen
clearCategoryExclusions(): PubAdsService
Löscht alle Labels für den Ausschluss von Anzeigenkategorien auf Seitenebene. Das ist nützlich, wenn Sie den Slot aktualisieren möchten.
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf dem die Methode aufgerufen wurde. |
clearTargeting
- Beispiel
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (alt)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- Weitere Informationen
clearTargeting(key?: string): PubAdsService
Benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel werden gelöscht.
Parameter | |
---|---|
| Parameterschlüssel für die Ausrichtung. Der Schlüssel ist optional. Wenn er nicht angegeben ist, werden alle Targeting-Parameter gelöscht. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf das die Methode aufgerufen wurde. |
collapseEmptyDivs
- Weitere Informationen
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
Hiermit können Slot-Divs minimiert werden, damit sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigencontent zu sehen ist. Dieser Modus muss festgelegt werden, bevor der Dienst aktiviert wird.
Parameter | |
---|---|
| Gibt an, ob die Slots minimiert werden sollen, bevor die Anzeigen abgerufen werden. Dieser Parameter ist optional. Wenn er nicht angegeben wird, wird false als Standardwert verwendet. |
Gibt Folgendes zurück: | |
---|---|
boolean | Gibt true zurück, wenn der Collapse-Modus für Divs aktiviert wurde, und false , wenn der Collapse-Modus nicht aktiviert werden kann, weil die Methode nach der Aktivierung des Dienstes aufgerufen wurde. |
disableInitialLoad
- Weitere Informationen
disableInitialLoad(): void
Deaktiviert Anfragen für Anzeigen beim Seitenaufbau, ermöglicht aber das Anfordern von Anzeigen mit einem PubAdsService.refresh-Aufruf. Diese Einstellung sollte vor der Aktivierung des Dienstes festgelegt werden. Der asynchrone Modus muss verwendet werden, da es sonst nicht möglich ist, Anzeigen über refresh
anzufordern.
Display
- Beispiel
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (alt)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- Weitere Informationen
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
Erstellt und zeigt eine Anzeigenfläche mit dem angegebenen Pfad und der angegebenen Größe des Anzeigenblocks an. Diese Methode funktioniert nicht im Modus „Einzelanfrage“.
Hinweis:Wenn diese Methode aufgerufen wird, wird ein Snapshot des Slots und des Seitenstatus erstellt, um für Konsistenz beim Senden der Anzeigenanfrage und beim Rendern der Antwort zu sorgen. Alle Änderungen, die nach dem Aufruf dieser Methode am Slot- oder Seitenstatus vorgenommen werden (z. B. Targeting, Datenschutzeinstellungen, erzwungenes SafeFrame), werden nur auf nachfolgende display()
- oder refresh()
-Anfragen angewendet.
Parameter | |
---|---|
adUnitPath: string | Der Pfad zum Anzeigenblock der Anzeigenfläche, die gerendert werden soll. |
size: GeneralSize | Breite und Höhe des Steckplatzes. |
| Entweder die ID des Div-Elements, das den Slot enthält, oder das Div-Element selbst. |
| Die Klick-URL, die für diese Anzeigenfläche verwendet werden soll. |
enableLazyLoad
- Beispiel
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (alt)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Weitere Informationen
fetchMarginPercent
Der Mindestabstand, den eine Anzeigenfläche vom aktuellen Darstellungsbereich haben muss, bevor die Anzeige abgerufen wird, als Prozentsatz der Größe des Darstellungsbereichs. Ein Wert von 0 bedeutet „wenn die Anzeigenfläche den Darstellungsbereich betritt“, 100 bedeutet „wenn die Anzeige 1 Darstellungsbereich entfernt ist“ usw.renderMarginPercent
Der Mindestabstand, den ein Anzeigenblock vom aktuellen Darstellungsbereich haben muss, bevor eine Anzeige gerendert wird. Dies ermöglicht das Vorabrufen der Anzeige, aber das Rendern und Herunterladen anderer Unterressourcen. Der Wert funktioniert genauso wiefetchMarginPercent
als Prozentsatz des Darstellungsbereichs.mobileScaling
Multiplikator, der auf Ränder auf Mobilgeräten angewendet wird. So können unterschiedliche Ränder auf Mobilgeräten und Computern verwendet werden. Beispielsweise werden mit einem Wert von 2, 0 alle Ränder auf Mobilgeräten mit 2 multipliziert, wodurch der Mindestabstand einer Anzeigenfläche vor dem Abrufen und Rendern erhöht wird.
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): void
Aktiviert das Lazy-Loading in GPT gemäß der Definition im Konfigurationsobjekt. Ausführlichere Beispiele finden Sie im Beispiel für Lazy Loading.
Hinweis:Das Lazy-Abrufen in der SRA funktioniert nur, wenn sich alle Slots außerhalb des Abrufmargens befinden.
Parameter | |
---|---|
| Das Konfigurationsobjekt ermöglicht die Anpassung von Lazy-Verhalten. Für alle ausgelassenen Konfigurationen wird ein von Google festgelegter Standard verwendet, der im Laufe der Zeit angepasst wird. Wenn Sie eine bestimmte Einstellung deaktivieren möchten, z. B. einen Abrufzuschlag, setzen Sie den Wert auf -1 . |
enableSingleRequest
- Weitere Informationen
enableSingleRequest(): boolean
Hiermit wird der Modus „Einzelanfrage“ aktiviert, um mehrere Anzeigen gleichzeitig abzurufen. Dazu müssen alle Anzeigenflächen für Publisher-Anzeigen definiert und dem PubAdsService hinzugefügt werden, bevor der Dienst aktiviert wird. Der Modus für einzelne Anfragen muss festgelegt werden, bevor der Dienst aktiviert wird.
Gibt Folgendes zurück: | |
---|---|
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. So können Einschränkungen für Konkurrenzausschlüsse für Display- und Videoanzeigen aktiviert werden. Wenn der Videoinhalt bekannt ist, rufen Sie PubAdsService.setVideoContent auf, um Inhaltsausschlüsse für Displayanzeigen verwenden zu können.
getroffen
- Beispiel
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Weitere Informationen
get(key: string): null | string
Gibt den Wert für das AdSense-Attribut zurück, das mit dem jeweiligen Schlüssel verknüpft ist.
Parameter | |
---|---|
key: string | Name des Attributs, nach dem gesucht werden soll. |
Gibt Folgendes zurück: | |
---|---|
null | string | Der aktuelle Wert für den Attributschlüssel oder null , wenn der Schlüssel nicht vorhanden ist. |
getAttributeKeys
- Beispiel
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
getAttributeKeys(): string[]
Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden.
Gibt Folgendes zurück: | |
---|---|
string[] | Array von Attributschlüsseln, die für diesen Dienst festgelegt wurden. Die Reihenfolge ist nicht definiert. |
getTargeting
- Beispiel
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (alt)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
getTargeting(key: string): string[]
Gibt einen bestimmten benutzerdefinierten Parameter für die Ausrichtung auf Dienstebene zurück, der festgelegt wurde.
Parameter | |
---|---|
key: string | Der zu suchende Targeting-Schlüssel. |
Gibt Folgendes zurück: | |
---|---|
string[] | Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn es keinen solchen Schlüssel gibt. |
getTargetingKeys
- Beispiel
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (alt)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
getTargetingKeys(): string[]
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden.
Gibt Folgendes zurück: | |
---|---|
string[] | Array von Targeting-Schlüsseln. Reihenfolge ist nicht definiert. |
isInitialLoadDisabled
isInitialLoadDisabled(): boolean
Gibt an, ob die ersten Anfragen für Anzeigen durch einen vorherigen Aufruf von PubAdsService.disableInitialLoad deaktiviert wurden.
Gibt Folgendes zurück: | |
---|---|
boolean | Gibt true zurück, wenn ein vorheriger Aufruf von PubAdsService.disableInitialLoad erfolgreich war, andernfalls false . |
Aktualisieren
- Beispiel
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (alt)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Weitere Informationen
changeCorrelator
Gibt an, ob für das Abrufen von Anzeigen ein neuer Korrelator generiert werden soll. Unsere Ad-Server speichern diesen Korrelatorwert kurzzeitig (aktuell 30 Sekunden, kann sich aber ändern), sodass Anfragen mit demselben Korrelator, die kurz nacheinander eingehen, als ein 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. Dieser enthält automatisch die aktuell auf der Seite angezeigten Anzeigen und hat keine Ablaufzeit.
refresh(slots?: null | Slot[], options?: {
changeCorrelator: boolean;
}): void
Hiermit werden neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite abgerufen und angezeigt. 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 es bei der Aktualisierung zu unerwartetem Verhalten kommen. Mit der Methode PubAdsService.disableInitialLoad können Sie verhindern, dass display
eine Anzeige abruft.
Wenn Sie eine Anzeigenfläche aktualisieren, wird die alte Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt. So werden zukünftige Anfragen nicht durch Blockierungen oder Wettbewerbsausschlüsse beeinflusst, die sich auf diese Anzeige beziehen.
Parameter | |
---|---|
| Die zu aktualisierenden Anzeigenflächen. „Array“ ist optional. Wenn es nicht angegeben ist, werden alle Slots aktualisiert. |
| Konfigurationsoptionen, die mit diesem Aktualisierungsaufruf verknüpft sind. |
set
- Beispiel
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- Weitere Informationen
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.
Parameter | |
---|---|
key: string | Der Name des Attributs. |
value: string | Attributwert. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf das die Methode aufgerufen wurde. |
setCategoryExclusion
- Beispiel
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (alt)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Weitere Informationen
setCategoryExclusion(categoryExclusion: string): PubAdsService
Legt einen Ausschluss der Anzeigenkategorie auf Seitenebene für den angegebenen Labelnamen fest.
Parameter | |
---|---|
categoryExclusion: string | Das Label für den Anzeigenkategorienausschluss, das hinzugefügt werden soll. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf das die Methode aufgerufen wurde. |
setCentering
- Beispiel
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (alt)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
setCentering(centerAds: boolean): void
Hiermit wird die horizontale Zentrierung von Anzeigen aktiviert oder deaktiviert. Die Zentrierung ist standardmäßig deaktiviert. In der alten Version von gpt_mobile.js ist die Zentrierung standardmäßig aktiviert.
Diese Methode sollte vor dem Aufrufen von display
oder refresh
aufgerufen werden, da nur Anzeigen, die nach dem Aufrufen dieser Methode angefordert werden, zentriert werden.
Parameter | |
---|---|
centerAds: boolean | true , um Anzeigen zu zentrieren, oder false , um sie links auszurichten. |
setForceSafeFrame
- Diese Einstellung gilt nur für nachfolgende Anzeigenanfragen für die jeweiligen Slots.
- 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 Sie jedoch
false
festlegen oder die Option nicht angeben, wird die Anzeige je nach Creative-Typ und 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 kann, die versuchen, aus ihren iFrames auszubrechen oder die direkt auf einer Publisher-Seite gerendert werden müssen.
- Beispiel
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (alt)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Weitere Informationen
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
Mit dieser Richtlinie wird konfiguriert, ob das Rendering aller Anzeigen auf der Seite mit einem SafeFrame-Container erzwungen werden soll.
Beachten Sie bei der Verwendung dieser API Folgendes:
Parameter | |
---|---|
forceSafeFrame: boolean | true , um alle Anzeigen auf der Seite in SafeFrames zu rendern, und false , um die vorherige Einstellung in „false“ (falsch) zu ändern. Wird es auf false gesetzt, wenn nichts anderes angegeben wurde, ändert sich nichts. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Funktion aufgerufen wurde. |
setLocation
- Beispiel
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (alt)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
setLocation(address: string): PubAdsService
Gibt Standortinformationen von Websites weiter, sodass Sie Werbebuchungen per geografischem Targeting auf bestimmte Orte ausrichten können.
Parameter | |
---|---|
address: string | Adresse im freien Format. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf das die Methode aufgerufen wurde. |
setPrivacySettings
- Beispiel
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (alt)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- Weitere Informationen
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzelne API mithilfe eines Konfigurationsobjekts.
Parameter | |
---|---|
privacySettings: PrivacySettingsConfig | Objekt mit den Datenschutzeinstellungen |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Funktion aufgerufen wurde. |
setPublisherProvidedId
- Beispiel
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (alt)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Weitere Informationen
setPublisherProvidedId(ppid: string): PubAdsService
Legt den Wert für die vom Publisher bereitgestellte ID fest.
Parameter | |
---|---|
ppid: string | Eine alphanumerische ID, die vom Publisher bereitgestellt wird. Muss zwischen 32 und 150 Zeichen lang sein. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf dem die Methode aufgerufen wurde. |
setSafeFrameConfig
- Beispiel
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (alt)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Weitere Informationen
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
Legt die Einstellungen für die SafeFrame-Konfiguration auf Seitenebene fest. Alle nicht erkannten Schlüssel im Konfigurationsobjekt werden ignoriert. Wenn für einen erkannten Schlüssel ein ungültiger Wert übergeben wird, wird die gesamte Konfiguration ignoriert.
Diese Einstellungen auf Seitenebene werden von den Einstellungen auf Anzeigenflächenebene überschrieben, sofern diese angegeben sind.
Parameter | |
---|---|
config: SafeFrameConfig | Das Konfigurationsobjekt. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf das die Methode aufgerufen wurde. |
setTargeting
- Beispiel
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (alt)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Weitere Informationen
setTargeting(key: string, value: string | string[]): PubAdsService
Hiermit werden benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel festgelegt, die auf alle Anzeigenflächen des Publisher Ads-Dienstes angewendet werden. Wenn Sie diese Funktion mehrmals für denselben Schlüssel aufrufen, werden alte Werte überschrieben. Diese Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.
Parameter | |
---|---|
key: string | Parameterschlüssel für die Ausrichtung. |
value: string | string[] | Wert des Targeting-Parameters oder Array von Werten. |
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, auf das die Methode aufgerufen wurde. |
setVideoContent
- Weitere Informationen
setVideoContent(videoContentId: string, videoCmsId: string): void
Hier legen Sie fest, welche Informationen zu Videoinhalten zusammen mit den Anzeigenanfragen gesendet werden sollen, um das Targeting und den Ausschluss von Inhalten zu ermöglichen. Videoanzeigen werden automatisch aktiviert, wenn diese Methode aufgerufen wird. Verwenden Sie für videoContentId
und videoCmsId
die Werte, die für den Contentaufnahmedienst von Google Ad Manager bereitgestellt werden.
Parameter | |
---|---|
videoContentId: string | Die ID des Videocontents. |
videoCmsId: string | Die CMS-ID des Videos. |
updateCorrelator
- Beispiel
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (alt)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
updateCorrelator(): PubAdsService
Ändert den Korrelator, der mit den Anzeigenanfragen gesendet wird, wodurch ein neuer Seitenaufruf gestartet wird. Der Korrelator ist für alle Anzeigenanfragen aus einem Seitenaufruf gleich und für verschiedene Seitenaufrufe unterschiedlich. Gilt nur für den asynchronen Modus.
Hinweis:Dies hat keine Auswirkungen auf die langlebige Seitenaufruf-ID von GPT, die automatisch die tatsächlich auf der Seite vorhandenen Anzeigen widerspiegelt und keine Ablaufzeit hat.
Gibt Folgendes zurück: | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Funktion aufgerufen wurde. |
googletag.ResponseInformation
Attribute | |
---|---|
advertiser | Die ID des Werbetreibenden. |
campaign | Die ID der Kampagne. |
creative | Die ID des Creatives. |
creative | Die Vorlagen-ID der Anzeige. |
line | Die ID der Position. |
- Weitere Informationen
Attribute
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
Attribute | |
---|---|
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
Attribute
Betrag
amount: number
Die Anzahl der Artikel, die in der Prämie enthalten sind.
type
type: string
Die Art des Artikels, der in der Prämie enthalten ist (z. B. „coin“).
googletag.SafeFrameConfig
Attribute | |
---|---|
allow | Ob SafeFrame es zulassen soll, dass sich Anzeigeninhalte durch Überlagerung des Seiteninhalts maximieren. |
allow | Legt fest, ob SafeFrame das Maximieren des Anzeigencontents durch Übertragen des Seitencontents zulassen soll |
sandbox | Gibt an, ob SafeFrame das HTML5-Sandbox-Attribut verwenden soll, um eine Navigation auf der obersten Ebene ohne Nutzerinteraktion zu verhindern. |
use | Eingestellt. Ob SafeFrame zufällige Subdomains für Reservierungs-Creatives verwenden soll. |
- Weitere Informationen
Attribute
Optional
allowOverlayExpansion
allowOverlayExpansion?: boolean
Ob SafeFrame es zulassen soll, dass sich Anzeigeninhalte durch Überlagerung des Seiteninhalts maximieren.
Optional
allowPushExpansion
allowPushExpansion?: boolean
Ob SafeFrame es zulassen soll, dass sich Anzeigeninhalte durch das Verschieben von Seiteninhalten maximieren.
Optional
Sandbox
sandbox?: boolean
Gibt an, ob SafeFrame das HTML5-Sandbox-Attribut verwenden soll, um eine Navigation auf der obersten Ebene ohne Nutzerinteraktion zu verhindern. Der einzige gültige Wert ist true
. Der Wert kann nicht auf false
festgelegt werden. Hinweis: Das Sandbox-Attribut deaktiviert Plug-ins (z. B. Flash).
Optional
useUniqueDomain
- Weitere Informationen
useUniqueDomain?: null | boolean
Gibt an, ob SafeFrame zufällig ausgewählte Subdomains für Reservierungs-Creatives verwenden soll Gib null
ein, um den gespeicherten Wert zu löschen.
Hinweis: Diese Funktion ist standardmäßig aktiviert.
googletag.Service
Methoden | |
---|---|
add | Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt. |
get | Liste der Slots abrufen, die mit diesem Dienst verknüpft sind |
remove | Entfernt einen zuvor registrierten Listener. |
Methoden
addEventListener
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- Beispiel
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
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:
Parameter | |
---|---|
eventType: K | Ein String, der den von GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet. |
listener: ((arg: EventTypeMap[K]) => void) | Funktion, die ein einzelnes Argument für das Ereignisobjekt annimmt. |
Gibt Folgendes zurück: | |
---|---|
Service | Das Dienstobjekt, auf das die Methode aufgerufen wurde. |
getSlots
removeEventListener
- Beispiel
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (alt)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
Entfernt einen zuvor registrierten Listener.
Parameter | |
---|---|
eventType: K | Ein String, der den von GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet. |
listener: ((event: EventTypeMap[K]) => void) | Funktion, die ein einzelnes Ereignisobjektargument annimmt. |
googletag.SizeMappingBuilder
Methoden | |
---|---|
add | Hiermit wird eine Zuordnung von einem Array mit einer einzelnen Größe (für den Darstellungsbereich) zu einem Array mit einer einzelnen oder mehreren Größen für den Slot hinzugefügt. |
build | Erstellt eine Größenzuordnungsspezifikation aus den Zuordnungen, die diesem Builder hinzugefügt wurden. |
- Weitere Informationen
Methoden
addSize
- Beispiel
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (alt)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
Hiermit wird eine Zuordnung von einem Array mit einer einzelnen Größe (für den Darstellungsbereich) zu einem Array mit einer einzelnen oder mehreren Größen für den Slot hinzugefügt.
Parameter | |
---|---|
viewportSize: SingleSizeArray | Die Größe des Darstellungsbereichs für diesen Zuordnungseintrag. |
slotSize: GeneralSize | Die Größe des Slots für diesen Zuordnungseintrag. |
Gibt Folgendes zurück: | |
---|---|
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 wird.
Hinweis: Das Verhalten des Builders nach dem Aufrufen dieser Methode ist nicht definiert.
Gibt Folgendes zurück: | |
---|---|
null | SizeMappingArray | Das von diesem Builder erstellte Ergebnis. Kann null sein, wenn ungültige Größenzuordnungen angegeben wurden. |
googletag.Slot
Methoden | |
---|---|
add | Fügen Sie diesem Steckplatz einen Dienst hinzu. |
clear | Alle Labels für den Ausschluss von Anzeigenkategorien auf Anzeigenflächenebene für diesen Anzeigenblock werden gelöscht. |
clear | Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Anzeigenflächenebene für diese Anzeigenfläche. |
define | Hiermit wird ein Array von Zuordnungen von einer Mindestgröße des Darstellungsbereichs zur Steckplatzgröße für diesen Steckplatz festgelegt. |
get | Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diesen Slot verknüpft ist. |
get | Gibt den vollständigen Pfad des Anzeigenblocks mit dem Netzwerkcode und dem Anzeigenblockpfad zurück. |
get | Liste der Attributschlüssel, die für diesen Slot festgelegt sind. |
get | Die Labels für den Ausschluss von Anzeigenkategorien für diesen Slot. |
get | Gibt die Informationen zur Anzeigenantwort zurück. |
get | Gibt die ID des Slots div zurück, die beim Definieren des Slots angegeben wurde. |
get | Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diesen Slot festgelegt wurde. |
get | Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diesen Slot festgelegt wurden. |
set | Hier wird ein Wert für ein AdSense-Attribut für diese Anzeigenfläche festgelegt. |
set | Legt ein Ausschlusslabel für die Anzeigenkategorie auf Anzeigenflächenebene für diese Anzeigenfläche fest. |
set | Legt die Klick-URL fest, an die Nutzer weitergeleitet werden, nachdem sie auf die Anzeige geklickt haben. |
set | Hiermit wird festgelegt, ob die Anzeigenfläche div ausgeblendet werden soll, wenn sich keine Anzeige darauf befindet. |
set | Hier legen Sie allgemeine Konfigurationsoptionen für diesen Steckplatz fest. |
set | Hiermit wird konfiguriert, ob Anzeigen in diesem Slot erzwungen mit einem SafeFrame-Container gerendert werden sollen. |
set | Legt die Einstellungen für SafeFrame auf Slotebene fest. |
set | Legt einen benutzerdefinierten Targeting-Parameter für diese Anzeigenfläche fest. |
update | Hiermit werden benutzerdefinierte Targeting-Parameter für diesen Slot anhand einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt festgelegt. |
Methoden
addService
- Beispiel
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (alt)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Weitere Informationen
addService(service: Service): Slot
Fügen Sie diesem Steckplatz einen Dienst hinzu.
Parameter | |
---|---|
service: Service | Der Dienst, der hinzugefügt werden soll. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
clearCategoryExclusions
- Beispiel
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (alt)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
clearCategoryExclusions(): Slot
Alle Labels für den Ausschluss von Anzeigenkategorien auf Anzeigenflächenebene für diesen Anzeigenblock werden gelöscht.
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
clearTargeting
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Weitere Informationen
clearTargeting(key?: string): Slot
Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Anzeigenflächenebene für diese Anzeigenfläche.
Parameter | |
---|---|
| Parameterschlüssel für die Ausrichtung. Der Schlüssel ist optional. Wenn er nicht angegeben ist, werden alle Targeting-Parameter gelöscht. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
defineSizeMapping
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping!);
- Weitere Informationen
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.
Parameter | |
---|---|
sizeMapping: SizeMappingArray | Array mit Größenzuordnungen. Sie können SizeMappingBuilder verwenden, um sie zu erstellen. Jede Größenzuordnung ist ein Array mit zwei Elementen: SingleSizeArray und GeneralSize. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
getroffen
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- Weitere Informationen
get(key: string): null | string
Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diesen Slot verknüpft ist. Um die von dieser Anzeigenfläche übernommenen Attribute auf Dienstebene zu sehen, verwenden Sie PubAdsService.get.
Parameter | |
---|---|
key: string | Name des Attributs, nach dem gesucht werden soll. |
Gibt Folgendes zurück: | |
---|---|
null | string | Der aktuelle Wert für den Attributschlüssel oder null , wenn der Schlüssel nicht vorhanden ist. |
getAdUnitPath
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
getAdUnitPath(): string
Gibt den vollständigen Pfad des Anzeigenblocks mit dem Netzwerkcode und dem Anzeigenblockpfad zurück.
Gibt Folgendes zurück: | |
---|---|
string | Anzeigenblockpfad. |
getAttributeKeys
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
getAttributeKeys(): string[]
Gibt die Liste der für diese Anzeigenfläche festgelegten Attributschlüssel zurück Mit PubAdsService.getAttributeKeys können Sie die Schlüssel der Attribute auf Dienstebene abrufen, die von diesem Slot übernommen wurden.
Gibt Folgendes zurück: | |
---|---|
string[] | Array von Attributschlüsseln. Die Reihenfolge ist nicht definiert. |
getCategoryExclusions
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
getCategoryExclusions(): string[]
Die Labels für den Ausschluss von Anzeigenkategorien für diesen Slot.
Gibt Folgendes zurück: | |
---|---|
string[] | Die Labels für die Anzeigenkategorienausschlüsse für diesen Slot oder ein leeres Array, wenn keine festgelegt wurden. |
getResponseInformation
getResponseInformation(): null | ResponseInformation
Gibt die Informationen zur Anzeigenantwort zurück. Dieser Wert basiert auf der letzten Anzeigenantwort für den Slot. Wenn dieser Vorgang aufgerufen wird, wenn sich in der Anzeigenfläche keine Anzeige befindet, wird null
zurückgegeben.
Gibt Folgendes zurück: | |
---|---|
null | ResponseInformation | Die neuesten Informationen zur Anzeigenantwort oder null , wenn auf der Anzeigenfläche keine Anzeige ausgeliefert wird. |
getSlotElementId
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
getSlotElementId(): string
Gibt die ID der Anzeigenfläche div
zurück, die beim Definieren der Anzeigenfläche angegeben wurde.
Gibt Folgendes zurück: | |
---|---|
string | ID der Anzeigenfläche div . |
getTargeting
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
getTargeting(key: string): string[]
Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diesen Slot festgelegt wurde. Targeting-Parameter auf Dienstebene sind nicht enthalten.
Parameter | |
---|---|
key: string | Der zu suchende Targeting-Schlüssel. |
Gibt Folgendes zurück: | |
---|---|
string[] | Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn es keinen solchen Schlüssel gibt. |
getTargetingKeys
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
getTargetingKeys(): string[]
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diesen Slot festgelegt wurden. Targeting-Schlüssel auf Dienstebene sind nicht enthalten.
Gibt Folgendes zurück: | |
---|---|
string[] | Array von Targeting-Schlüsseln Die Reihenfolge ist nicht definiert. |
set
- Beispiel
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (alt)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- Weitere Informationen
set(key: string, value: string): Slot
Hier wird ein Wert für ein AdSense-Attribut für diese Anzeigenfläche festgelegt. Dadurch werden alle auf Dienstebene für diesen Schlüssel festgelegten Werte überschrieben.
Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen festgelegt sein, bevor display
oder refresh
aufgerufen wird.
Parameter | |
---|---|
key: string | Der Name des Attributs. |
value: string | Attributwert. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
setCategoryExclusion
- Beispiel
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (alt)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- Weitere Informationen
setCategoryExclusion(categoryExclusion: string): Slot
Hiermit wird ein Label für den Ausschluss von Anzeigenkategorien auf Anzeigenflächenebene für diese Anzeigenfläche festgelegt.
Parameter | |
---|---|
categoryExclusion: string | Das Label für den Anzeigenkategorienausschluss, das hinzugefügt werden soll. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
setClickUrl
- Beispiel
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
setClickUrl(value: string): Slot
Legt die Klick-URL fest, an die Nutzer weitergeleitet werden, nachdem sie auf die Anzeige geklickt haben.
Die Google Ad Manager-Server erfassen auch dann einen Klick, wenn die Klick-URL ersetzt wird. Alle Landingpage-URLs, die mit dem ausgelieferten Creative verknüpft sind, werden an den angegebenen Wert angehängt. Bei nachfolgenden Aufrufen wird der Wert überschrieben. Das funktioniert nur für Anfragen, die nicht als SRA gekennzeichnet sind.
Parameter | |
---|---|
value: string | Die Klick-URL, die festgelegt werden soll. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
setCollapseEmptyDiv
- Beispiel
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Weitere Informationen
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
Hiermit wird festgelegt, ob die Anzeigenfläche div
ausgeblendet werden soll, wenn sich keine Anzeige darauf befindet. Dadurch werden die Einstellungen auf Dienstebene überschrieben.
Parameter | |
---|---|
collapse: boolean | Gibt an, ob die Anzeigenfläche minimiert werden soll, wenn keine Anzeige zurückgegeben wird. |
| Gibt an, ob der Slot minimiert werden soll, bevor eine Anzeige abgerufen wird. Wird ignoriert, wenn für die Minimierung nicht true festgelegt ist. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, 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
- Diese Einstellung gilt nur für nachfolgende Anzeigenanfragen für die jeweiligen Slots.
- 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 Sie jedoch
false
festlegen oder die Option nicht angeben, wird die Anzeige je nach Creative-Typ und 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 kann, die versuchen, aus ihren iFrames auszubrechen oder die direkt auf einer Publisher-Seite gerendert werden müssen.
- Beispiel
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- Weitere Informationen
setForceSafeFrame(forceSafeFrame: boolean): Slot
Hiermit wird konfiguriert, ob Anzeigen in diesem Slot erzwungen mit einem SafeFrame-Container gerendert werden sollen.
Beachten Sie bei der Verwendung dieser API Folgendes:
Parameter | |
---|---|
forceSafeFrame: boolean | true , um alle Anzeigen in diesem Slot in SafeFrames zu rendern, und false , um eine Einstellung auf Seitenebene zu deaktivieren (falls vorhanden). Wird dieser Wert auf false gesetzt, wenn er nicht auf Seitenebene festgelegt ist, ändert sich nichts. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
setSafeFrameConfig
- Beispiel
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (alt)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Weitere Informationen
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. Wenn für einen erkannten Schlüssel ein ungültiger Wert übergeben wird, wird die gesamte Konfiguration ignoriert.
Wenn diese Einstellungen auf Anzeigenflächenebene angegeben werden, werden alle Einstellungen auf Seitenebene überschrieben.
Parameter | |
---|---|
config: null | SafeFrameConfig | Das Konfigurationsobjekt. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
setTargeting
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Weitere Informationen
setTargeting(key: string, value: string | string[]): Slot
Hiermit wird ein benutzerdefinierter Targeting-Parameter für diesen Slot festgelegt. Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden alte Werte überschrieben. Die hier festgelegten Werte überschreiben die auf Dienstebene festgelegten Targeting-Parameter. Diese Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.
Parameter | |
---|---|
key: string | Parameterschlüssel für die Ausrichtung. |
value: string | string[] | Wert des Targeting-Parameters oder Array von Werten. |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
updateTargetingFromMap
- Bei Überschreibungen 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 (alt)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
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. Das entspricht dem Aufruf von Slot.setTargeting für alle Schlüsselwerte des Objekts. Diese Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.
Hinweise:
Parameter | |
---|---|
map: { | Zuordnung von Targeting-Parametern (Schlüssel/Wert) |
Gibt Folgendes zurück: | |
---|---|
Slot | Das Steckplatzobjekt, für das die Methode aufgerufen wurde. |
googletag.config
Interfaces | |
---|---|
Ad | Einstellungen zur Steuerung der Anzeigenexpansion. |
Component | Ein Objekt, das eine einzelne Komponentenauktion in einer On-Device-Anzeigenauktion darstellt. |
Interstitial | Ein Objekt, das das Verhalten einer einzelnen Interstitial-Anzeigenfläche definiert. |
Page | Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene. |
Privacy | Einstellungen zum Festlegen von Datenschutzeinstellungen für Publisher. |
Publisher | Konfigurationsobjekt für vom Publisher bereitgestellte Signale (PPS) |
Slot | Hauptkonfigurationsoberfläche für Einstellungen auf Slotebene. |
Taxonomy | Ein Objekt mit den Werten für eine einzelne Taxonomie. |
Typaliasse | |
---|---|
Interstitial | Unterstützte Trigger für Interstitial-Anzeigen |
Privacy | Unterstützte Datenschutzmaßnahmen für Publisher |
Taxonomy | Unterstützte Taxonomien für vom Publisher bereitgestellte Signale (PPS) |
Typaliasse
InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar"
Unterstützte Trigger für Interstitial-Anzeigen.
PrivacyTreatment
PrivacyTreatment: "disablePersonalization"
Unterstützte Datenschutzmaßnahmen für Publisher
Taxonomie
- Weitere Informationen
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
Unterstützte Taxonomien für vom Publisher bereitgestellte Signale (PPS)
googletag.config.AdExpansionConfig
Attribute | |
---|---|
enabled | Gibt an, ob die Anzeigenerweiterung aktiviert oder deaktiviert ist. |
- Beispiel
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (alt)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
Attribute
Optional
aktiviert
enabled?: boolean
Gibt an, ob die Anzeigenerweiterung aktiviert oder deaktiviert ist.
Wenn Sie diesen Wert festlegen, wird der in Google Ad Manager konfigurierte Standardwert überschrieben.
googletag.config.ComponentAuctionConfig
Attribute | |
---|---|
auction | Ein Auktionskonfigurationsobjekt für diese Komponentenauktion. |
config | Der Konfigurationsschlüssel, der mit dieser Komponentenauktion verknüpft ist. |
- Weitere Informationen
Attribute
auctionConfig
- Beispiel
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (alt)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- Weitere Informationen
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
festgelegt ist, werden alle vorhandenen Konfigurationen für die angegebene configKey
gelöscht.
configKey
configKey: string
Der Konfigurationsschlüssel, der mit dieser Komponentenauktion verknüpft ist.
Dieser Wert darf nicht leer sein und sollte eindeutig sein. Wenn zwei ComponentAuctionConfig
-Objekte denselben configKey-Wert haben, werden frühere Konfigurationen durch die zuletzt festgelegte Konfiguration überschrieben.
googletag.config.InterstitialConfig
Attribute | |
---|---|
triggers | Die Konfiguration des Interstitial-Triggers für diese Interstitial-Anzeige. |
Attribute
Optional
Trigger
- Beispiel
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (alt)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Weitere Informationen
triggers?: Partial<Record<InterstitialTrigger, boolean>>
Die Konfiguration des Interstitial-Triggers für diese Interstitial-Anzeige.
Wenn Sie den Wert eines Interstitial-Triggers auf true
setzen, wird er aktiviert. Bei false
wird er deaktiviert. Dadurch werden die in Google Ad Manager konfigurierten Standardwerte überschrieben.
googletag.config.PageSettingsConfig
Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf.
Alle unten aufgeführten Properties sind Beispiele und spiegeln keine tatsächlichen Funktionen wider, für die setConfig verwendet wird. Die Funktionen finden Sie unten in den Feldern des Typs „PageSettingsConfig“.
Beispiele:
- Nur Funktionen, die im Aufruf googletag.setConfig angegeben sind, werden geändert.
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Alle Einstellungen für eine bestimmte Funktion werden bei jedem Aufruf von googletag.setConfig aktualisiert.
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Alle Einstellungen für eine Funktion können durch Übergabe von
null
gelöscht werden.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
Attribute | |
---|---|
ad | Einstellungen für die Anzeigenausweitung. |
ad | Eingestellt. |
pps | Einstellungen für vom Publisher bereitgestellte Signale. |
privacy | Einstellungen zur Steuerung der Datenschutzmaßnahmen von Publishern. |
thread | Mit dieser Einstellung wird festgelegt, ob GPT beim Rendern von Creatives den JS-Thread zurückgeben soll. |
Attribute
Optional
adExpansion
adExpansion?: null | AdExpansionConfig
Einstellungen für die Anzeigenausweitung.
Optional
adYield
adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Optional
pps
pps?: null | PublisherProvidedSignalsConfig
Einstellungen für vom Publisher bereitgestellte Signale.
Optional
privacyTreatments
privacyTreatments?: null | PrivacyTreatmentsConfig
Einstellungen zur Steuerung der Datenschutzmaßnahmen von Publishern.
Optional
threadYield
null
(Standardeinstellung): GPT gibt den JS-Thread für Slots außerhalb des Darstellungsbereichs zurück.ENABLED_ALL_SLOTS
: GPT gibt den JS-Thread für alle Slots zurück, unabhängig davon, ob sich der Slot im Darstellungsbereich befindet.DISABLED
: GPT gibt den JS-Thread nicht zurück.- Beispiel
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript (alt)
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- Weitere Informationen
threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Mit dieser Einstellung wird festgelegt, ob GPT beim Rendern von Creatives den JS-Thread auslösen soll.
GPT liefert nur Ergebnisse für Browser, die die Scheduler.postTask- oder Scheduler.yield API unterstützen.
Unterstützte Werte:
googletag.config.PrivacyTreatmentsConfig
Attribute | |
---|---|
treatments | Eine Reihe von Datenschutzmaßnahmen für Publisher, die aktiviert werden sollen. |
Attribute
Behandlungen
- Beispiel
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (alt)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
treatments: "disablePersonalization"[]
Eine Reihe von Datenschutzmaßnahmen für Publisher, die aktiviert werden sollen.
googletag.config.PublisherProvidedSignalsConfig
Attribute | |
---|---|
taxonomies | Ein Objekt mit Taxonomiezuordnungen. |
- Beispiel
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (alt)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
Attribute
Taxonomien
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
Ein Objekt mit Taxonomiezuordnungen.
googletag.config.SlotSettingsConfig
Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf für einen einzelnen Steckplatz.
Alle unten aufgeführten Properties sind Beispiele und spiegeln keine tatsächlichen Funktionen wider, für die setConfig verwendet wird. Die Funktionen finden Sie in den Feldern des Typs „SlotSettingsConfig“ unten.
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 } });
- Alle Einstellungen für eine Funktion können durch Übergabe von
null
gelöscht werden.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
Attribute | |
---|---|
ad | Einstellungen für die Anzeigenausweitung. |
component | Mehrere Komponentenauktionen, die in eine On-Device-Anzeigenauktion einbezogen werden |
interstitial | Einstellungen für das Verhalten von Interstitial-Anzeigenflächen. |
Attribute
Optional
adExpansion
adExpansion?: AdExpansionConfig
Einstellungen für die Anzeigenausweitung.
Optional
componentAuction
componentAuction?: ComponentAuctionConfig[]
Eine Reihe von Komponentenauktionen, die in eine On-Device-Anzeigenauktion einbezogen werden sollen.
Optional
Interstitial
interstitial?: InterstitialConfig
Einstellungen für das Verhalten von Interstitial-Anzeigenflächen.
googletag.config.TaxonomyData
Attribute | |
---|---|
values | Eine Liste von Taxonomiewerten. |
Attribute
Werte
values: string[]
Eine Liste von Taxonomiewerten.
googletag.enums
Aufzählungen | |
---|---|
Out | Von GPT unterstützte Out-of-Page-Formate |
Traffic |
Aufzählungen
OutOfPageFormat
- Weitere Informationen
OutOfPageFormat
Von GPT unterstützte Out-of-Page-Formate
Elemente einer Aufzählung | |
---|---|
BOTTOM_ | Ankerformat, bei dem die Anzeigenfläche am unteren Rand des Darstellungsbereichs fixiert ist. |
GAME_ | Manuelles Interstitial-Format für Spiele. Hinweis:Manuelle Interstitial-Anzeigen für Spiele sind eingeschränkt. |
INTERSTITIAL | Web-Interstitial-Creative-Format. |
LEFT_ | Format des seitlichen Anzeigenstreifens links. |
REWARDED | Anzeigen mit Prämie |
RIGHT_ | Format für den rechten seitlichen Anzeigenstreifen. |
TOP_ | Ankerformat, bei dem die Anzeigenfläche oben im Darstellungsbereich bleibt. |
TrafficSource
- Weitere Informationen
TrafficSource
Von GPT unterstützte Besucherquellen
googletag.events
Interfaces | |
---|---|
Event | Basis-Schnittstelle für alle GPT-Ereignisse. |
Event | Dies ist ein Pseudotyp, der einen Ereignisnamen dem entsprechenden Ereignisobjekttyp für Service.addEventListener und Service.removeEventListener zuordnet. |
Game | Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Fläche für ein Spiel vom Nutzer geschlossen wurde. |
Game | Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Fläche für ein Spiel für den Nutzer bereit ist. |
Impression | Dieses Ereignis wird ausgelöst, wenn eine Impression gemäß den Active View-Kriterien sichtbar wird. |
Rewarded | Dieses Ereignis wird ausgelöst, wenn ein Anzeigenblock mit Prämie vom Nutzer geschlossen wird. |
Rewarded | Dieses Ereignis wird ausgelöst, wenn eine Prämie für die Wiedergabe einer Anzeige mit Prämie gewährt wird. |
Rewarded | Dieses Ereignis wird ausgelöst, wenn eine Anzeigen mit Prämie ausgeliefert werden kann. |
Slot | Dieses Ereignis wird ausgelöst, wenn das Load-Ereignis des iframes des Creatives ausgelöst wird. |
Slot | Dieses Ereignis wird ausgelöst, wenn der Creative-Code in eine Anzeigenfläche injiziert wird. |
Slot | Dieses Ereignis wird ausgelöst, wenn eine Anzeige für einen bestimmten Slot angefordert wurde. |
Slot | Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für einen bestimmten Slot empfangen wurde. |
Slot | Dieses Ereignis wird ausgelöst, wenn sich der Prozentsatz der Anzeigenfläche eines Anzeigen-Slots auf dem Bildschirm ändert. |
googletag.events.Event
Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. |
slot | Der Slot, der das Ereignis ausgelöst hat. |
- Weitere Informationen
Attribute
serviceName
serviceName: string
Name des Dienstes, der das Ereignis ausgelöst hat.
slot
slot: Slot
Der Slot, durch den das Ereignis ausgelöst wurde.
googletag.events.EventTypeMap
Attribute
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
Alias für events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
Alias für events.GameManualInterstitialSlotReadyEvent.
impressionViewable
impressionViewable: ImpressionViewableEvent
Alias für events.ImpressionViewableEvent.
rewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEvent
Alias für events.RewardedSlotClosedEvent.
rewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEvent
Alias für events.RewardedSlotGrantedEvent.
rewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEvent
Alias für events.RewardedSlotReadyEvent.
slotOnload
slotOnload: SlotOnloadEvent
Alias für events.SlotOnloadEvent.
slotRenderEnded
slotRenderEnded: SlotRenderEndedEvent
Alias für events.SlotRenderEndedEvent.
slotRequested
slotRequested: SlotRequestedEvent
Alias für events.SlotRequestedEvent.
slotResponseReceived
slotResponseReceived: SlotResponseReceived
Alias für events.SlotResponseReceived.
slotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEvent
Alias für events.SlotVisibilityChangedEvent.
googletag.events.GameManualInterstitialSlotClosedEvent
ErweitertHinweis:Manuelle Interstitial-Anzeigen für Spiele sind ein Format mit eingeschränktem Zugriff.
Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Übernommen von |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
- Beispiel
JavaScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when a game manual interstial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
googletag.events.GameManualInterstitialSlotReadyEvent
ErweitertHinweis:Manuelle Interstitial-Anzeigen für Spiele sind ein Format mit eingeschränktem Zugriff.
Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
Methoden | |
---|---|
make | Dem Nutzer wird die manuelle Interstitial-Anzeige für das Spiel präsentiert. |
- Beispiel
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
Methoden
makeGameManualInterstitialVisible
googletag.events.ImpressionViewableEvent
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Übernommen von |
- Beispiel
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
googletag.events.RewardedSlotClosedEvent
VerlängertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- 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 (alt)
// 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
ErweitertAttribute | |
---|---|
payload | Ein Objekt mit Informationen zur gewährten Prämie. |
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
- 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 (alt)
// 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
Attribute
Nutzlast
payload: null | RewardedPayload
Ein Objekt mit Informationen zur gewährten Prämie.
googletag.events.RewardedSlotReadyEvent
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
Methoden | |
---|---|
make | 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 (alt)
// 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
Methoden
makeRewardedVisible
googletag.events.SlotOnloadEvent
ErweitertSlotOnloadEvent
ausgelöst wird.Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
- Beispiel
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
googletag.events.SlotRenderEndedEvent
VerlängertAttribute | |
---|---|
advertiser | Die Werbetreibenden-ID der gerenderten Anzeige. |
campaign | Kampagnen-ID der gerenderten Anzeige. |
company | IDs der Unternehmen, die auf die gerenderte Backfill-Anzeige geboten haben. |
creative | Creative-ID der gerenderten Reservierungsanzeige. |
creative | Die Creative-Vorlagen-ID der gerenderten Reservierungsanzeige. |
is | Gibt an, ob es sich bei einer Anzeige um eine Backfill-Anzeige handelt. |
is | Gibt an, ob für den Anzeigenblock eine Anzeige zurückgegeben wurde. |
label | Eingestellt. |
line | Die Werbebuchungs-ID der gerenderten Reservierungsanzeige. |
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
size | Gibt die Pixelgröße des gerenderten Creatives an. |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
slot | Gibt an, ob der Inhalt der Anzeigenfläche mit der gerenderten Anzeige geändert wurde. |
source | Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige. |
source | Die Werbebuchungs-ID der gerenderten Reservierungs- oder Backfill-Anzeige. |
yield | IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige. |
- Beispiel
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
Attribute
advertiserId
advertiserId: null | number
Die Werbetreibenden-ID der gerenderten Anzeige. Der Wert ist null
für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.
campaignId
campaignId: 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 geboten haben. 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. Der Wert ist null
für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.
creativeTemplateId
creativeTemplateId: null | number
ID der Creative-Vorlage der gerenderten Reservierungsanzeige. Der Wert ist null
für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.
isBackfill
isBackfill: boolean
Gibt an, ob es sich bei einer Anzeige um eine Backfill-Anzeige handelt. Der Wert ist true
, wenn es sich um eine Backfill-Anzeige handelt, andernfalls false
.
isEmpty
isEmpty: boolean
Gibt an, ob für den Anzeigenblock eine Anzeige zurückgegeben wurde. Der Wert ist true
, wenn keine Anzeige zurückgegeben wurde, andernfalls false
.
labelIds
labelIds: null | number[]
lineItemId
lineItemId: null | number
Die ID der Werbebuchung 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[]
Die Pixelgröße des gerenderten Creatives. Beispiel: [728, 90]
. Bei leeren Anzeigenflächen ist der Wert null
.
slotContentChanged
slotContentChanged: boolean
Gibt an, ob der Slot-Inhalt 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 es sich bei der Anzeige nicht um ein Backfill für eine Reservierung oder Werbebuchung handelt oder das Creative von anderen Diensten als PubAdsService gerendert wird.
yieldGroupIds
yieldGroupIds: null | number[]
IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige. Der Wert ist null
für leere Slots, Reservierungsanzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.
googletag.events.SlotRequestedEvent
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
- Beispiel
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
googletag.events.SlotResponseReceived
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
googletag.events.SlotVisibilityChangedEvent
ErweitertAttribute | |
---|---|
in | Der Prozentsatz des sichtbaren Anzeigenbereichs. |
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, durch den das Ereignis ausgelöst wurde. Von |
- Beispiel
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
Attribute
inViewPercentage
inViewPercentage: number
Prozentsatz des sichtbaren Anzeigenbereichs. Der Wert ist eine Zahl zwischen 0 und 100.
googletag.secureSignals
Interfaces | |
---|---|
Bidder | Gibt ein sicheres Signal für einen bestimmten Bieter zurück. |
Publisher | Gibt ein sicheres Signal für einen bestimmten Publisher zurück. |
Secure | Eine Oberfläche zum Verwalten sicherer Signale. |
Typaliasse | |
---|---|
Secure | Benutzeroberfläche zum Zurückgeben eines sicheren Signals für einen bestimmten Bieter oder Anbieter. |
Typaliasse
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider
Benutzeroberfläche zum Zurückgeben eines sicheren Signals für einen bestimmten Bieter oder Anbieter. Du musst entweder id
oder networkCode
angeben, aber nicht beides.
googletag.secureSignals.BidderSignalProvider
Ein Anbieter sicherer Signale für Bieter besteht aus zwei Teilen:
- Eine Erfassungsfunktion, die eine
Promise
zurückgibt, die in ein sicheres Signal aufgelöst wird. - Ein
id
, der den mit dem Signal verknüpften Bieter identifiziert.
Attribute | |
---|---|
collector | Eine Funktion, die ein Promise zurückgibt, die in ein sicheres Signal aufgelöst wird. |
id | Eine eindeutige Kennung für den mit diesem sicheren Signal verknüpften Datensammler, wie in Google Ad Manager registriert. |
- Beispiel
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (alt)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Weitere Informationen
Attribute
collectorFunction
collectorFunction: (() => Promise<string>)
Eine Funktion, die ein Promise
zurückgibt, die in ein sicheres Signal aufgelöst wird.
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
Ein Anbieter von Publisher-Signalen besteht aus zwei Teilen:
- Eine Erfassungsfunktion, die eine
Promise
zurückgibt, die in ein sicheres Signal aufgelöst wird. - Eine
networkCode
, die den mit dem Signal verknüpften Publisher identifiziert.
Attribute | |
---|---|
collector | Eine Funktion, die ein Promise zurückgibt, das auf ein sicheres Signal verweist. |
network | 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 (alt)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Weitere Informationen
Attribute
collectorFunction
collectorFunction: (() => Promise<string>)
Eine Funktion, die ein Promise
zurückgibt, die in ein sicheres Signal aufgelöst wird.
networkCode
networkCode: string
Der Netzwerkcode (wie im Anzeigenblockpfad zu sehen) des Publishers, der mit diesem sicheren Signal verknüpft ist.
googletag.secureSignals.SecureSignalProvidersArray
Methoden | |
---|---|
clear | Löscht alle Signale für alle Collector aus dem Cache. |
push | Dem Signalanbieter-Array wird ein neuer secureSignals.SecureSignalProvider hinzugefügt und der Signalgenerierungsprozess wird gestartet. |
Methoden
clearAllCache
clearAllCache(): void
Löscht alle Signale für alle Collector aus dem Cache.
Durch Aufrufen dieser Methode wird die Wahrscheinlichkeit verringert, dass Signale in Anzeigenanfragen für die aktuellen und möglicherweise auch späteren Seitenaufrufe eingeschlossen werden. Daher sollte sie nur aufgerufen werden, wenn relevante Statusänderungen auftreten, z. B. Ereignisse, die auf einen neuen Nutzer hinweisen (Anmelden, Abmelden, Registrieren usw.).
Push
push(provider: SecureSignalProvider): void
Dem Signalanbieter-Array wird ein neuer secureSignals.SecureSignalProvider hinzugefügt und der Signalgenerierungsprozess wird gestartet.
Parameter | |
---|---|
provider: SecureSignalProvider | Das secureSignals.SecureSignalProvider-Objekt, das dem Array hinzugefügt werden soll. |