In dieser Referenz wird die TypeScript-Notation zur Beschreibung von Typen verwendet. Die folgende Tabelle enthält eine kurze Erläuterung anhand eines Beispiels.
Typausdruck | |
---|---|
string |
Der einfache Stringtyp. |
string[] |
Ein Arraytyp, bei dem Werte nur Strings sein können. |
number | string |
Ein Union-Typ, bei dem der Wert entweder eine Zahl oder ein String sein kann. |
Array<number | string> |
Ein Arraytyp, wobei die Werte ein komplexer Typ (Union) sind. |
[number, string] |
Ein Tupeltyp, bei dem der Wert ein Array mit zwei Elementen ist, das eine Zahl und einen String in dieser Reihenfolge enthalten muss. |
Slot |
Ein Objekttyp, bei dem der Wert eine Instanz von googletag.Slot ist. |
() => void |
Ein Funktionstyp ohne definierte Argumente und ohne Rückgabewert. |
Weitere Informationen zu unterstützten Typen und Typausdrücken finden Sie im TypeScript-Handbuch .
Anmerkungen eingeben
Ein Doppelpunkt nach einer Variablen, einem Parameternamen, einem Eigenschaftsnamen oder einer Funktionssignatur kennzeichnet eine Typanmerkung. Typanmerkungen beschreiben die Typen, die das Element links vom Doppelpunkt akzeptieren oder zurückgeben kann. Die folgende Tabelle enthält Beispiele für Typanmerkungen, die in dieser Referenz vorkommen können.
Anmerkung eingeben | |
---|---|
param: string |
Gibt an, dass param einen Stringwert annimmt oder zurückgibt. Diese Syntax wird für Variablen, Parameter, Eigenschaften und Rückgabetypen verwendet.
|
param?: number | string |
Gibt an, dass param optional ist, aber entweder eine Zahl oder ein String akzeptiert, sofern angegeben. Diese Syntax wird für Parameter und Eigenschaften verwendet.
|
...params: Array<() => void> |
Gibt an, dass params ein
REST-Parameter
ist, der Funktionen akzeptiert. Ruheparameter akzeptieren eine unbegrenzte Anzahl von Werten des angegebenen Typs.
|
Typdefinitionen
Typen | |
---|---|
|
SingleSize | MultiSize
|
Eine gültige Größenkonfiguration für eine Anzeigenfläche, die eine oder mehrere Größen sein kann. |
|
|
SingleSize[]
|
Eine Liste einzelner gültiger Größen. |
|
|
"fluid" | ["fluid"]
|
Benannte Größen, die eine Anzeigenfläche haben kann. In den meisten Fällen ist die Größe ein Rechteck mit fester Größe, es gibt aber Fälle, in denen wir andere Größenspezifikationen benötigen. Nur folgende benannte Größen sind gültig:
|
|
|
SingleSizeArray | NamedSize
|
Eine einzelne gültige Größe für eine Anzeigenfläche. |
|
|
[number, number]
|
Array aus zwei Zahlen für [Breite, Höhe]. |
|
|
[SingleSizeArray, GeneralSize]
|
Eine Zuordnung der Größe des Darstellungsbereichs zu den Anzeigengrößen. Wird für responsive Anzeigen verwendet. |
|
|
SizeMapping[]
|
Eine Liste von Größenzuordnungen. |
|
|
"unhideWindow" | "navBar"
|
Unterstützte Trigger für Interstitial-Anzeigen |
|
|
"disablePersonalization"
|
Unterstützte Datenschutzeinstellungen für Publisher. |
|
|
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
|
Unterstützte Taxonomien für vom Publisher bereitgestellte Signale |
|
|
BidderSignalProvider | PublisherSignalProvider
|
Schnittstelle zur Rückgabe eines sicheren Signals für einen bestimmten Bieter oder Anbieter Es muss entweder |
Enum-Typen
Enums | |
---|---|
googletag.enums.OutOfPageFormat
|
Von GPT unterstützte Out-of-Page-Formate
|
googletag.enums.TrafficSource
|
Besucherquellen, die von GPT unterstützt werden
|
googletag.enums.OutOfPageFormat
-
Von GPT unterstützte Out-of-Page-Formate
-
- Weitere Informationen
googletag.enums.TrafficSource
-
Besucherquellen, die von GPT unterstützt werden
-
- Weitere Informationen
googletag
Der globale Namespace, der vom Google Publisher-Tag für seine API verwendet wird
Variablenzusammenfassung | |
---|---|
apiReady
|
Angabe, dass die GPT API geladen wurde und aufgerufen werden kann
|
cmd
|
Referenz zur globalen Befehlswarteschlange für die asynchrone Ausführung von GPT-bezogenen Aufrufen
|
pubadsReady
|
Flag, das angibt, dass
PubAdsService aktiviert, geladen und voll funktionsfähig ist.
|
secureSignalProviders
|
Verweis auf das Array der Anbieter für sichere Signale.
|
Funktionsübersicht | |
---|---|
companionAds
|
Gibt einen Verweis auf
CompanionAdsService zurück.
|
defineOutOfPageSlot
|
Erstellt eine Out-of-Page-Anzeigenfläche mit dem angegebenen Anzeigenblockpfad.
|
defineSlot
|
Erstellt eine Anzeigenfläche mit einem bestimmten Anzeigenblockpfad und -größe und verknüpft sie mit der ID eines div-Elements auf der Seite, die die Anzeige enthalten soll.
|
destroySlots
|
Zerstört die angegebenen Anzeigenflächen und entfernt alle zugehörigen Objekte und Verweise dieser Flächen aus dem GPT.
|
disablePublisherConsole
|
Deaktiviert die Google Publisher Console.
|
display
|
Weist Slot-Dienste an, die Anzeigenfläche zu rendern.
|
enableServices
|
Aktiviert alle GPT-Dienste, die für Anzeigenflächen auf der Seite definiert wurden.
|
getVersion
|
Gibt die aktuelle Version von GPT zurück.
|
openConsole
|
Öffnet die Google Publisher Console.
|
pubads
|
Gibt einen Verweis auf
PubAdsService zurück.
|
setAdIframeTitle
|
Legt den Titel für alle von
PubAdsService erstellten Anzeigencontainer-iFrames fest.
|
setConfig
|
Legt allgemeine Konfigurationsoptionen für die Seite fest.
|
sizeMapping
|
Erstellt einen neuen
SizeMappingBuilder .
|
googletag.apiReady
-
apiReady: boolean | undefined
-
Angabe, dass die GPT API geladen wurde und aufgerufen werden kann Diese Eigenschaft lautet einfach
undefined
, bis die API bereit ist.
Wir empfehlen, für die Asynchronität die Verwendung von googletag.cmd zu verwenden, um Callbacks in die Warteschlange zu stellen, bis GPT bereit ist. Diese Callbacks müssen googletag.apiReady nicht überprüfen, da sie nach der Einrichtung der API garantiert ausgeführt werden. -
- Beispiel
-
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript (alt)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
TypeScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletag.cmd
-
cmd: Array<(this: typeof globalThis) => void> | CommandArray
-
Referenz zur globalen Befehlswarteschlange für die asynchrone Ausführung GPT-bezogener Aufrufe.
Die Variablegoogletag.cmd
wird über die GPT-Tag-Syntax auf der Seite für ein leeres JavaScript-Array initialisiert.cmd.push
ist die StandardmethodeArray.push
, mit der ein Element am Ende des Arrays hinzugefügt wird. Wenn das GPT-JavaScript geladen wird, durchsucht es das Array und führt alle Funktionen der Reihe nach aus. Das Skript ersetzt danncmd
durch einCommandArray
-Objekt, dessen Push-Methode so definiert ist, dass das an sie übergebene Funktionsargument ausgeführt wird. Dieser Mechanismus ermöglicht GPT, die empfundene Latenz zu verringern, indem das JavaScript asynchron abgerufen wird, während der Browser die Seite weiter rendern kann. -
- 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()); });
googletag.pubadsReady
-
pubadsReady: boolean | undefined
-
Flag, das angibt, dass
PubAdsService
aktiviert, geladen und voll funktionsfähig ist. Dieses Attribut lautet einfachundefined
, bisenableServices
aufgerufen undPubAdsService
geladen und initialisiert wird. -
googletag.secureSignalProviders
-
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
-
Verweis auf das Array der sicheren Signalanbieter.
Das Array der Anbieter von sicheren Signalen akzeptiert eine Abfolge von Signalgenerierungsfunktionen und ruft sie der Reihe nach auf. Damit soll ein Standardarray ersetzt werden, mit dem Signalgenerierungsfunktionen in die Warteschlange gestellt werden, die nach dem Laden des GPT aufgerufen werden. -
- 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
googletag.companionAds
-
companionAds(): CompanionAdsService
-
Gibt einen Verweis auf
CompanionAdsService
zurück. -
-
Rückgaben CompanionAdsService
Der Dienst „Companion-Anzeigen“.
googletag.defineOutOfPageSlot
-
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
-
Erstellt eine Out-of-Page-Anzeigenfläche mit dem angegebenen Anzeigenblockpfad.
Bei benutzerdefinierten Out-of-Page-Anzeigen istdiv
die ID des div-Elements, das die Anzeige enthält. Weitere Informationen finden Sie im Artikel zu Out-of-Page-Creatives.
Für GPT-verwaltete Out-of-Page-Anzeigen istdiv
ein unterstütztes OutOfPageFormat. -
- Beispiel
-
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (alt)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Weitere Informationen
-
Parameters adUnitPath: string
Vollständiger Anzeigenblockpfad mit Netzwerkcode und Anzeigenblockcodediv?: string | OutOfPageFormat
ID des div-Elements, das diesen Anzeigenblock oder „OutOfPageFormat“ enthalten soll. -
Rückgaben Slot | null
Den neu erstellten Slot odernull
, wenn kein Slot erstellt werden kann.
googletag.defineSlot
-
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
-
Erstellt eine Anzeigenfläche mit einem bestimmten Anzeigenblockpfad und -größe und verknüpft sie mit der ID eines div-Elements auf der Seite, die die Anzeige enthalten soll.
-
- Beispiel
-
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (alt)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Weitere Informationen
-
Parameters adUnitPath: string
Vollständiger Anzeigenblockpfad mit Netzwerkcode und Blockcodesize: GeneralSize
Breite und Höhe der hinzugefügten Anzeigenfläche. Diese Größe wird in der Anzeigenanfrage verwendet, wenn keine responsive Größenzuordnung vorhanden ist oder der Darstellungsbereich kleiner als die kleinste in der Zuordnung angegebene Größe ist.div?: string
ID des div-Elements, das diesen Anzeigenblock enthalten wird. -
Rückgaben Slot | null
Den neu erstellten Slot odernull
, wenn kein Slot erstellt werden kann.
googletag.destroySlots
-
destroySlots(slots?: Slot[]): boolean
-
Zerstört die angegebenen Anzeigenflächen und entfernt alle zugehörigen Objekte und Verweise dieser Flächen aus dem GPT. Diese API unterstützt keine Rücksendungsslots und Companion-Flächen.
Durch den Aufruf dieser API in einer Anzeigenfläche wird die Anzeige gelöscht und das Slotobjekt aus dem internen Zustand entfernt, der von GPT verwaltet wird. Der Aufruf weiterer Funktionen für das Slotobjekt führt zu einem nicht definierten Verhalten. Beachten Sie, dass der Browser den zu dieser Anzeigenfläche gehörenden Speicher möglicherweise dennoch nicht freigibt, wenn von der Publisher-Seite ein Verweis darauf bereitgestellt wird. Durch den Aufruf dieser API kann das mit dieser Fläche verknüpfte div-Element wiederverwendet werden.
Insbesondere, wenn eine Anzeigenfläche gelöscht wird, wird die Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt, sodass zukünftige Anfragen nicht von Hindernissen oder Konkurrenzausschlüssen beeinflusst werden, die diese Anzeige betreffen. Wenn diese Funktion nicht aufgerufen wird, bevor das div-Element einer Anzeigenfläche von der Seite entfernt wird, kommt es zu einem nicht definierten Verhalten. -
- Beispiel
-
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (alt)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
-
Parameters slots?: Slot[]
Das Array der zu löschenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht. -
Rückgaben boolean
true
, wenn Slots gelöscht wurden, andernfallsfalse
.
googletag.disablePublisherConsole
-
disablePublisherConsole(): void
-
Deaktiviert die Google Publisher Console.
-
- Weitere Informationen
googletag.display
-
display(divOrSlot: string | Element | Slot): void
-
Weist Slot-Dienste an, die Anzeigenfläche zu rendern. Jede Anzeigenfläche sollte nur einmal pro Seite angezeigt werden. Alle Anzeigenflächen müssen definiert und mit einem Dienst verknüpft sein, damit sie angezeigt werden können. Der Anzeigeaufruf darf erst erfolgen, wenn das Element im DOM vorhanden ist. Normalerweise platzieren Sie ihn in einem Skriptblock innerhalb des div-Elements, das im Methodenaufruf angegeben ist.
Wenn die Einzelanfrage-Architektur verwendet wird, werden alle nicht abgerufenen Anzeigenflächen zum Zeitpunkt des Aufrufs dieser Methode auf einmal abgerufen. Um zu erzwingen, dass eine Anzeigenfläche nicht angezeigt wird, muss das gesamte div-Element entfernt werden. -
- Beispiel
-
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript (alt)
googletag.cmd.push(function () { googletag.display("div-1"); });
TypeScript
googletag.cmd.push(() => { googletag.display("div-1"); });
- Weitere Informationen
-
Parameters divOrSlot: string | Element | Slot
Entweder die ID des div-Elements, das die Anzeigenfläche enthält, des div-Elements oder des Flächenobjekts. Wenn ein „div“-Element angegeben wird, muss es ein „id“-Attribut haben, das mit der andefineSlot
übergebenen ID übereinstimmt.
googletag.enableServices
-
enableServices(): void
-
Aktiviert alle GPT-Dienste, die für Anzeigenflächen auf der Seite definiert wurden.
-
googletag.getVersion
-
getVersion(): string
-
Gibt die aktuelle Version von GPT zurück.
-
- Weitere Informationen
-
Rückgaben string
Der derzeit ausgeführte GPT-Versionsstring
googletag.openConsole
-
openConsole(div?: string): void
-
Öffnet die Google Publisher Console.
-
- Beispiel
-
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (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
-
Parameters div?: string
Eine div-ID der Anzeigenfläche. Dieser Wert ist optional. Wenn dies der Fall ist, versucht die Publisher Console, die Anzeige mit Details zur angegebenen Anzeigenfläche zu öffnen.
googletag.pubads
-
pubads(): PubAdsService
-
Gibt einen Verweis auf
PubAdsService
zurück. -
-
Rückgaben PubAdsService
Publisher-Anzeigen
googletag.setAdIframeTitle
-
setAdIframeTitle(title: string): void
-
Legt den Titel für alle von
PubAdsService
erstellten Anzeigencontainer-iFrames fest. -
- Beispiel
-
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (alt)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
-
Parameters title: string
Der neue Titel für alle Anzeigencontainer-iFrames.
googletag.setConfig
-
setConfig(config: PageSettingsConfig): void
-
Legt allgemeine Konfigurationsoptionen für die Seite fest.
-
-
Parameters config: PageSettingsConfig
googletag.sizeMapping
-
sizeMapping(): SizeMappingBuilder
-
Erstellt einen neuen
SizeMappingBuilder
. -
- Weitere Informationen
-
Rückgaben SizeMappingBuilder
Ein neuer Builder.
googletag.CommandArray
Das Befehlsarray akzeptiert eine Reihe von Funktionen und ruft diese der Reihe nach auf. Damit soll ein Standardarray ersetzt werden, mit dem Funktionen in die Warteschlange gestellt werden, die nach dem Laden des GPT aufgerufen werden sollen.
Methodenzusammenfassung | |
---|---|
push
|
Führt die Reihenfolge der Funktionen aus, die in den Argumenten angegeben sind.
|
push
-
push(...f: Array<(this: typeof globalThis) => void>): number
-
Führt die Reihenfolge der Funktionen aus, die in den Argumenten angegeben sind.
-
- 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()); });
-
Parameters ...f: Array<(this: typeof globalThis) => void>
Eine auszuführende JavaScript-Funktion. Die Laufzeitbindung ist immerglobalThis
. Sie können eine Pfeilfunktion übergeben, um denthis
-Wert des einschließenden lexikalen Kontextes beizubehalten. -
Rückgaben number
Die Anzahl der bisher verarbeiteten Befehle. Dies ist mit dem Rückgabewert vonArray.push
(der aktuellen Länge des Arrays) kompatibel.
googletag.CompanionAdsService
Erweitert
Companion-Anzeigendienst. Dieser Dienst wird von Videoanzeigen zum Einblenden von Companion-Anzeigen verwendet.
Methodenzusammenfassung | |
---|---|
addEventListener
|
Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt.
Von „
|
getSlots
|
Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
Von „
|
removeEventListener
|
Entfernt einen zuvor registrierten Listener.
Von „
|
setRefreshUnfilledSlots
|
Legt fest, ob nicht gefüllte Companion-Flächen automatisch aufgefüllt werden.
|
- Weitere Informationen
setRefreshUnfilledSlots
-
setRefreshUnfilledSlots(value: boolean): void
-
Legt fest, ob nicht gefüllte Companion-Flächen automatisch aufgefüllt werden.
Diese Methode kann während der Lebensdauer der Seite mehrmals aufgerufen werden, um den Backfill ein- und auszuschalten. Nur Anzeigenflächen, die auch mitPubAdsService
registriert sind, werden aufgefüllt. Aufgrund von richtlinienbedingten Einschränkungen ist diese Methode nicht dafür ausgelegt, leere Companion-Flächen bei der Auslieferung eines Ad Exchange-Videos zu füllen. -
- Beispiel
-
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (alt)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
-
Parameters value: boolean
true
, um nicht gefüllte Anzeigenflächen automatisch aufzufüllen,false
, um sie unverändert zu lassen.
googletag.PrivacySettingsConfig
Konfigurationsobjekt für Datenschutzeinstellungen.
Property-Zusammenfassung | |
---|---|
childDirectedTreatment
|
Gibt an, ob die Seite als „Für Kinder“ eingestuft werden soll.
|
limitedAds
|
Mit dieser Option wird die Auslieferung im Modus Eingeschränkte Anzeigenausrichtung aktiviert, um Publisher bei der Einhaltung gesetzlicher Vorschriften zu unterstützen.
|
nonPersonalizedAds
|
Mit dieser Option wird die Auslieferung im Modus für nicht personalisierte Anzeigen aktiviert, um die gesetzlichen Anforderungen des Publishers zu erfüllen.
|
restrictDataProcessing
|
Ermöglicht die Bereitstellung im Modus mit eingeschränkter Verarbeitung, um die Einhaltung gesetzlicher Vorschriften für Publisher zu erleichtern.
|
trafficSource
|
Gibt an, ob Anfragen gekauften oder organischen Traffic betreffen.
|
underAgeOfConsent
|
Mit dieser Spalte wird angegeben, ob Anzeigenanfragen von Nutzern als minderjährig gekennzeichnet werden sollen.
|
- Weitere Informationen
childDirectedTreatment
-
childDirectedTreatment: null | boolean
-
Gibt an, ob die Seite als „Für Kinder“ eingestuft werden soll. Legen Sie
null
fest, um die Konfiguration zu löschen. -
limitedAds
-
limitedAds: boolean
-
Mit dieser Option wird die Auslieferung im Modus Eingeschränkte Anzeigenausrichtung aktiviert, um Publisher bei der Einhaltung gesetzlicher Vorschriften zu unterstützen. Wenn diese Option aktiviert ist, kann die GPT-Bibliothek selbst optional über eine URL mit eingeschränkter Anzeigenausrichtung ohne Cookies angefordert werden.
-
- Weitere Informationen
nonPersonalizedAds
-
nonPersonalizedAds: boolean
-
Mit dieser Option wird die Auslieferung im Modus für nicht personalisierte Anzeigen aktiviert, um die gesetzlichen Anforderungen des Publishers zu erfüllen.
-
restrictDataProcessing
-
restrictDataProcessing: boolean
-
Ermöglicht die Bereitstellung im Modus mit eingeschränkter Verarbeitung, um die Einhaltung gesetzlicher Vorschriften für Publisher zu erleichtern.
-
trafficSource
-
trafficSource: TrafficSource
-
Gibt an, ob Anfragen gekauften oder organischen Traffic betreffen. Dieser Wert wird in der Ad Manager-Berichterstellung für die Dimension Zugriffsquelle verwendet. Wenn die Richtlinie nicht konfiguriert ist, wird in Berichten standardmäßig
undefined
verwendet. -
- Beispiel
-
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (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, });
underAgeOfConsent
-
underAgeOfConsent: null | boolean
-
Mit dieser Spalte wird angegeben, ob Anzeigenanfragen von Nutzern als minderjährig gekennzeichnet werden sollen. Legen Sie
null
fest, um die Konfiguration zu löschen. -
googletag.PubAdsService
Erweitert
für Publisher-Anzeigen. Mit diesem Dienst werden Anzeigen aus Ihrem Google Ad Manager-Konto abgerufen und ausgeliefert.
Methodenzusammenfassung | |
---|---|
addEventListener
|
Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt.
Von „
|
clear
|
Entfernt die Anzeigen aus den angegebenen Anzeigenflächen und ersetzt sie durch leere Inhalte.
|
clearCategoryExclusions
|
Löscht alle Ausschlusslabels für Anzeigenkategorien auf Seitenebene.
|
clearTargeting
|
Löscht benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel.
|
collapseEmptyDivs
|
Ermöglicht das Minimieren von Slot-Divs, damit sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt vorhanden ist.
|
disableInitialLoad
|
Deaktiviert Anzeigenanfragen beim Seitenaufbau, ermöglicht jedoch, Anzeigen über einen
PubAdsService.refresh -Aufruf anzufordern.
|
display
|
Erstellt eine Anzeigenfläche mit dem angegebenen Anzeigenblockpfad und der angegebenen Größe und zeigt diese an.
|
enableLazyLoad
|
Aktiviert das vom Konfigurationsobjekt definierte Lazy Loading in GPT.
|
enableSingleRequest
|
Aktiviert den Einzelanfragemodus zum gleichzeitigen Abrufen mehrerer Anzeigen.
|
enableVideoAds
|
Teilt GPT mit, dass Videoanzeigen auf der Seite vorhanden sind.
|
get
|
Gibt den Wert für das AdSense-Attribut zurück, das dem angegebenen Schlüssel zugeordnet ist
|
getAttributeKeys
|
Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden
|
getSlots
|
Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
Von „
|
getTargeting
|
Gibt einen bestimmten benutzerdefinierten Targeting-Parameter auf Dienstebene zurück, der festgelegt wurde
|
getTargetingKeys
|
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden.
|
isInitialLoadDisabled
|
Gibt zurück, ob die ersten Anzeigenanfragen bei einem vorherigen
PubAdsService.disableInitialLoad -Aufruf deaktiviert wurden.
|
refresh
|
Ruft neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite ab und zeigt sie an.
|
removeEventListener
|
Entfernt einen zuvor registrierten Listener.
Von „
|
set
|
Legt Werte für AdSense-Attribute fest, die für alle Anzeigenflächen unter dem Publisher Ads-Dienst gelten.
|
setCategoryExclusion
|
Legt einen Ausschluss von Anzeigenkategorien auf Seitenebene für den angegebenen Labelnamen fest.
|
setCentering
|
Aktiviert und deaktiviert die horizontale Zentrierung von Anzeigen.
|
setForceSafeFrame
|
Mit dieser Richtlinie wird festgelegt, ob das Rendering aller Anzeigen auf der Seite über einen SafeFrame-Container erzwungen werden soll.
|
setLocation
|
Gibt Standortinformationen von Websites weiter, sodass Sie Werbebuchungen per geografischem Targeting auf bestimmte Standorte ausrichten können.
|
setPrivacySettings
|
Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzelne API mithilfe eines Konfigurationsobjekts.
|
setPublisherProvidedId
|
Legt den Wert für die vom Publisher bereitgestellte ID fest.
|
setSafeFrameConfig
|
Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest.
|
setTargeting
|
Legt benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel fest, die für alle Anzeigenflächen des Publisher Ads-Dienstes gelten.
|
setVideoContent
|
Legt die Informationen zum Videocontent fest, die zusammen mit den Anzeigenanfragen für das Targeting und für auszuschließende Inhalte gesendet werden sollen.
|
updateCorrelator
|
Ändert den Korrelator, der mit den Anzeigenanfragen gesendet wird, sodass fälschlicherweise ein neuer Seitenaufruf gestartet wird.
|
clear
-
clear(slots?: Slot[]): boolean
-
Entfernt die Anzeigen aus den angegebenen Anzeigenflächen und ersetzt sie durch leere Inhalte. Die Anzeigenflächen werden als nicht abgerufen gekennzeichnet.
Insbesondere wird die Anzeige durch das Löschen einer Anzeigenfläche aus dem langlebigen Seitenaufruf des GPT entfernt, sodass zukünftige Anfragen nicht durch Hindernisse oder Konkurrenzausschlüsse dieser Anzeige beeinflusst werden. -
- Beispiel
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (alt)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
-
Parameters slots?: Slot[]
Das Array der zu löschenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht. -
Rückgaben boolean
Gibttrue
zurück, wenn Slots gelöscht wurden. Andernfalls wirdfalse
zurückgegeben.
clearCategoryExclusions
-
clearCategoryExclusions(): PubAdsService
-
Löscht alle Ausschlusslabels für Anzeigenkategorien auf Seitenebene. Dies ist nützlich, wenn Sie die Anzeigenfläche aktualisieren möchten.
-
- Beispiel
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (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
-
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
clearTargeting
-
clearTargeting(key?: string): PubAdsService
-
Löscht benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel.
-
- 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
-
Parameters key?: string
Schlüssel für Targeting-Parameter. Der Schlüssel ist optional. Falls er nicht angegeben ist, werden alle Targeting-Parameter gelöscht. -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
collapseEmptyDivs
-
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
-
Ermöglicht das Minimieren von Slot-Divs, damit sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt vorhanden ist. Dieser Modus muss vor der Aktivierung des Dienstes festgelegt werden.
-
- Weitere Informationen
-
Parameters collapseBeforeAdFetch?: boolean
Gibt an, ob die Anzeigenflächen minimiert werden sollen, bevor die Anzeigen abgerufen wurden. Dieser Parameter ist optional. Wenn er nicht angegeben wird, wirdfalse
als Standardwert verwendet. -
Rückgaben boolean
Gibttrue
zurück, wenn der Div-Minimierungsmodus aktiviert war, undfalse
, wenn der Minimierungsmodus nicht aktiviert werden kann, weil die Methode aufgerufen wurde, nachdem der Dienst aktiviert wurde.
disableInitialLoad
-
disableInitialLoad(): void
-
Deaktiviert Anzeigenanfragen beim Seitenaufbau, ermöglicht jedoch, Anzeigen über einen
PubAdsService.refresh
-Aufruf anzufordern. Diese sollte vor dem Aktivieren des Dienstes festgelegt werden. Es muss der asynchrone Modus verwendet werden. Andernfalls ist es nicht möglich, Anzeigen mitrefresh
anzufordern. -
- Weitere Informationen
display
-
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
-
Erstellt eine Anzeigenfläche mit dem angegebenen Anzeigenblockpfad und der angegebenen Größe und zeigt diese an. Diese Methode funktioniert nicht im Einzelanfragemodus.
Hinweis:Wenn diese Methode aufgerufen wird, wird ein Snapshot der Anzeigenfläche und des Seitenstatus erstellt, um Konsistenz beim Senden der Anzeigenanfrage und beim Rendern der Antwort zu gewährleisten. Alle Änderungen, die nach dem Aufruf dieser Methode an der Anzeigenfläche oder dem Seitenstatus vorgenommen werden (einschließlich Targeting, Datenschutzeinstellungen, SafeFrame erzwingen usw.), gelten nur für nachfolgendedisplay()
- oderrefresh()
-Anfragen. -
- Beispiel
-
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (alt)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- Weitere Informationen
-
Parameters adUnitPath: string
Der Anzeigenblockpfad der Anzeigenfläche, die gerendert werden soll.size: GeneralSize
Breite und Höhe der Anzeigenfläche.div?: string | Element
Entweder die ID des div-Elements mit der Anzeigenfläche oder das div-Element selbst.clickUrl?: string
Die Klick-URL, die in dieser Anzeigenfläche verwendet werden soll.
enableLazyLoad
-
enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void
-
Aktiviert das vom Konfigurationsobjekt definierte Lazy Loading in GPT. Ausführlichere Beispiele finden Sie im Beispiel Lazy Loading.
Hinweis:Lazy Loading in der SRA funktioniert nur, wenn sich alle Slots außerhalb des Abrufrands befinden. -
- Beispiel
-
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (alt)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Weitere Informationen
-
Parameters config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
Mit dem Konfigurationsobjekt kann ein verzögertes Verhalten angepasst werden. Für ausgelassene Konfigurationen wird eine von Google festgelegte Standardeinstellung verwendet, die im Laufe der Zeit angepasst wird. Wenn Sie eine bestimmte Einstellung deaktivieren möchten, z. B. einen Abrufrand, setzen Sie den Wert auf-1
.fetchMarginPercent
Die Mindestentfernung zum aktuellen Darstellungsbereich, die eine Anzeigenfläche einnehmen muss, bevor die Anzeige als Prozentsatz der Größe des Darstellungsbereichs abgerufen wird. Ein Wert von 0 bedeutet „wenn die Anzeigenfläche in den Darstellungsbereich aufgenommen wird“, 100 bedeutet „wenn die Anzeige noch um einen Darstellungsbereich entfernt ist“ und so weiter.renderMarginPercent
Der Mindestabstand einer Anzeigenfläche zum aktuellen Darstellungsbereich muss eingehalten werden, bevor eine Anzeige gerendert wird. So kann die Anzeige vorab abgerufen werden, aber erst mit dem Rendering und dem Herunterladen weiterer Unterressourcen. Der Wert funktioniert wiefetchMarginPercent
als Prozentsatz des Darstellungsbereichs.mobileScaling
Ein Multiplikator, der auf die Ränder auf Mobilgeräten angewendet wird. Dadurch sind auf Mobilgeräten und Computern unterschiedliche Ränder möglich. 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 einer Anzeigenfläche erhöht wird.
enableSingleRequest
-
enableSingleRequest(): boolean
-
Aktiviert den Einzelanfragemodus zum gleichzeitigen Abrufen mehrerer Anzeigen. Dazu müssen alle Publisher-Anzeigenflächen definiert und dem PubAdsService hinzugefügt werden, bevor der Dienst aktiviert wird. Der Einzelanfragemodus muss festgelegt werden, bevor der Dienst aktiviert wird.
-
Rückgaben boolean
Gibttrue
zurück, wenn der Einzelanfragemodus aktiviert war, undfalse
, wenn der Einzelanfragemodus nicht aktiviert werden kann, weil die Methode aufgerufen wurde, nachdem der Dienst aktiviert wurde.
enableVideoAds
-
enableVideoAds(): void
-
Teilt GPT mit, dass Videoanzeigen auf der Seite vorhanden sind. Dies ermöglicht Konkurrenzausschluss-Einschränkungen für Display- und Videoanzeigen. Wenn der Videoinhalt bekannt ist, rufen Sie
PubAdsService.setVideoContent
auf, um auszuschließende Inhalte für Displayanzeigen verwenden zu können. -
get
-
get(key: string): null | string
-
Gibt den Wert für das AdSense-Attribut zurück, das dem angegebenen Schlüssel zugeordnet ist
-
- Beispiel
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Weitere Informationen
-
Parameters key: string
Name des Attributs, nach dem gesucht wird. -
Rückgaben null | string
Aktueller Wert für den Attributschlüssel odernull
, wenn der Schlüssel nicht vorhanden ist.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden
-
- Beispiel
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Rückgaben string[]
Array mit Attributschlüsseln, die für diesen Dienst festgelegt wurden. Die Reihenfolge ist nicht definiert.
getTargeting
-
getTargeting(key: string): string[]
-
Gibt einen bestimmten benutzerdefinierten Targeting-Parameter auf Dienstebene zurück, der festgelegt wurde
-
- Beispiel
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (alt)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
-
Parameters key: string
Der Targeting-Schlüssel, nach dem gesucht werden soll. -
Rückgaben string[]
Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn kein solcher Schlüssel vorhanden ist
getTargetingKeys
-
getTargetingKeys(): string[]
-
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden.
-
- 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'].
-
Rückgaben string[]
Array mit Targeting-Schlüsseln Die Reihenfolge ist nicht definiert.
isInitialLoadDisabled
-
isInitialLoadDisabled(): boolean
-
Gibt zurück, ob die ersten Anzeigenanfragen bei einem vorherigen
PubAdsService.disableInitialLoad
-Aufruf deaktiviert wurden. -
-
Rückgaben boolean
Gibttrue
zurück, wenn ein vorheriger Aufruf anPubAdsService.disableInitialLoad
erfolgreich war. Andernfalls wirdfalse
zurückgegeben.
refresh
-
refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void
-
Ruft neue Anzeigen für bestimmte oder alle Anzeigenflächen auf der Seite ab und zeigt sie an. Funktioniert nur im asynchronen Renderingmodus.
Damit das Verhalten in allen Browsern richtig funktioniert, muss dem Aufrufen vonrefresh
ein Aufruf vondisplay
der Anzeigenfläche vorausgehen. Wenn der Aufruf vondisplay
weggelassen wird, kann bei der Aktualisierung ein unerwartetes Verhalten auftreten. Bei Bedarf kann die MethodePubAdsService.disableInitialLoad
verwendet werden, um zu verhindern, dassdisplay
eine Anzeige abruft.
Durch das Aktualisieren einer Anzeigenfläche wird die alte Anzeige aus dem langlebigen Seitenaufruf der GPTs entfernt, sodass zukünftige Anfragen nicht von Hindernissen oder Konkurrenzausschlüssen beeinflusst werden, die diese Anzeige betreffen. -
- Beispiel
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (alt)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Weitere Informationen
-
Parameters slots?: null | Slot[]
Die zu aktualisierenden Slots. Das Array ist optional. Alle Slots werden aktualisiert, wenn es nicht angegeben ist.options?: { changeCorrelator: boolean }
Konfigurationsoptionen, die mit diesem Aktualisierungsaufruf verknüpft sind.changeCorrelator
Gibt an, ob ein neuer Korrelator zum Abrufen von Anzeigen generiert werden soll. Auf unseren Ad-Servern wird dieser Korrelatorwert kurzzeitig (aktuell für 30 Sekunden, aber Änderungen vorbehalten) beibehalten, sodass Anfragen mit demselben Korrelator, die kurz nacheinander eingehen, als einzelner Seitenaufruf gezählt werden. Standardmäßig wird bei jeder Aktualisierung ein neuer Korrelator generiert.
Hinweis:Diese Option hat keine Auswirkungen auf den langlebigen Seitenaufruf von GPT, bei dem automatisch die aktuell auf der Seite befindlichen Anzeigen wiedergegeben werden und keine Ablaufzeit vorliegt.
set
-
set(key: string, value: string): PubAdsService
-
Legt Werte für AdSense-Attribute fest, die für alle Anzeigenflächen unter dem Publisher-Anzeigendienst gelten.
Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen festgelegt werden, bevordisplay
oderrefresh
aufgerufen werden. -
- 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
-
Parameters key: string
Der Name des Attributs.value: string
Attributwert. -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): PubAdsService
-
Legt einen Ausschluss von Anzeigenkategorien auf Seitenebene für den angegebenen Labelnamen fest.
-
- Beispiel
-
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (alt)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Weitere Informationen
-
Parameters categoryExclusion: string
Das hinzuzufügende Label zum Ausschließen von Anzeigenkategorien -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
setCentering
-
setCentering(centerAds: boolean): void
-
Aktiviert und deaktiviert die horizontale Zentrierung von Anzeigen. Die Zentrierung ist standardmäßig deaktiviert. In der alten Version von gpt_mobile.js ist die Zentrierung standardmäßig aktiviert.
Diese Methode sollte vor dem Aufruf vondisplay
oderrefresh
aufgerufen werden, da nur Anzeigen zentriert werden, die nach dem Aufrufen dieser Methode angefordert werden. -
- Beispiel
-
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (alt)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
-
Parameters centerAds: boolean
true
, um Anzeigen zu zentrieren,false
, um sie linksbündig auszurichten.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
-
Konfiguriert, ob das Rendering aller Anzeigen auf der Seite über einen SafeFrame-Container erzwungen werden soll.
Bei der Verwendung dieser API ist Folgendes zu beachten:- Diese Einstellung wird nur bei nachfolgenden Anzeigenanfragen für die entsprechenden Anzeigenflächen wirksam.
- Sofern angegeben, überschreibt die Einstellung auf Anzeigenflächenebene immer die Einstellung auf Seitenebene.
- Wenn der Wert auf
true
(auf Anzeigenflächen- oder Seitenebene) festgelegt ist, wird die Anzeige immer mit einem SafeFrame-Container gerendert, unabhängig von der Auswahl, die auf der Google Ad Manager-Benutzeroberfläche getroffen wurde. - Wenn die Richtlinie auf
false
gesetzt oder nicht angegeben ist, wird die Anzeige abhängig vom Creative-Typ und der auf der Google Ad Manager-Benutzeroberfläche getroffenen Auswahl mit einem SafeFrame-Container gerendert. - Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken könnte, die versuchen, ihre iFrames zu durchbrechen, oder darauf angewiesen sind, dass sie direkt auf einer Publisher-Seite gerendert werden.
-
- Beispiel
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (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
-
Parameters forceSafeFrame: boolean
true
, um zu erzwingen, dass alle Anzeigen auf der Seite in SafeFrames gerendert werden, undfalse
, um die vorherige Einstellung auf „false“ zu setzen. Wenn Sie hierfalse
festlegen, wenn Sie nichts angegeben haben, ändert sich nichts. -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Funktion aufgerufen wurde.
setLocation
-
setLocation(address: string): PubAdsService
-
Gibt Standortinformationen von Websites weiter, sodass Sie Werbebuchungen per geografischem Targeting auf bestimmte Standorte ausrichten können.
-
- Beispiel
-
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (alt)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
-
Parameters address: string
Adresse im freien Format. -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
setPrivacySettings
-
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
-
Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzelne API mithilfe eines Konfigurationsobjekts.
-
- Beispiel
-
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (alt)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- Weitere Informationen
-
Parameters privacySettings: PrivacySettingsConfig
Objekt mit Konfiguration der Datenschutzeinstellungen. -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Funktion aufgerufen wurde.
setPublisherProvidedId
-
setPublisherProvidedId(ppid: string): PubAdsService
-
Legt den Wert für die vom Publisher bereitgestellte ID fest.
-
- Beispiel
-
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (alt)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Weitere Informationen
-
Parameters ppid: string
Eine alphanumerische ID, die vom Publisher bereitgestellt wird. Muss zwischen 32 und 150 Zeichen lang sein. -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
setSafeFrameConfig
-
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
-
Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest. Nicht erkannte Schlüssel im Konfigurationsobjekt werden ignoriert. Die gesamte Konfiguration wird ignoriert, wenn für einen erkannten Schlüssel ein ungültiger Wert übergeben wird.
Diese Einstellungen auf Seitenebene werden gegebenenfalls durch Einstellungen auf Anzeigenflächenebene überschrieben. -
- 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
-
Parameters config: SafeFrameConfig
Das Konfigurationsobjekt. -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
setTargeting
-
setTargeting(key: string, value: string | string[]): PubAdsService
-
Legt benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel fest, die für alle Anzeigenflächen des Publisher Ads-Dienstes gelten. Durch mehrfaches Aufrufen für denselben Schlüssel werden alte Werte überschrieben. Diese Schlüssel sind in Ihrem Google Ad Manager-Konto definiert.
-
- Beispiel
-
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (alt)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Weitere Informationen
-
Parameters key: string
Schlüssel für Targeting-Parameter.value: string | string[]
Wert des Targeting-Parameters oder Array von Werten -
Rückgaben PubAdsService
Das Dienstobjekt, über das die Methode aufgerufen wurde.
setVideoContent
-
setVideoContent(videoContentId: string, videoCmsId: string): void
-
Legt die Informationen zum Videocontent fest, die zusammen mit den Anzeigenanfragen für das Targeting und für auszuschließende Inhalte gesendet werden sollen. Videoanzeigen werden beim Aufruf dieser Methode automatisch aktiviert. Verwenden Sie für
videoContentId
undvideoCmsId
die Werte, die dem Google Ad Manager-Contentaufnahmedienst bereitgestellt werden. -
- Weitere Informationen
-
Parameters videoContentId: string
Die Video-Content-ID.videoCmsId: string
Die CMS-ID des Videos.
updateCorrelator
-
updateCorrelator(): PubAdsService
-
Ändert den Korrelator, der mit den Anzeigenanfragen gesendet wird, sodass fälschlicherweise ein neuer Seitenaufruf gestartet wird. Der Korrelator ist für alle Anzeigenanfragen, die von einem Seitenaufruf stammen, identisch und für alle Seitenaufrufe eindeutig. Gilt nur für den asynchronen Modus.
Hinweis: Dies hat keine Auswirkungen auf den langlebigen Seitenaufruf von GPT, bei dem automatisch die tatsächlichen Anzeigen auf der Seite wiedergegeben werden und keine Ablaufzeit vorliegt. -
- 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.
-
Rückgaben PubAdsService
Das Dienstobjekt, über das die Funktion aufgerufen wurde.
googletag.ResponseInformation
Ein Objekt, das eine einzelne Anzeigenantwort darstellt.
Property-Zusammenfassung | |
---|---|
advertiserId
|
Die ID des Werbetreibenden.
|
campaignId
|
Die ID der Kampagne.
|
creativeId
|
Die ID des Creatives.
|
creativeTemplateId
|
Die Vorlagen-ID der Anzeige.
|
lineItemId
|
ID der Position
|
- Weitere Informationen
advertiserId
-
advertiserId: null | number
-
Die ID des Werbetreibenden.
-
campaignId
-
campaignId: null | number
-
Die ID der Kampagne.
-
creativeId
-
creativeId: null | number
-
Die ID des Creatives.
-
creativeTemplateId
-
creativeTemplateId: null | number
-
Die Vorlagen-ID der Anzeige.
-
lineItemId
-
lineItemId: null | number
-
ID der Position
-
googletag.RewardedPayload
Ein Objekt, das die Prämie darstellt, die einer Anzeige mit Prämie zugewiesen ist
Property-Zusammenfassung | |
---|---|
amount
|
Die Anzahl der Artikel, die in der Prämie enthalten sind.
|
type
|
Der in der Prämie enthaltene Artikeltyp, z. B. „Münze“.
|
- Weitere Informationen
amount
-
amount: number
-
Die Anzahl der Artikel, die in der Prämie enthalten sind.
-
type
-
type: string
-
Der in der Prämie enthaltene Artikeltyp, z. B. „Münze“.
-
googletag.SafeFrameConfig
Konfigurationsobjekt für SafeFrame-Container
Property-Zusammenfassung | |
---|---|
allowOverlayExpansion
|
Legt fest, ob SafeFrame die Maximierung von Anzeigencontent durch überlagernde Seiteninhalte zulassen soll.
|
allowPushExpansion
|
Legt fest, ob in SafeFrame Anzeigencontent durch Übertragen von Seitencontent maximiert werden kann.
|
sandbox
|
Legt fest, ob SafeFrame das HTML5-Sandbox-Attribut verwenden soll, um die Navigation der obersten Ebene ohne Nutzerinteraktion zu verhindern.
|
useUniqueDomain
|
Veraltet.
Gibt an, ob SafeFrame zufällig ausgewählte Subdomains für Reservierungs-Creatives verwenden soll
|
- Weitere Informationen
allowOverlayExpansion
-
allowOverlayExpansion: boolean
-
Legt fest, ob SafeFrame die Maximierung von Anzeigencontent durch überlagernde Seiteninhalte zulassen soll.
-
allowPushExpansion
-
allowPushExpansion: boolean
-
Legt fest, ob in SafeFrame Anzeigencontent durch Übertragen von Seitencontent maximiert werden kann.
-
sandbox
-
sandbox: boolean
-
Legt fest, ob SafeFrame das HTML5-Sandbox-Attribut verwenden soll, um die Navigation der obersten Ebene ohne Nutzerinteraktion zu verhindern. Der einzige gültige Wert ist
true
und kann nicht alsfalse
erzwungen werden. Beachten Sie, dass durch das Attribut "sandbox" Plug-ins deaktiviert werden (z.B. Flash). -
useUniqueDomain
-
useUniqueDomain: null | boolean
-
Gibt an, ob SafeFrame zufällig ausgewählte Subdomains für Reservierungs-Creatives verwenden soll Übergeben Sie
null
, um den gespeicherten Wert zu löschen.
Hinweis: Diese Funktion ist standardmäßig aktiviert. -
- Weitere Informationen
googletag.Service
Basisdienstklasse, die Methoden enthält, die für alle Dienste verwendet werden.
Methodenzusammenfassung | |
---|---|
addEventListener
|
Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt.
|
getSlots
|
Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind.
|
removeEventListener
|
Entfernt einen zuvor registrierten Listener.
|
addEventListener
-
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (arg: EventTypeMap[K]) => void): Service
-
Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt. Die folgenden Ereignisse werden unterstützt:
Ein Objekt des entsprechenden Ereignistyps wird beim Aufruf an den Listener übergeben. -
- Beispiel
-
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (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
-
Parameters eventType: K
Ein String, der den Typ des von GPT generierten Ereignisses darstellt. Bei Ereignistypen wird zwischen Groß- und Kleinschreibung unterschieden.listener: (arg: EventTypeMap[K]) => void
Funktion, die ein einzelnes Argument für das Ereignisobjekt annimmt. -
Rückgaben Service
Das Dienstobjekt, über das die Methode aufgerufen wurde.
getSlots
removeEventListener
-
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void
-
Entfernt einen zuvor registrierten Listener.
-
- Beispiel
-
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (alt)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
-
Parameters eventType: K
Ein String, der den Typ des von GPT generierten Ereignisses darstellt. Bei Ereignistypen wird zwischen Groß- und Kleinschreibung unterschieden.listener: (event: EventTypeMap[K]) => void
Funktion, die ein einzelnes Argument für das Ereignisobjekt annimmt.
googletag.SizeMappingBuilder
Generator für Objekte mit Größenzuordnungsspezifikationen. Dieser Builder wird zur Verfügung gestellt, um Ihnen die Erstellung von Größenspezifikationen zu erleichtern.
Methodenzusammenfassung | |
---|---|
addSize
|
Fügt eine Zuordnung von einem Array mit einer Größe (das den Darstellungsbereich darstellt) zu einem Array mit einer oder mehreren Größen hinzu, das die Anzeigenfläche darstellt.
|
build
|
Erstellt eine Größenkartenspezifikation aus den Zuordnungen, die diesem Builder hinzugefügt wurden.
|
- Weitere Informationen
addSize
-
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
-
Fügt eine Zuordnung von einem Array mit einer Größe (das den Darstellungsbereich darstellt) zu einem Array mit einer oder mehreren Größen hinzu, das die Anzeigenfläche darstellt.
-
- Beispiel
-
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (alt)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
-
Parameters viewportSize: SingleSizeArray
Die Größe des Darstellungsbereichs für diesen Zuordnungseintrag.slotSize: GeneralSize
Die Größen der Anzeigenfläche für diesen Zuordnungseintrag. -
Rückgaben SizeMappingBuilder
Eine Referenz zu diesem Builder.
build
-
build(): null | SizeMappingArray
-
Erstellt eine Größenkartenspezifikation aus den Zuordnungen, die diesem Builder hinzugefügt wurden.
Wenn ungültige Zuordnungen angegeben wurden, gibt diese Methodenull
zurück. Andernfalls wird eine Spezifikation im richtigen Format zurückgegeben, die anSlot.defineSizeMapping
übergeben werden muss.
Hinweis: Das Verhalten des Builders nach Aufruf dieser Methode ist nicht definiert. -
-
Rückgaben null | SizeMappingArray
Das von diesem Builder erstellte Ergebnis. Kann null sein, wenn ungültige Größenzuordnungen angegeben wurden.
googletag.Slot
Eine Fläche ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt.
Methodenzusammenfassung | |
---|---|
addService
|
Fügt diesem Slot ein
Service hinzu.
|
clearCategoryExclusions
|
Löscht alle Ausschlusslabels für Anzeigenkategorien auf Anzeigenflächenebene für diese Anzeigenfläche.
|
clearTargeting
|
Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Anzeigenflächenebene für diese Anzeigenfläche.
|
defineSizeMapping
|
Legt ein Array von Zuordnungen von einer minimalen Größe des Darstellungsbereichs bis zur Größe der Anzeigenfläche für diese Anzeigenfläche fest.
|
get
|
Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diese Anzeigenfläche verknüpft ist.
|
getAdUnitPath
|
Gibt den vollständigen Pfad des Anzeigenblocks mit Netzwerkcode und Anzeigenblockpfad zurück
|
getAttributeKeys
|
Gibt die Liste der Attributschlüssel zurück, die für diese Anzeigenfläche festgelegt sind.
|
getCategoryExclusions
|
Gibt die Ausschlusslabels für Anzeigenkategorien für diese Anzeigenfläche zurück.
|
getResponseInformation
|
Gibt die Informationen zur Anzeigenantwort zurück.
|
getSlotElementId
|
Gibt die ID der Anzeigenfläche
div zurück, die bei der Definition der Anzeigenfläche angegeben wurde.
|
getTargeting
|
Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diese Anzeigenfläche festgelegt wurde.
|
getTargetingKeys
|
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diese Anzeigenfläche festgelegt sind.
|
set
|
Legt einen Wert für ein AdSense-Attribut in dieser Anzeigenfläche fest.
|
setCategoryExclusion
|
Legt ein Ausschlusslabel für die Anzeigenkategorie auf Anzeigenflächenebene für diese Anzeigenfläche fest.
|
setClickUrl
|
Legt die Klick-URL fest, zu der Nutzer nach dem Klicken auf die Anzeige weitergeleitet werden.
|
setCollapseEmptyDiv
|
Legt fest, ob die Anzeigenfläche
div ausgeblendet werden soll, wenn sich keine Anzeige befindet.
|
setConfig
|
Legt allgemeine Konfigurationsoptionen für diesen Slot fest.
|
setForceSafeFrame
|
Mit dieser Richtlinie wird festgelegt, ob das Rendern von Anzeigen auf dieser Anzeigenfläche über einen SafeFrame-Container erzwungen werden soll.
|
setSafeFrameConfig
|
Legt die Einstellungen auf Anzeigenflächenebene für die SafeFrame-Konfiguration fest.
|
setTargeting
|
Legt einen benutzerdefinierten Targeting-Parameter für diese Anzeigenfläche fest.
|
updateTargetingFromMap
|
Legt benutzerdefinierte Targeting-Parameter für diese Anzeigenfläche aus einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt fest.
|
addService
-
Fügt diesem Slot ein
Service
hinzu. -
- Beispiel
-
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (alt)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Weitere Informationen
-
Parameters service: Service
Der Dienst, der hinzugefügt werden soll. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
clearCategoryExclusions
-
clearCategoryExclusions(): Slot
-
Löscht alle Ausschlusslabels für Anzeigenkategorien auf Anzeigenflächenebene für diese Anzeigenfläche.
-
- Beispiel
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (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.
-
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
clearTargeting
-
clearTargeting(key?: string): Slot
-
Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Anzeigenflächenebene für diese Anzeigenfläche.
-
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Weitere Informationen
-
Parameters key?: string
Schlüssel für Targeting-Parameter. Der Schlüssel ist optional. Falls er nicht angegeben ist, werden alle Targeting-Parameter gelöscht. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
defineSizeMapping
-
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
-
Legt ein Array von Zuordnungen von einer minimalen Größe des Darstellungsbereichs bis zur Größe der Anzeigenfläche für diese Anzeigenfläche fest.
-
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping!);
- Weitere Informationen
-
Parameters sizeMapping: SizeMappingArray
Array mit Größenzuordnungen. Sie können sie mitSizeMappingBuilder
erstellen. Jede Größenzuordnung besteht aus einem Array aus zwei Elementen:SingleSizeArray
undGeneralSize
. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
get
-
get(key: string): null | string
-
Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diese Anzeigenfläche verknüpft ist. Wenn Sie die von diesem Slot übernommenen Attribute auf Dienstebene aufrufen möchten, verwenden Sie
PubAdsService.get
. -
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (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
-
Parameters key: string
Name des Attributs, nach dem gesucht wird. -
Rückgaben null | string
Aktueller Wert für den Attributschlüssel odernull
, wenn der Schlüssel nicht vorhanden ist.
getAdUnitPath
-
getAdUnitPath(): string
-
Gibt den vollständigen Pfad des Anzeigenblocks mit Netzwerkcode und Anzeigenblockpfad zurück
-
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
-
Rückgaben string
Anzeigenblockpfad.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Gibt die Liste der Attributschlüssel zurück, die für diese Anzeigenfläche festgelegt sind. Verwenden Sie
PubAdsService.getAttributeKeys
, um die Schlüssel der Attribute auf Dienstebene aufzurufen, die von diesem Slot übernommen wurden. -
- 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'].
-
Rückgaben string[]
Array mit Attributschlüsseln. Die Reihenfolge ist nicht definiert.
getCategoryExclusions
-
getCategoryExclusions(): string[]
-
Gibt die Ausschlusslabels für Anzeigenkategorien für diese Anzeigenfläche zurück.
-
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
-
Rückgaben string[]
Die Ausschlusslabels der Anzeigenkategorie für diese Anzeigenfläche oder ein leeres Array, wenn keine festgelegt wurden.
getResponseInformation
-
getResponseInformation(): null | ResponseInformation
-
Gibt die Informationen zur Anzeigenantwort zurück. Dieser Wert basiert auf der letzten Anzeigenantwort für die Anzeigenfläche. Wenn dies aufgerufen wird und die Anzeigenfläche keine Anzeige enthält, wird
null
zurückgegeben. -
-
Rückgaben null | ResponseInformation
Die neuesten Informationen zur Anzeigenantwort odernull
, wenn die Anzeigenfläche keine Anzeige enthält
getSlotElementId
-
getSlotElementId(): string
-
Gibt die ID der Anzeigenfläche
div
zurück, die bei der Definition der Anzeigenfläche angegeben wurde. -
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
-
Rückgaben string
ID der Anzeigenflächediv
.
getTargeting
-
getTargeting(key: string): string[]
-
Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diese Anzeigenfläche festgelegt wurde. Parameter für das Targeting auf Dienstebene sind nicht enthalten.
-
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
-
Parameters key: string
Der Targeting-Schlüssel, nach dem gesucht werden soll. -
Rückgaben string[]
Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn kein solcher Schlüssel vorhanden ist
getTargetingKeys
-
getTargetingKeys(): string[]
-
Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diese Anzeigenfläche festgelegt sind. Targeting-Schlüssel auf Dienstebene sind nicht enthalten.
-
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (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'].
-
Rückgaben string[]
Array mit Targeting-Schlüsseln Die Reihenfolge ist nicht definiert.
set
-
set(key: string, value: string): Slot
-
Legt einen Wert für ein AdSense-Attribut in dieser Anzeigenfläche fest. Dadurch werden alle Werte überschrieben, die auf Dienstebene für diesen Schlüssel festgelegt wurden.
Wenn diese Methode mehrmals für denselben Schlüssel aufgerufen wird, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen festgelegt werden, bevordisplay
oderrefresh
aufgerufen werden. -
- 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
-
Parameters key: string
Der Name des Attributs.value: string
Attributwert. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): Slot
-
Legt ein Ausschlusslabel für die Anzeigenkategorie auf Anzeigenflächenebene für diese Anzeigenfläche fest.
-
- Beispiel
-
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (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
-
Parameters categoryExclusion: string
Das hinzuzufügende Label zum Ausschließen von Anzeigenkategorien -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
setClickUrl
-
setClickUrl(value: string): Slot
-
Legt die Klick-URL fest, zu der Nutzer nach dem Klicken auf die Anzeige weitergeleitet werden.
Die Google Ad Manager-Server erfassen einen Klick auch dann, wenn die Klick-URL ersetzt wird. Jede Landingpage-URL, die dem ausgelieferten Creative zugeordnet ist, wird an den angegebenen Wert angehängt. Nachfolgende Aufrufe überschreiben den Wert. Dies funktioniert nur für Anfragen ohne SRA. -
- Beispiel
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
-
Parameters value: string
Die festzulegende Klick-URL. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
setCollapseEmptyDiv
-
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
-
Legt fest, ob die Anzeigenfläche
div
ausgeblendet werden soll, wenn sich keine Anzeige befindet. Dadurch werden die Einstellungen auf Dienstebene überschrieben. -
- Beispiel
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Weitere Informationen
-
Parameters collapse: boolean
Gibt an, ob die Anzeigenfläche minimiert werden soll, wenn keine Anzeige zurückgegeben wird.collapseBeforeAdFetch?: boolean
Gibt an, ob die Anzeigenfläche minimiert werden soll, bevor eine Anzeige abgerufen wird. Wird ignoriert, wenn die Minimierung nichttrue
ist. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
setConfig
-
setConfig(slotConfig: SlotSettingsConfig): void
-
Legt allgemeine Konfigurationsoptionen für diesen Slot fest.
-
-
Parameters slotConfig: SlotSettingsConfig
Das Konfigurationsobjekt.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): Slot
-
Konfiguriert, ob das Rendering von Anzeigen in dieser Anzeigenfläche über einen SafeFrame-Container erzwungen werden soll.
Bei der Verwendung dieser API ist Folgendes zu beachten:- Diese Einstellung wird nur bei nachfolgenden Anzeigenanfragen für die entsprechenden Anzeigenflächen wirksam.
- Sofern angegeben, überschreibt die Einstellung auf Anzeigenflächenebene immer die Einstellung auf Seitenebene.
- Wenn der Wert auf
true
(auf Anzeigenflächen- oder Seitenebene) festgelegt ist, wird die Anzeige immer mit einem SafeFrame-Container gerendert, unabhängig von der Auswahl, die auf der Google Ad Manager-Benutzeroberfläche getroffen wurde. - Wenn die Richtlinie auf
false
gesetzt oder nicht angegeben ist, wird die Anzeige abhängig vom Creative-Typ und der auf der Google Ad Manager-Benutzeroberfläche getroffenen Auswahl mit einem SafeFrame-Container gerendert. - Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken könnte, die versuchen, ihre iFrames zu durchbrechen, oder darauf angewiesen sind, dass sie direkt auf einer Publisher-Seite gerendert werden.
-
- Beispiel
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- Weitere Informationen
-
Parameters forceSafeFrame: boolean
true
, um zu erzwingen, dass alle Anzeigen auf dieser Anzeigenfläche in SafeFrames gerendert werden, undfalse
, um eine Einstellung auf Seitenebene zu deaktivieren (falls vorhanden). Wenn Sie dieses Flag auffalse
setzen, wenn es nicht auf Seitenebene angegeben ist, ändert sich nichts. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
setSafeFrameConfig
-
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
-
Legt die Einstellungen auf Anzeigenflächenebene für die SafeFrame-Konfiguration fest. Nicht erkannte Schlüssel im Konfigurationsobjekt werden ignoriert. Die gesamte Konfiguration wird ignoriert, wenn für einen erkannten Schlüssel ein ungültiger Wert übergeben wird.
Diese Einstellungen auf Anzeigenflächenebene, sofern angegeben, überschreiben alle Einstellungen auf Seitenebene. -
- Beispiel
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (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
-
Parameters config: null | SafeFrameConfig
Das Konfigurationsobjekt. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
setTargeting
-
setTargeting(key: string, value: string | string[]): Slot
-
Legt einen benutzerdefinierten Targeting-Parameter für diese Anzeigenfläche fest. Durch mehrfaches Aufrufen dieser Methode für denselben Schlüssel werden alte Werte überschrieben. Die hier festgelegten Werte überschreiben die Targeting-Parameter, die auf Dienstebene festgelegt wurden. Diese Schlüssel sind in Ihrem Google Ad Manager-Konto definiert.
-
- Beispiel
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Weitere Informationen
-
Parameters key: string
Schlüssel für Targeting-Parameter.value: string | string[]
Wert des Targeting-Parameters oder Array von Werten -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
updateTargetingFromMap
-
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
-
Legt benutzerdefinierte Targeting-Parameter für diese Anzeigenfläche aus einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt fest. Dies entspricht dem Aufrufen von
Slot.setTargeting
für alle Schlüssel/Wert-Paare des Objekts. Diese Schlüssel sind in Ihrem Google Ad Manager-Konto definiert.
Hinweise:- Beim Überschreiben wird nur der letzte Wert beibehalten.
- Wenn der Wert ein Array ist, wird jeder vorherige Wert überschrieben und nicht zusammengeführt.
- Die hier festgelegten Werte überschreiben die Targeting-Parameter, die auf Dienstebene festgelegt wurden.
-
- Beispiel
-
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (alt)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
-
Parameters map: { [adUnitPath: string]: string | string[] }
Schlüssel/Wert-Zuordnung des Targeting-Parameters. -
Rückgaben Slot
Das Slotobjekt, bei dem die Methode aufgerufen wurde.
googletag.config.AdExpansionConfig
Einstellungen zur Steuerung der Anzeigenmaximierung.
Property-Zusammenfassung | |
---|---|
enabled
|
Gibt an, ob die Anzeigenexpansion aktiviert oder deaktiviert ist.
|
- Beispiel
-
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (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 }, });
enabled
-
enabled: boolean
-
Gibt an, ob die Anzeigenexpansion aktiviert oder deaktiviert ist.
Mit dieser Einstellung wird die in Google Ad Manager konfigurierte Standardeinstellung überschrieben.
googletag.config.ComponentAuctionConfig
Ein Objekt, das eine Einzelkomponenten-Auktion in einer On-Device-Anzeigenauktion darstellt.
Property-Zusammenfassung | |
---|---|
auctionConfig
|
Ein Auktionskonfigurationsobjekt für diese Komponentenauktion.
|
configKey
|
Der Konfigurationsschlüssel, der dieser Komponentenauktion zugewiesen ist.
|
- Weitere Informationen
auctionConfig
-
auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
-
Ein Auktionskonfigurationsobjekt für diese Komponentenauktion.
Wenn dieser Wert aufnull
festgelegt ist, werden alle vorhandenen Konfigurationen für die angegebeneconfigKey
gelöscht. -
- Beispiel
-
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (alt)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- Weitere Informationen
configKey
-
configKey: string
-
Der Konfigurationsschlüssel, der dieser Komponentenauktion zugewiesen ist.
Dieser Wert darf nicht leer und eindeutig sein. Wenn zweiComponentAuctionConfig
-Objekte denselben configKey-Wert haben, überschreibt das zuletzt festgelegte Objekt die vorherigen Konfigurationen. -
googletag.config.InterstitialConfig
Ein Objekt, das das Verhalten einer einzelnen Interstitial-Anzeigenfläche definiert.
Property-Zusammenfassung | |
---|---|
triggers
|
Die Interstitial-Triggerkonfiguration für diese Interstitial-Anzeige
|
triggers
-
triggers: Partial<Record<InterstitialTrigger, boolean>>
-
Die Konfiguration des Interstitial-Triggers für diese Interstitial-Anzeige.
Wenn Sie einen Interstitial-Trigger auftrue
setzen, wird sie aktiviert und durchfalse
deaktiviert. Dadurch werden die in Google Ad Manager konfigurierten Standardwerte überschrieben. -
- Beispiel
-
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (alt)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Weitere Informationen
googletag.config.PageSettingsConfig
Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene.
Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf.
Alle unten aufgeführten Attribute sind Beispiele und entsprechen nicht den tatsächlichen Funktionen, für die „setConfig“ verwendet wird. Die verschiedenen Funktionen finden Sie in den Feldern des Typs „PageSettingsConfig“ unten.
Beispiele:
- Es werden nur die im
setConfig
-Aufruf angegebenen Elemente geändert.// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Alle Einstellungen für eine bestimmte Funktion werden mit jedem Aufruf von
setConfig
aktualisiert.// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Alle Einstellungen für ein Element können durch die Ü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, });
Property-Zusammenfassung | |
---|---|
adExpansion
|
Einstellungen zur Steuerung der Anzeigenmaximierung.
|
pps
|
Einstellungen zur Steuerung der vom Publisher bereitgestellten Signale (PPS)
|
privacyTreatments
|
Einstellungen, mit denen der Umgang mit dem Datenschutz für Publisher gesteuert wird.
|
adExpansion
-
adExpansion: null | AdExpansionConfig
-
Einstellungen zur Steuerung der Anzeigenmaximierung.
-
pps
-
pps: null | PublisherProvidedSignalsConfig
-
Einstellungen zur Steuerung der vom Publisher bereitgestellten Signale (PPS)
-
privacyTreatments
-
privacyTreatments: null | PrivacyTreatmentsConfig
-
Einstellungen, mit denen der Umgang mit dem Datenschutz für Publisher gesteuert wird.
-
googletag.config.PrivacyTreatmentsConfig
Einstellungen, mit denen der Umgang mit dem Datenschutz für Publisher gesteuert wird.
Property-Zusammenfassung | |
---|---|
treatments
|
Mehrere zu aktivierende Datenschutzeinstellungen für Publisher.
|
treatments
-
treatments: "disablePersonalization"[]
-
Mehrere zu aktivierende Datenschutzeinstellungen für Publisher.
-
- Beispiel
-
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (alt)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvidedSignalsConfig
PPS-Konfigurationsobjekt
Property-Zusammenfassung | |
---|---|
taxonomies
|
Ein Objekt, das Taxonomie-Zuordnungen enthält.
|
- Beispiel
-
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (alt)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
- Weitere Informationen
taxonomies
-
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
-
Ein Objekt, das Taxonomie-Zuordnungen enthält.
-
googletag.config.SlotSettingsConfig
Hauptkonfigurationsoberfläche für Einstellungen auf Slotebene.
Ermöglicht das Festlegen mehrerer Features mit einem einzigen API-Aufruf für einen einzelnen Slot.
Alle unten aufgeführten Attribute sind Beispiele und spiegeln nicht die tatsächlichen Features wider, die „setConfig“ verwenden. Die verschiedenen Funktionen finden Sie in den Feldern des „SlotSettingsConfig“-Typs 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 mit 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 ein Element können durch die Ü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, });
Property-Zusammenfassung | |
---|---|
adExpansion
|
Einstellungen zur Steuerung der Anzeigenmaximierung.
|
componentAuction
|
Eine Reihe von Komponentenauktionen, die in eine On-Device-Anzeigenauktion einbezogen werden sollen.
|
interstitial
|
Einstellungen, die das Verhalten von Interstitial-Anzeigenflächen steuern.
|
adExpansion
-
adExpansion: AdExpansionConfig
-
Einstellungen zur Steuerung der Anzeigenmaximierung.
-
componentAuction
-
componentAuction: ComponentAuctionConfig[]
-
Eine Reihe von Komponentenauktionen, die in eine On-Device-Anzeigenauktion einbezogen werden sollen.
-
interstitial
-
interstitial: InterstitialConfig
-
Einstellungen, die das Verhalten von Interstitial-Anzeigenflächen steuern.
-
googletag.config.TaxonomyData
Ein Objekt, das die Werte für eine einzelne Taxonomie enthält.
Property-Zusammenfassung | |
---|---|
values
|
Eine Liste von Taxonomiewerten.
|
values
-
values: string[]
-
Eine Liste von Taxonomiewerten.
-
googletag.events.Event
Basisoberfläche für alle GPT-Ereignisse. Alle unten aufgeführten GPT-Ereignisse haben folgende Felder.
Property-Zusammenfassung | |
---|---|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
|
- Weitere Informationen
serviceName
-
serviceName: string
-
Name des Dienstes, der das Ereignis ausgelöst hat.
-
slot
-
slot: Slot
-
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
-
googletag.events.EventTypeMap
Dies ist ein Pseudotyp, mit dem ein Ereignisname dem entsprechenden Ereignisobjekttyp für Service.addEventListener
und Service.removeEventListener
zugeordnet wird. Sie wird nur zu Referenz- und Typsicherheitszwecken dokumentiert.
Property-Zusammenfassung | |
---|---|
impressionViewable
|
Alias für
events.ImpressionViewableEvent .
|
rewardedSlotClosed
|
Alias für
events.RewardedSlotClosedEvent .
|
rewardedSlotGranted
|
Alias für
events.RewardedSlotGrantedEvent .
|
rewardedSlotReady
|
Alias für
events.RewardedSlotReadyEvent .
|
slotOnload
|
Alias für
events.SlotOnloadEvent .
|
slotRenderEnded
|
Alias für
events.SlotRenderEndedEvent .
|
slotRequested
|
Alias für
events.SlotRequestedEvent .
|
slotResponseReceived
|
Alias für
events.SlotResponseReceived .
|
slotVisibilityChanged
|
Alias für
events.SlotVisibilityChangedEvent .
|
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.ImpressionViewableEvent
Erweitert
Dieses Ereignis wird ausgelöst, wenn eine Impression gemäß den Active View-Kriterien sichtbar wird.
Property-Zusammenfassung | |
---|---|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
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
Erweitert
Dieses Ereignis wird ausgelöst, wenn der Nutzer eine Anzeigenfläche mit Prämie schließt. Sie kann ausgelöst werden, bevor oder nachdem eine Prämie gewährt wurde. Wenn Sie feststellen möchten, ob eine Prämie gewährt wurde, verwenden Sie stattdessen events.RewardedSlotGrantedEvent
.
Property-Zusammenfassung | |
---|---|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die 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
Erweitert
Dieses Ereignis wird ausgelöst, wenn eine Prämie für das Ansehen einer Anzeige mit Prämie gewährt wird. Wenn die Anzeige geschlossen wird, bevor die Kriterien für die Vergabe einer Prämie erfüllt sind, wird dieses Ereignis nicht ausgelöst.
Property-Zusammenfassung | |
---|---|
payload
|
Ein Objekt mit Informationen zur gewährten Prämie.
|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
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
payload
-
payload: null | RewardedPayload
-
Ein Objekt mit Informationen zur gewährten Prämie.
-
googletag.events.RewardedSlotReadyEvent
Erweitert
Dieses Ereignis wird ausgelöst, wenn eine Anzeige mit Prämie zur Auslieferung bereit ist. Der Publisher ist dafür verantwortlich, dem Nutzer die Möglichkeit zu bieten, sich die Anzeige anzusehen, bevor sie eingeblendet wird.
Property-Zusammenfassung | |
---|---|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
Von „
|
Methodenzusammenfassung | |
---|---|
makeRewardedVisible
|
Zeigt die Anzeige mit Prämie an.
|
- 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
makeRewardedVisible
-
makeRewardedVisible(): void
-
Zeigt die Anzeige mit Prämie an. Diese Methode sollte erst aufgerufen werden, wenn der Nutzer in die Anzeige eingewilligt hat.
-
googletag.events.SlotOnloadEvent
Erweitert
Dieses Ereignis wird ausgelöst, wenn der iFrame des Creatives das Ereignis „Laden“ auslöst. Beim Rendern von Rich Media-Anzeigen im synchronen Renderingmodus wird kein iFrame verwendet, sodass kein SlotOnloadEvent
ausgelöst wird.
Property-Zusammenfassung | |
---|---|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
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
Erweitert
Dieses Ereignis wird ausgelöst, wenn der Creative-Code in eine Anzeigenfläche eingeschleust wird. Dieses Ereignis tritt ein, bevor die Ressourcen des Creatives abgerufen wurden. Das Creative ist also möglicherweise noch nicht sichtbar. Falls Sie wissen möchten, wann alle Creative-Ressourcen für eine Anzeigenfläche vollständig geladen sind, sollten Sie stattdessen den events.SlotOnloadEvent
verwenden.
Property-Zusammenfassung | |
---|---|
advertiserId
|
Werbetreibenden-ID der gerenderten Anzeige.
|
campaignId
|
Kampagnen-ID der gerenderten Anzeige.
|
companyIds
|
IDs der Unternehmen, die auf die gerenderte Backfill-Anzeige bieten.
|
creativeId
|
Creative-ID der gerenderten Reservierungsanzeige.
|
creativeTemplateId
|
Creative-Vorlagen-ID der gerenderten Reservierungsanzeige.
|
isBackfill
|
Ob eine Anzeige eine Backfill-Anzeige war.
|
isEmpty
|
Gibt an, ob eine Anzeige für die Anzeigenfläche zurückgegeben wurde.
|
labelIds
|
Label-IDs der gerenderten Anzeige.
|
lineItemId
|
Werbebuchungs-ID der gerenderten Reservierungsanzeige.
|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
size
|
Gibt die Pixelgröße des gerenderten Creatives an.
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
Von „
|
slotContentChanged
|
Gibt an, ob der Inhalt der Anzeigenfläche mit der gerenderten Anzeige geändert wurde.
|
sourceAgnosticCreativeId
|
Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige.
|
sourceAgnosticLineItemId
|
Werbebuchungs-ID der gerenderten Reservierungs- oder Backfill-Anzeige.
|
yieldGroupIds
|
IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige.
|
- Beispiel
-
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (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("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
advertiserId
-
advertiserId: null | number
-
Werbetreibenden-ID der gerenderten Anzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
campaignId
-
campaignId: null | number
-
Kampagnen-ID der gerenderten Anzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
companyIds
-
companyIds: null | number[]
-
IDs der Unternehmen, die auf die gerenderte Backfill-Anzeige bieten. Für leere Anzeigenflächen, Reservierungsanzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
creativeId
-
creativeId: null | number
-
Creative-ID der gerenderten Reservierungsanzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
creativeTemplateId
-
creativeTemplateId: null | number
-
Creative-Vorlagen-ID der gerenderten Reservierungsanzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
isBackfill
-
isBackfill: boolean
-
Ob eine Anzeige eine Backfill-Anzeige war. Der Wert ist
true
, wenn die Anzeige eine Backfill-Anzeige war, andernfallsfalse
. -
isEmpty
-
isEmpty: boolean
-
Gibt an, ob eine Anzeige für die Anzeigenfläche zurückgegeben wurde. Der Wert ist
true
, wenn keine Anzeige zurückgegeben wurde, andernfallsfalse
. -
labelIds
-
labelIds: null | number[]
-
Label-IDs der gerenderten Anzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
lineItemId
-
lineItemId: null | number
-
Werbebuchungs-ID der gerenderten Reservierungsanzeige. Für leere Anzeigenflächen, Backfill-Anzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
size
-
size: null | string | number[]
-
Gibt die Pixelgröße des gerenderten Creatives an. Beispiel:
[728, 90]
. Bei leeren Anzeigenflächen lautet der Wertnull
. -
slotContentChanged
-
slotContentChanged: boolean
-
Gibt an, ob der Inhalt der Anzeigenfläche mit der gerenderten Anzeige geändert wurde. Der Wert ist
true
, wenn der Inhalt geändert wurde, andernfallsfalse
. -
sourceAgnosticCreativeId
-
sourceAgnosticCreativeId: null | number
-
Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige. Der Wert ist
null
, wenn die Anzeige kein Backfill einer Reservierung oder eines Werbebuchungs-Backfills ist oder das Creative von anderen Diensten alsPubAdsService
gerendert wird. -
sourceAgnosticLineItemId
-
sourceAgnosticLineItemId: null | number
-
Werbebuchungs-ID der gerenderten Reservierungs- oder Backfill-Anzeige. Der Wert ist
null
, wenn die Anzeige kein Backfill einer Reservierung oder eines Werbebuchungs-Backfills ist oder das Creative von anderen Diensten alsPubAdsService
gerendert wird. -
yieldGroupIds
-
yieldGroupIds: null | number[]
-
IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige. Für leere Anzeigenflächen, Reservierungsanzeigen und Creatives, die von anderen Diensten als
PubAdsService
gerendert werden, lautet der Wertnull
. -
googletag.events.SlotRequestedEvent
Erweitert
Dieses Ereignis wird ausgelöst, wenn eine Anzeige für eine bestimmte Anzeigenfläche angefordert wurde.
Property-Zusammenfassung | |
---|---|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
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
Erweitert
Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für eine bestimmte Anzeigenfläche empfangen wird.
Property-Zusammenfassung | |
---|---|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die 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
Erweitert
Dieses Ereignis wird immer dann ausgelöst, wenn sich der Prozentsatz der Fläche einer Anzeigenfläche auf dem Bildschirm ändert. Das Ereignis wird gedrosselt und wird nicht häufiger als einmal alle 200 ms ausgelöst.
Property-Zusammenfassung | |
---|---|
inViewPercentage
|
Der Prozentsatz der sichtbaren Fläche der Anzeige.
|
serviceName
|
Name des Dienstes, der das Ereignis ausgelöst hat.
Von „
|
slot
|
Die Anzeigenfläche, die das Ereignis ausgelöst hat.
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
inViewPercentage
-
inViewPercentage: number
-
Der Prozentsatz der sichtbaren Fläche der Anzeige. Der Wert ist eine Zahl zwischen 0 und 100.
-
googletag.secureSignals.BidderSignalProvider
Gibt ein sicheres Signal für einen bestimmten Bieter zurück.
Ein Anbieter sicherer Signale besteht aus zwei Teilen:
- Eine Collector-Funktion, die ein
Promise
zurückgibt, das in ein sicheres Signal aufgelöst wird. - Ein
id
, das den mit dem Signal verknüpften Bieter identifiziert.
secureSignals.PublisherSignalProvider
.
Property-Zusammenfassung | |
---|---|
collectorFunction
|
.
|
id
|
Eine eindeutige Kennung für den Collector, der diesem sicheren Signal zugeordnet und in Google Ad Manager registriert wurde.
|
- Beispiel
-
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (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
collectorFunction
-
collectorFunction: () => Promise<string>
-
id
-
id: string
-
Eine eindeutige Kennung für den Collector, der diesem sicheren Signal zugeordnet und in Google Ad Manager registriert wurde.
-
googletag.secureSignals.PublisherSignalProvider
Gibt ein sicheres Signal für einen bestimmten Publisher zurück.
Ein Publisher-Signalanbieter besteht aus zwei Teilen:
- Eine Collector-Funktion, die ein
Promise
zurückgibt, das in ein sicheres Signal aufgelöst wird. - Ein
networkCode
, das den mit dem Signal verknüpften Publisher identifiziert.
secureSignals.BidderSignalProvider
.
Property-Zusammenfassung | |
---|---|
collectorFunction
|
.
|
networkCode
|
Der Netzwerkcode (wie im Anzeigenblockpfad zu sehen) für den Publisher, der diesem sicheren Signal zugeordnet ist.
|
- Beispiel
-
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (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
collectorFunction
-
collectorFunction: () => Promise<string>
-
networkCode
-
networkCode: string
-
Der Netzwerkcode (wie im Anzeigenblockpfad zu sehen) für den Publisher, der diesem sicheren Signal zugeordnet ist.
-
googletag.secureSignals.SecureSignalProvidersArray
Eine Schnittstelle zur Verwaltung sicherer Signale.
Methodenzusammenfassung | |
---|---|
clearAllCache
|
Löscht alle Signale im Cache aus dem lokalen Speicher.
|
push
|
Fügt dem Array des Signalanbieters ein neues
secureSignals.SecureSignalProvider hinzu und beginnt mit der Signalgenerierung.
|
clearAllCache
-
clearAllCache(): void
-
Löscht alle Signale im Cache aus dem lokalen Speicher.
-
push
-
push(provider: SecureSignalProvider): void
-
Fügt dem Array des Signalanbieters ein neues
secureSignals.SecureSignalProvider
hinzu und beginnt mit der Signalgenerierung. -
-
Parameters provider: SecureSignalProvider
DassecureSignals.SecureSignalProvider
-Objekt, das dem Array hinzugefügt werden soll.