In dieser Referenz wird die TypeScript-Notation verwendet, um Typen zu beschreiben. Die folgende Tabelle enthält eine kurze Erklärung anhand eines Beispiels.
Typausdruck | |
---|---|
string |
Der primitive Stringtyp. |
string[] |
Ein Array-Typ, bei dem Werte nur Strings sein dürfen. |
number | string |
Ein Union-Typ, bei dem der Wert entweder eine Zahl oder ein String sein kann. |
Array<number | string> |
Ein Array-Typ, bei dem die Werte ein komplexer (Union-)Typ sind. |
[number, string] |
Ein Tupeltyp, bei dem der Wert ein Array mit zwei Elementen ist, das in dieser Reihenfolge eine Zahl und einen String enthalten muss. |
Slot |
Ein Objekttyp, bei dem der Wert eine Instanz von googletag.Slot ist. |
() => void |
Ein Funktionstyp ohne definierte Argumente und ohne Rückgabewert. |
Weitere Informationen zu unterstützten Typen und Typausdrücken finden Sie im TypeScript-Handbuch .
Typanmerkungen
Ein Doppelpunkt nach einer Variablen, einem Parameternamen, einem Attributnamen oder einer Funktionssignatur kennzeichnet eine Typanmerkung. Typanmerkungen beschreiben die Typen, die das Element links vom Doppelpunkt akzeptieren oder zurückgeben kann. Die folgende Tabelle enthält Beispiele für Typanmerkungen, die in dieser Referenz vorkommen können.
Typannotation | |
---|---|
param: string |
Gibt an, dass param einen Stringwert akzeptiert oder zurückgibt. Diese Syntax wird für Variablen, Parameter, Attribute und Rückgabetypen verwendet.
|
param?: number | string |
Gibt an, dass param optional ist, aber entweder eine Zahl oder ein String akzeptiert, wenn es angegeben wird. Diese Syntax wird für Parameter und Properties verwendet.
|
...params: Array<() => void> |
Gibt an, dass params ein
Restparameter
ist, der Funktionen akzeptiert. Rest-Parameter können eine unbegrenzte Anzahl von Werten des angegebenen Typs annehmen.
|
googletag
Namespaces | |
---|---|
config | Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene. |
enums | Dies ist der Namespace, den GPT für Enumerationstypen verwendet. |
events | Dies ist der Namespace, den GPT für Ereignisse verwendet. |
secure | Dies ist der Namespace, den GPT zum Verwalten sicherer Signale verwendet. |
Schnittstellen | |
---|---|
Command | Das Befehls-Array akzeptiert eine Folge von Funktionen und ruft sie in der angegebenen Reihenfolge auf. |
Companion | Companion-Anzeigen-Dienst |
Privacy | Konfigurationsobjekt für Datenschutzeinstellungen. |
Pub | Publisher-Anzeigendienst. |
Response | Ein Objekt, das eine einzelne Anzeigenantwort darstellt. |
Rewarded | Ein Objekt, das die mit einer Anzeige mit Prämie verknüpfte Prämie darstellt. |
Service | Basisdienstklasse mit Methoden, die für alle Dienste üblich sind. |
Size | Builder für Spezifikationsobjekte für die Größenanpassung. |
Slot | Ein Slot ist ein Objekt, das eine einzelne Anzeigenfläche auf einer Seite darstellt. |
Typaliasse | |
---|---|
General | Eine gültige Größenkonfiguration für einen Slot, die eine oder mehrere Größen umfassen kann. |
Multi | Eine Liste mit einzelnen gültigen Größen. |
Named | Benannte Größen, die ein Slot haben kann. |
Single | Eine gültige Größe für einen Slot. |
Single | Array mit zwei Zahlen, die [Breite, Höhe] darstellen. |
Size | Eine Zuordnung von Darstellungsbereichsgröße zu Anzeigengrößen. |
Size | Eine Liste der Größen-Mappings. |
Variablen | |
---|---|
api | Flag, das angibt, dass die GPT API geladen wurde und aufgerufen werden kann. |
cmd | Referenz zur globalen Befehlswarteschlange für die asynchrone Ausführung von GPT-bezogenen Aufrufen. |
pubads | Flag, das angibt, dass PubAdsService aktiviert, geladen und voll funktionsfähig ist. |
secure | Verweis auf das Array der Anbieter sicherer Signale. |
Funktionen | |
---|---|
companion | Gibt einen Verweis auf den CompanionAdsService zurück. |
define | Erstellt eine Out-of-Page-Anzeigenfläche mit dem angegebenen Anzeigenblockpfad. |
define | Erstellt eine Anzeigenfläche mit einem bestimmten Anzeigenblockpfad und einer bestimmten Größe und verknüpft sie mit der ID eines DIV-Elements auf der Seite, das die Anzeige enthalten soll. |
destroy | Löscht die angegebenen Slots und entfernt alle zugehörigen Objekte und Verweise dieser Slots aus GPT. |
disable | Deaktiviert die Google Publisher Console. |
display | Weist Slot-Dienste an, den Slot zu rendern. |
enable | Aktiviert alle GPT-Dienste, die für Anzeigenflächen auf der Seite definiert wurden. |
get | Ruft allgemeine Konfigurationsoptionen für die Seite ab, die mit setConfig festgelegt wurde. |
get | Gibt die aktuelle Version von GPT zurück. |
open | Öffnet die Google Publisher Console. |
pubads | Gibt einen Verweis auf PubAdsService zurück. |
set | Legt den Titel für alle Anzeigencontainer-iFrames fest, die ab diesem Zeitpunkt von PubAdsService erstellt werden. |
set | Legt allgemeine Konfigurationsoptionen für die Seite fest. |
size | Erstellt einen neuen SizeMappingBuilder. |
Typaliasse
GeneralSize
GeneralSize: SingleSize | MultiSize
MultiSize
MultiSize: SingleSize[]
NamedSize
NamedSize: "fluid" | ["fluid"]
- Flexibel: Der Anzeigen-Container hat eine Breite von 100% des übergeordneten div-Elements und die Höhe wird an den Creative-Inhalt angepasst. Ähnlich wie bei normalen Blockelementen auf einer Seite. Wird für native Anzeigen verwendet (siehe zugehörigen Artikel). Sowohl
fluid
als auch['fluid']
sind zulässige Formen, um eine Slotgröße als responsiv zu deklarieren.
SingleSize
SingleSize: SingleSizeArray | NamedSize
SingleSizeArray
SingleSizeArray: [number, number]
SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]
SizeMappingArray
SizeMappingArray: SizeMapping[]
Variablen
Const
apiReady
apiReady: boolean | undefined
undefined
, bis die API bereit ist.Die empfohlene Methode für die asynchrone Verarbeitung ist die Verwendung von googletag.cmd, um Callbacks in die Warteschlange zu stellen, bis GPT bereit ist. Bei diesen Callbacks muss „googletag.apiReady“ nicht geprüft werden, da sie garantiert ausgeführt werden, sobald die API eingerichtet ist.
Const
cmd
cmd: ((this: typeof globalThis) => void)[] | CommandArray
Die Variable
googletag.cmd
wird durch die GPT-Tag-Syntax auf der Seite in ein leeres JavaScript-Array initialisiert und cmd.push
ist die Standardmethode Array.push
, mit der ein Element am Ende des Arrays hinzugefügt wird. Wenn das GPT-JavaScript geladen wird, durchsucht es das Array und führt alle Funktionen in der richtigen Reihenfolge aus. Das Skript ersetzt dann cmd
durch ein CommandArray-Objekt, dessen Push-Methode so definiert ist, dass das an sie übergebene Funktionsargument ausgeführt wird. Mit diesem Mechanismus kann GPT die wahrgenommene Latenz verringern, indem das JavaScript asynchron abgerufen wird, während der Browser die Seite weiter rendert.- Beispiel
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (alt)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
Const
pubadsReady
pubadsReady: boolean | undefined
undefined
, bis enableServices aufgerufen und PubAdsService geladen und initialisiert wird.secureSignalProviders
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
Das Array der Anbieter sicherer Signale akzeptiert eine Folge von signalgenerierenden Funktionen und ruft sie in der Reihenfolge auf. Es soll ein Standard-Array ersetzen, das verwendet wird, um signalgenerierende Funktionen in die Warteschlange zu stellen, die aufgerufen werden sollen, sobald GPT geladen ist.
- Beispiel
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (alt)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- Weitere Informationen
Funktionen
companionAds
companionAds(): CompanionAdsService
Ausgabe | |
---|---|
CompanionAdsService | Der Dienst für Companion-Anzeigen. |
defineOutOfPageSlot
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
Bei benutzerdefinierten Out-of-Page-Anzeigen ist
div
die ID des Div-Elements, das die Anzeige enthalten soll. Weitere Informationen finden Sie im Artikel zu Out-of-Page-Creatives.Bei Out-of-Page-Anzeigen, die von GPT verwaltet werden, ist
div
ein unterstütztes OutOfPageFormat.- Beispiel
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (alt)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Weitere Informationen
Parameter | |
---|---|
adUnitPath: string | Vollständiger Anzeigenblock-Pfad mit dem Netzwerkcode und dem Anzeigenblockcode. |
| ID des DIV-Elements, das diesen Anzeigenblock oder das Out-of-Page-Format enthält. |
Ausgabe | |
---|---|
Slot | null | Der neu erstellte Slot oder null , wenn kein Slot erstellt werden kann. |
defineSlot
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
- Beispiel
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (alt)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Weitere Informationen
Parameter | |
---|---|
adUnitPath: string | Vollständiger Anzeigenblock-Pfad mit dem Netzwerkcode und dem Code des Anzeigenblocks. |
size: GeneralSize | Breite und Höhe des hinzugefügten Slots. Diese Größe wird in der Anzeigenanfrage verwendet, wenn keine responsive Größenanpassung angegeben ist oder die Größe des Viewports kleiner ist als die kleinste Größe in der Anpassung. |
| ID des DIV-Elements, das diesen Anzeigenblock enthält. |
Ausgabe | |
---|---|
Slot | null | Der neu erstellte Slot oder null , wenn kein Slot erstellt werden kann. |
destroySlots
destroySlots(slots?: Slot[]): boolean
Wenn Sie diese API für einen Slot aufrufen, wird die Anzeige gelöscht und das Slot-Objekt aus dem internen Status entfernt, der von GPT verwaltet wird. Wenn Sie weitere Funktionen für das Slot-Objekt aufrufen, ist das Verhalten nicht definiert. Hinweis: Der Browser gibt den Speicher, der diesem Slot zugeordnet ist, möglicherweise nicht kostenlos, wenn die Publisher-Seite eine Referenz darauf beibehält. Durch den Aufruf dieser API wird das mit dieser Anzeigenfläche verknüpfte Div-Element zur Wiederverwendung verfügbar.
Wenn Sie eine Anzeigenfläche entfernen, wird die Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden daher nicht durch Roadblocks oder Ausschlüsse von konkurrierenden Anzeigen beeinflusst, die diese Anzeige betreffen. Wenn Sie diese Funktion nicht aufrufen, bevor Sie das DIV-Element eines Slots von der Seite entfernen, kann das zu einem nicht definierten Verhalten führen.
- Beispiel
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (alt)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
Parameter | |
---|---|
| Das Array der zu zerstörenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots zerstört. |
Ausgabe | |
---|---|
boolean | true , wenn Slots zerstört wurden, andernfalls false . |
disablePublisherConsole
disablePublisherConsole(): void
- Weitere Informationen
Display
display(divOrSlot: string | Element | Slot): void
Wenn die Einzelanfrage-Architektur (Single Request Architecture, SRA) verwendet wird, werden alle Anzeigenflächen, die zum Zeitpunkt des Aufrufs dieser Methode noch nicht abgerufen wurden, gleichzeitig abgerufen. Wenn ein Anzeigen-Slot nicht ausgeliefert werden soll, muss das gesamte Div-Element entfernt werden.
- Weitere Informationen
Parameter | |
---|---|
divOrSlot: string | Element | Slot | Entweder die ID des div-Elements, das den Anzeigenblock enthält, oder das div-Element oder das Slot-Objekt. Wenn ein div-Element angegeben wird, muss es ein „id“-Attribut haben, das mit der ID übereinstimmt, die an defineSlot übergeben wird. |
enableServices
enableServices(): void
getConfig
getConfig(keys: string | string[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">
Nicht alle
setConfig()
-Properties werden von dieser Methode unterstützt. Unterstützte Eigenschaften:- Beispiel
JavaScript
// Get the value of the `targeting` setting. const targetingConfig = googletag.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `disableInitialLoad` settings. const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
JavaScript (alt)
// Get the value of the `targeting` setting. var targetingConfig = googletag.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `disableInitialLoad` settings. var config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
TypeScript
// Get the value of the `targeting` setting. const targetingConfig = googletag.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `disableInitialLoad` settings. const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
Parameter | |
---|---|
keys: string | string[] | Die Schlüssel der abzurufenden Konfigurationsoptionen. |
Ausgabe | |
---|---|
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting"> | Die Konfigurationsoptionen für den Slot. |
getVersion
getVersion(): string
- Weitere Informationen
Ausgabe | |
---|---|
string | Der String der aktuell ausgeführten GPT-Version. |
openConsole
openConsole(div?: string): void
- Beispiel
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (alt)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- Weitere Informationen
Parameter | |
---|---|
| Die ID eines Anzeigenflächen-Div. Dieser Wert ist optional. Wenn die Publisher Console geöffnet wird, werden nach Möglichkeit Details zum angegebenen Anzeigenblock angezeigt. |
pubads
pubads(): PubAdsService
Ausgabe | |
---|---|
PubAdsService | Der Publisher Ads-Dienst. |
setAdIframeTitle
setAdIframeTitle(title: string): void
- Beispiel
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (alt)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
Parameter | |
---|---|
title: string | Der neue Titel für alle Anzeigencontainer-IFrames. |
setConfig
setConfig(config: PageSettingsConfig): void
Parameter | |
---|---|
config: PageSettingsConfig |
sizeMapping
sizeMapping(): SizeMappingBuilder
- Weitere Informationen
Ausgabe | |
---|---|
SizeMappingBuilder | Ein neuer Builder. |
googletag.CommandArray
Methoden | |
---|---|
push | Führt die Reihenfolge der in den Argumenten angegebenen Funktionen aus. |
Methoden
push
push(...f: ((this: typeof globalThis) => void)[]): number
- Beispiel
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (alt)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
Parameter | |
---|---|
| Eine auszuführende JavaScript-Funktion. Die Laufzeitbindung ist immer globalThis . Sie sollten eine Pfeilfunktion übergeben, um den this -Wert des einschließenden lexikalischen Kontexts beizubehalten. |
Ausgabe | |
---|---|
number | Die Anzahl der bisher verarbeiteten Befehle. Dies ist mit dem Rückgabewert von Array.push (der aktuellen Länge des Arrays) kompatibel. |
googletag.CompanionAdsService
ErweitertMethoden | |
---|---|
add | Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt. Von |
get | Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind. Von |
remove | Entfernt einen zuvor registrierten Listener. Von |
set | Legt fest, ob Companion-Flächen, die nicht gefüllt wurden, automatisch mit Backfill-Anzeigen gefüllt werden. |
- Weitere Informationen
Methoden
setRefreshUnfilledSlots
setRefreshUnfilledSlots(value: boolean): void
Diese Methode kann während der Lebensdauer der Seite mehrmals aufgerufen werden, um den Backfill zu aktivieren und zu deaktivieren. Nur Flächen, die auch beim PubAdsService registriert sind, werden mit einem Backfill versehen. Aufgrund von Richtlinienbeschränkungen ist diese Methode nicht dafür vorgesehen, leere Companion-Slots zu füllen, wenn ein Ad Exchange-Video ausgeliefert wird.
- Beispiel
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (alt)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
Parameter | |
---|---|
value: boolean | true – nicht ausgefüllte Slots werden automatisch mit Backfill-Anzeigen gefüllt. false – nicht ausgefüllte Slots bleiben unverändert. |
googletag.PrivacySettingsConfig
Attribute | |
---|---|
child | Gibt an, ob die Seite als Inhalte für Kinder behandelt werden soll. |
limited | Ermöglicht die Anzeigenbereitstellung im Modus eingeschränkte Anzeigenausrichtung, um Publisher bei der Einhaltung gesetzlicher Auflagen zu unterstützen. |
non | Ermöglicht die Auslieferung im Modus nicht personalisierte Anzeigen, um Publisher bei der Einhaltung von Vorschriften zu unterstützen. |
restrict | Ermöglicht die Anzeigenbereitstellung im Modus für eingeschränkte Verarbeitung, um Publisher bei der Einhaltung gesetzlicher Vorschriften zu unterstützen. |
traffic | Gibt an, ob Anfragen gekauften oder organischen Traffic darstellen. |
under | Gibt an, ob Anzeigenanfragen als von Nutzern unter dem gültigen Mindestalter stammend gekennzeichnet werden sollen. |
- Weitere Informationen
Attribute
Optional
childDirectedTreatment
childDirectedTreatment?: boolean
null
gesetzt, um die Konfiguration zu löschen.Optional
limitedAds
limitedAds?: boolean
Sie können GPT auf zwei Arten anweisen, Anzeigen mit eingeschränkter Ausrichtung anzufordern:
- Automatisch über ein Signal von einer IAB TCF 2.0-Plattform zur Einwilligungsverwaltung.
- Manuell, indem Sie den Wert dieses Felds auf
true
setzen.
Hinweis: Wenn eine CMP verwendet wird, ist es nicht erforderlich, die eingeschränkte Anzeigenausrichtung manuell zu aktivieren.
- Beispiel
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (alt)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- Weitere Informationen
Optional
nonPersonalizedAds
nonPersonalizedAds?: boolean
Optional
restrictDataProcessing
restrictDataProcessing?: boolean
Optional
trafficSource
trafficSource?: TrafficSource
undefined
verwendet.- Beispiel
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (alt)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
Optional
underAgeOfConsent
underAgeOfConsent?: boolean
null
gesetzt, um die Konfiguration zu löschen.googletag.PubAdsService
ErweitertMethoden | |
---|---|
add | Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt. Von |
clear | Entfernt die Anzeigen aus den angegebenen Slots und ersetzt sie durch leere Inhalte. |
clear | Eingestellt. Entfernt alle Ausschluss-Labels für Anzeigenkategorien auf Seitenebene. |
clear | Eingestellt. Löscht benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel oder für alle Schlüssel. |
collapse | Eingestellt. Ermöglicht das Minimieren von Slot-Divs, sodass sie keinen Platz auf der Seite einnehmen, wenn kein Anzeigeninhalt angezeigt werden soll. |
disable | Eingestellt. Deaktiviert Anfragen für Anzeigen beim Laden der Seite, ermöglicht aber, dass Anzeigen mit einem PubAdsService.refresh-Aufruf angefordert werden. |
display | Erstellt und zeigt eine Anzeigenfläche mit dem angegebenen Anzeigenblockpfad und der angegebenen Größe an. |
enable | Eingestellt. Aktiviert das Lazy Loading in GPT gemäß dem Konfigurationsobjekt. |
enable | Eingestellt. Aktiviert den Einzelanforderungsmodus zum Abrufen mehrerer Anzeigen gleichzeitig. |
enable | Eingestellt. Signalisiert GPT, dass auf der Seite Videoanzeigen präsentiert werden. |
get | Eingestellt. Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel verknüpft ist. |
get | Eingestellt. Gibt die Attributschlüssel zurück, die für diesen Dienst festgelegt wurden. |
get | Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind. Von |
get | Eingestellt. Gibt einen bestimmten benutzerdefinierten Targeting-Parameter auf Dienstebene zurück, der festgelegt wurde. |
get | Eingestellt. Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel auf Dienstebene zurück, die festgelegt wurden. |
is | Eingestellt. Gibt zurück, ob anfängliche Anfragen für Anzeigen durch einen vorherigen Aufruf von PubAdsService.disableInitialLoad deaktiviert wurden. |
refresh | Ruft neue Anzeigen für bestimmte oder alle Slots auf der Seite ab und zeigt sie an. |
remove | Entfernt einen zuvor registrierten Listener. Von |
set | Eingestellt. Legt Werte für AdSense-Attribute fest, die für alle Anzeigenflächen im Publisher Ads-Dienst gelten. |
set | Eingestellt. Legt einen Ausschluss der Anzeigenkategorie auf Seitenebene für den angegebenen Labelnamen fest. |
set | Eingestellt. Aktiviert und deaktiviert die horizontale Zentrierung von Anzeigen. |
set | Eingestellt. Konfiguriert, ob alle Anzeigen auf der Seite in einem SafeFrame-Container gerendert werden sollen. |
set | Eingestellt. Übermittelt Standortinformationen von Websites, damit Sie Werbebuchungen geografisch auf bestimmte Standorte ausrichten können. |
set | Ermöglicht die Konfiguration aller Datenschutzeinstellungen über eine einzelne API mithilfe eines Konfigurationsobjekts. |
set | Legt den Wert für die vom Publisher bereitgestellte ID fest. |
set | Eingestellt. Legt die Einstellungen auf Seitenebene für die SafeFrame-Konfiguration fest. |
set | Eingestellt. Legt benutzerdefinierte Targeting-Parameter für einen bestimmten Schlüssel fest, die für alle Anzeigenflächen des Publisher Ads-Dienstes gelten. |
set | Eingestellt. Legt die Informationen zum Videocontent fest, die zusammen mit den Anzeigenanfragen für Targeting- und Content-Ausschlusszwecke gesendet werden sollen. |
update | Ändert den Korrelator, der mit Anzeigenanfragen gesendet wird, wodurch effektiv ein neuer Seitenaufruf gestartet wird. |
Methoden
clear
clear(slots?: Slot[]): boolean
Wenn Sie einen Slot leeren, wird die Anzeige insbesondere aus dem langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden daher nicht durch Roadblocks oder Ausschlüsse von konkurrierenden Anzeigen beeinflusst, die diese Anzeige betreffen.
- Beispiel
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (alt)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
Parameter | |
---|---|
| Das Array der zu löschenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots gelöscht. |
Ausgabe | |
---|---|
boolean | Gibt true zurück, wenn Slots gelöscht wurden, andernfalls false . |
clearCategoryExclusions
clearCategoryExclusions(): PubAdsService
- Beispiel
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (alt)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- Weitere Informationen
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
clearTargeting
clearTargeting(key?: string): PubAdsService
- Beispiel
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (alt)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- Weitere Informationen
Parameter | |
---|---|
| Schlüssel des Targeting-Parameters. Der Schlüssel ist optional. Wenn er nicht angegeben wird, werden alle Targeting-Parameter gelöscht. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
collapseEmptyDivs
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
- Weitere Informationen
Parameter | |
---|---|
| Gibt an, ob die Slots minimiert werden sollen, bevor die Anzeigen abgerufen werden. Dieser Parameter ist optional. Wenn er nicht angegeben wird, wird false als Standardwert verwendet. |
Ausgabe | |
---|---|
boolean | Gibt true zurück, wenn der Modus zum Minimieren von DIVs aktiviert wurde, und false , wenn es nicht möglich ist, den Modus zum Minimieren zu aktivieren, da die Methode nach der Aktivierung des Dienstes aufgerufen wurde. |
disableInitialLoad
disableInitialLoad(): void
refresh
anzufordern.- Weitere Informationen
Display
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
Hinweis:Wenn diese Methode aufgerufen wird, wird ein Snapshot des Slot- und Seitenstatus erstellt, um die Konsistenz beim Senden der Anzeigenanfrage und Rendern der Antwort zu gewährleisten. Alle Änderungen, die nach dem Aufrufen dieser Methode am Slot- oder Seitenstatus vorgenommen werden (einschließlich Targeting, Datenschutzeinstellungen, SafeFrame erzwingen usw.), gelten nur für nachfolgende
display()
- oder refresh()
-Anfragen.- Beispiel
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (alt)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- Weitere Informationen
Parameter | |
---|---|
adUnitPath: string | Der Anzeigenblock-Pfad des zu rendernden Slots. |
size: GeneralSize | Breite und Höhe des Slots. |
| Entweder die ID des DIV-Elements, das den Slot enthält, oder das DIV-Element selbst. |
| Die Klick-URL, die für diesen Slot verwendet werden soll. |
enableLazyLoad
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): void
Hinweis:Lazy Fetching in SRA funktioniert nur, wenn sich alle Slots außerhalb des Fetching-Rands befinden.
- Beispiel
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (alt)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Weitere Informationen
Parameter | |
---|---|
| Mit dem Konfigurationsobjekt kann das Lazy-Loading-Verhalten angepasst werden. Für alle ausgelassenen Konfigurationen wird ein von Google festgelegter Standardwert verwendet, der im Laufe der Zeit angepasst wird. Wenn Sie eine bestimmte Einstellung deaktivieren möchten, z. B. eine Abrufmarge, setzen Sie den Wert auf -1 .
|
enableSingleRequest
enableSingleRequest(): boolean
- Weitere Informationen
Ausgabe | |
---|---|
boolean | Gibt true zurück, wenn der Einzelanfragemodus aktiviert wurde, und false , wenn der Einzelanfragemodus nicht aktiviert werden kann, weil die Methode nach der Aktivierung des Dienstes aufgerufen wurde. |
enableVideoAds
enableVideoAds(): void
get
get(key: string): string
- Beispiel
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Weitere Informationen
Parameter | |
---|---|
key: string | Name des Attributs, nach dem gesucht werden soll. |
Ausgabe | |
---|---|
string | Aktueller Wert für den Attributschlüssel oder null , wenn der Schlüssel nicht vorhanden ist. |
getAttributeKeys
getAttributeKeys(): string[]
- Beispiel
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
Ausgabe | |
---|---|
string[] | Array von Attributschlüsseln, die für diesen Dienst festgelegt sind. Die Reihenfolge ist nicht definiert. |
getTargeting
getTargeting(key: string): string[]
- Beispiel
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (alt)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
Parameter | |
---|---|
key: string | Der Targeting-Schlüssel, nach dem gesucht werden soll. |
Ausgabe | |
---|---|
string[] | Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn es keinen solchen Schlüssel gibt. |
getTargetingKeys
getTargetingKeys(): string[]
- Beispiel
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (alt)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
Ausgabe | |
---|---|
string[] | Array von Targeting-Schlüsseln. Die Reihenfolge ist nicht definiert. |
isInitialLoadDisabled
isInitialLoadDisabled(): boolean
Ausgabe | |
---|---|
boolean | Gibt true zurück, wenn ein vorheriger Aufruf von PubAdsService.disableInitialLoad erfolgreich war, andernfalls false . |
Aktualisieren
refresh(slots?: Slot[], options?: {
changeCorrelator: boolean;
}): void
Damit das Verhalten in allen Browsern korrekt ist, muss vor dem Aufrufen von
refresh
ein Aufruf von display
für den Anzeigen-Slot erfolgen. Wenn der Aufruf von display
weggelassen wird, kann es zu unerwartetem Verhalten kommen. Bei Bedarf kann mit der Methode PubAdsService.disableInitialLoad verhindert werden, dass display
eine Anzeige abruft.Wenn ein Slot aktualisiert wird, wird die alte Anzeige aus dem langlebigen Seitenaufruf von GPT entfernt. Zukünftige Anfragen werden daher nicht durch Roadblocks oder Ausschlussklauseln für konkurrierende Anzeigen beeinflusst, die diese Anzeige betreffen.
- Beispiel
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (alt)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Weitere Informationen
Parameter | |
---|---|
| Die zu aktualisierenden Slots. Das Array ist optional. Wenn es nicht angegeben ist, werden alle Slots aktualisiert. |
| Konfigurationsoptionen, die diesem Aktualisierungsaufruf zugeordnet sind.
|
set
set(key: string, value: string): PubAdsService
Wenn diese Funktion für denselben Schlüssel mehrmals aufgerufen wird, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen festgelegt werden, bevor
display
oder refresh
aufgerufen wird.- Beispiel
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (alt)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- Weitere Informationen
Parameter | |
---|---|
key: string | Der Name des Attributs. |
value: string | Attributwert. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): PubAdsService
- Beispiel
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (alt)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Weitere Informationen
Parameter | |
---|---|
categoryExclusion: string | Das Label für den Ausschluss von Anzeigenkategorien, das hinzugefügt werden soll. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
setCentering
setCentering(centerAds: boolean): void
Diese Methode sollte vor dem Aufrufen von
display
oder refresh
aufgerufen werden, da nur Anzeigen, die nach dem Aufrufen dieser Methode angefordert werden, zentriert werden.- Beispiel
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (alt)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
Parameter | |
---|---|
centerAds: boolean | true zum Zentrieren von Anzeigen und false zum Linksbündig ausrichten. |
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
Beachten Sie bei der Verwendung dieser API Folgendes:
- Diese Einstellung wird nur für nachfolgende Anzeigenanfragen für die entsprechenden Slots wirksam.
- Die Einstellung auf Anzeigenflächenebene überschreibt immer die Einstellung auf Seitenebene, sofern sie angegeben ist.
- Wenn der Wert auf
true
festgelegt ist (auf Anzeigenflächen- oder Seitenebene), wird die Anzeige immer mit einem SafeFrame-Container gerendert, unabhängig von der Auswahl in der Google Ad Manager-Benutzeroberfläche. - Wenn der Wert jedoch auf
false
festgelegt oder nicht angegeben ist, wird die Anzeige je nach Art des Creatives und der Auswahl in der Google Ad Manager-Benutzeroberfläche in einem SafeFrame-Container gerendert. - Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken kann, die versuchen, aus ihren iFrames auszubrechen oder darauf angewiesen sind, direkt auf der Seite eines Publishers gerendert zu werden.
- Beispiel
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (alt)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Weitere Informationen
Parameter | |
---|---|
forceSafeFrame: boolean | true , um zu erzwingen, dass alle Anzeigen auf der Seite in SafeFrames gerendert werden, und false , um die vorherige Einstellung in „false“ zu ändern. Wenn Sie diese Einstellung auf false setzen, wenn sie zuvor nicht angegeben wurde, ändert sich nichts. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
setLocation
setLocation(address: string): PubAdsService
- Beispiel
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (alt)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
Parameter | |
---|---|
address: string | Adresse im freien Format. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
setPrivacySettings
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
- Beispiel
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (alt)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- Weitere Informationen
Parameter | |
---|---|
privacySettings: PrivacySettingsConfig | Objekt mit der Konfiguration der Datenschutzeinstellungen. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Funktion aufgerufen wurde. |
setPublisherProvidedId
setPublisherProvidedId(ppid: string): PubAdsService
- Beispiel
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (alt)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Weitere Informationen
Parameter | |
---|---|
ppid: string | Eine alphanumerische ID, die vom Publisher bereitgestellt wird. Muss zwischen 32 und 150 Zeichen lang sein. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
setSafeFrameConfig
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
Diese Einstellungen auf Seitenebene werden durch Einstellungen auf Slot-Ebene überschrieben, sofern diese angegeben sind.
- Beispiel
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (alt)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Weitere Informationen
Parameter | |
---|---|
config: SafeFrameConfig | Das Konfigurationsobjekt. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
setTargeting
setTargeting(key: string, value: string | string[]): PubAdsService
- Beispiel
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (alt)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Weitere Informationen
Parameter | |
---|---|
key: string | Schlüssel des Targeting-Parameters. |
value: string | string[] | Zielgruppenparameterwert oder Array von Werten. |
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
setVideoContent
setVideoContent(videoContentId: string, videoCmsId: string): void
videoContentId
und videoCmsId
die Werte, die dem Google Ad Manager-Dienst für die Contentaufnahme bereitgestellt werden.- Weitere Informationen
Parameter | |
---|---|
videoContentId: string | Die ID des Videoinhalts. |
videoCmsId: string | Die CMS-ID des Videos. |
updateCorrelator
updateCorrelator(): PubAdsService
Hinweis:Dies hat keine Auswirkungen auf den langlebigen Seitenaufruf von GPT, der automatisch die tatsächlich auf der Seite vorhandenen Anzeigen widerspiegelt und keine Ablaufzeit hat.
- Beispiel
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (alt)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
Ausgabe | |
---|---|
PubAdsService | Das Dienstobjekt, für das die Funktion aufgerufen wurde. |
googletag.ResponseInformation
Attribute | |
---|---|
advertiser | Die ID des Werbetreibenden. |
campaign | Die ID der Kampagne. |
creative | Die ID des Creatives. |
creative | Die Vorlagen-ID der Anzeige. |
line | Die ID der Position. |
- Weitere Informationen
Attribute
advertiserId
advertiserId: number
campaignId
campaignId: number
creativeId
creativeId: number
creativeTemplateId
creativeTemplateId: number
lineItemId
lineItemId: number
googletag.RewardedPayload
Attribute | |
---|---|
amount | Die Anzahl der Artikel, die in der Prämie enthalten sind. |
type | Der Typ des in der Prämie enthaltenen Artikels, z. B. „Münze“. |
- Weitere Informationen
Attribute
amount
amount: number
type
type: string
googletag.Service
Methoden | |
---|---|
add | Registriert einen Listener, mit dem Sie eine JavaScript-Funktion einrichten und aufrufen können, wenn ein bestimmtes GPT-Ereignis auf der Seite eintritt. |
get | Ruft die Liste der Slots ab, die mit diesem Dienst verknüpft sind. |
remove | Entfernt einen zuvor registrierten Listener. |
Methoden
addEventListener
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- Beispiel
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
Parameter | |
---|---|
eventType: K | Ein String, der den von GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet. |
listener: ((arg: EventTypeMap[K]) => void) | Funktion, die ein einzelnes Event-Objekt als Argument akzeptiert. |
Ausgabe | |
---|---|
Service | Das Dienstobjekt, für das die Methode aufgerufen wurde. |
getSlots
removeEventListener
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
- Beispiel
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (alt)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
Parameter | |
---|---|
eventType: K | Ein String, der den von GPT generierten Ereignistyp darstellt. Bei Ereignistypen wird die Groß- und Kleinschreibung beachtet. |
listener: ((event: EventTypeMap[K]) => void) | Funktion, die ein einzelnes Event-Objekt als Argument akzeptiert. |
googletag.SizeMappingBuilder
Methoden | |
---|---|
add | Fügt eine Zuordnung von einem Array mit einer Größe (das den Darstellungsbereich darstellt) zu einem Array mit einer oder mehreren Größen hinzu, das den Slot darstellt. |
build | Erstellt eine Spezifikation für die Größenübersicht aus den Zuordnungen, die diesem Builder hinzugefügt wurden. |
- Weitere Informationen
Methoden
addSize
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
- 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]
Parameter | |
---|---|
viewportSize: SingleSizeArray | Die Größe des Darstellungsbereichs für diesen Zuordnungseintrag. |
slotSize: GeneralSize | Die Größen des Slots für diesen Zuordnungseintrag. |
Ausgabe | |
---|---|
SizeMappingBuilder | Ein Verweis auf diesen Builder. |
build
build(): SizeMappingArray
Wenn ungültige Zuordnungen angegeben wurden, gibt diese Methode
null
zurück. Andernfalls wird eine Spezifikation im richtigen Format zurückgegeben, die an Slot.defineSizeMapping übergeben werden kann.Hinweis: Das Verhalten des Builders nach dem Aufrufen dieser Methode ist nicht definiert.
Ausgabe | |
---|---|
SizeMappingArray | Das von diesem Builder erstellte Ergebnis. Kann null sein, wenn ungültige Größenzuordnungen angegeben wurden. |
googletag.Slot
Methoden | |
---|---|
add | Fügt diesem Slot einen Service hinzu. |
clear | Eingestellt. Entfernt alle Ausschluss-Labels für Anzeigenkategorien auf Slot-Ebene für diesen Slot. |
clear | Eingestellt. Löscht bestimmte oder alle benutzerdefinierten Targeting-Parameter auf Slot-Ebene für diesen Slot. |
define | Legt ein Array von Zuordnungen von einer Mindestgröße des Darstellungsbereichs zur Slotgröße für diesen Slot fest. |
get | Eingestellt. Gibt den Wert für das AdSense-Attribut zurück, das mit dem angegebenen Schlüssel für diesen Slot verknüpft ist. |
get | Gibt den vollständigen Pfad des Anzeigenblocks mit dem Netzwerkcode und dem Anzeigenblockpfad zurück. |
get | Eingestellt. Gibt die Liste der Attributschlüssel zurück, die für diesen Slot festgelegt sind. |
get | Eingestellt. Gibt die Labels für den Anzeigenausschluss für diese Anzeigenfläche zurück. |
get | Ruft allgemeine Konfigurationsoptionen für den Slot ab, die mit setConfig festgelegt wurden. |
get | Gibt die Informationen zur Anzeigenantwort zurück. |
get | Gibt die ID des Slots div zurück, die bei der Definition des Slots angegeben wurde. |
get | Eingestellt. Gibt einen bestimmten benutzerdefinierten Targeting-Parameter zurück, der für diesen Slot festgelegt ist. |
get | Eingestellt. Gibt die Liste aller benutzerdefinierten Targeting-Schlüssel zurück, die für diesen Slot festgelegt sind. |
set | Eingestellt. Legt einen Wert für ein AdSense-Attribut für diesen Anzeigenblock fest. |
set | Eingestellt. Legt ein Label für den Ausschluss von Anzeigenkategorien auf Anzeigenflächenebene für diese Anzeigenfläche fest. |
set | Eingestellt. Legt die Klick-URL fest, zu der Nutzer nach dem Klicken auf die Anzeige weitergeleitet werden. |
set | Eingestellt. Legt fest, ob der Slot div ausgeblendet werden soll, wenn keine Anzeige im Slot vorhanden ist. |
set | Legt allgemeine Konfigurationsoptionen für diesen Slot fest. |
set | Eingestellt. Konfiguriert, ob Anzeigen in dieser Anzeigenfläche in einem SafeFrame-Container gerendert werden sollen. |
set | Eingestellt. Legt die Einstellungen auf Slot-Ebene für die SafeFrame-Konfiguration fest. |
set | Eingestellt. Legt einen benutzerdefinierten Targeting-Parameter für diesen Slot fest. |
update | Eingestellt. Legt benutzerdefinierte Targeting-Parameter für diesen Slot aus einer Schlüssel/Wert-Zuordnung in einem JSON-Objekt fest. |
Methoden
addService
addService(service: Service): Slot
- Beispiel
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (alt)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Weitere Informationen
Parameter | |
---|---|
service: Service | Der hinzuzufügende Dienst. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
clearCategoryExclusions
clearCategoryExclusions(): Slot
- Beispiel
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (alt)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
clearTargeting
clearTargeting(key?: string): Slot
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Weitere Informationen
Parameter | |
---|---|
| Schlüssel des Targeting-Parameters. Der Schlüssel ist optional. Wenn er nicht angegeben wird, werden alle Targeting-Parameter gelöscht. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
defineSizeMapping
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping!);
- Weitere Informationen
Parameter | |
---|---|
sizeMapping: SizeMappingArray | Array von Größen-Mappings. Sie können SizeMappingBuilder verwenden, um sie zu erstellen. Jede Größen-Zuordnung ist ein Array mit zwei Elementen: SingleSizeArray und GeneralSize. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
get
get(key: string): string
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- Weitere Informationen
Parameter | |
---|---|
key: string | Name des Attributs, nach dem gesucht werden soll. |
Ausgabe | |
---|---|
string | Aktueller Wert für den Attributschlüssel oder null , wenn der Schlüssel nicht vorhanden ist. |
getAdUnitPath
getAdUnitPath(): string
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
Ausgabe | |
---|---|
string | Anzeigenblock-Pfad. |
getAttributeKeys
getAttributeKeys(): string[]
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
Ausgabe | |
---|---|
string[] | Array von Attributschlüsseln. Die Reihenfolge ist nicht definiert. |
getCategoryExclusions
getCategoryExclusions(): string[]
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
Ausgabe | |
---|---|
string[] | Die Ausschluss-Labels für Anzeigenkategorien für diesen Slot oder ein leeres Array, wenn keine festgelegt wurden. |
getConfig
getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">
Nicht alle
setConfig()
-Attribute werden von dieser Methode unterstützt. Unterstützte Eigenschaften:- Beispiel
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); // Get the value of the `targeting` setting. const targetingConfig = slot.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `categoryExclusion` settings. const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
JavaScript (alt)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); // Get the value of the `targeting` setting. var targetingConfig = slot.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `categoryExclusion` settings. var config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; // Get the value of the `targeting` setting. const targetingConfig = slot.getConfig("targeting"); // Get the value of the `adsenseAttributes` and `categoryExclusion` settings. const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
Parameter | |
---|---|
keys: string | string[] | Die Schlüssel der abzurufenden Konfigurationsoptionen. |
Ausgabe | |
---|---|
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion"> | Die Konfigurationsoptionen für den Slot. |
getResponseInformation
getResponseInformation(): ResponseInformation
null
zurückgegeben.Ausgabe | |
---|---|
ResponseInformation | Die neuesten Informationen zur Anzeigenantwort oder null , wenn die Anzeigenfläche keine Anzeige enthält. |
getSlotElementId
getSlotElementId(): string
div
zurück, die bei der Definition des Slots angegeben wurde.- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
Ausgabe | |
---|---|
string | ID des Slots div . |
getTargeting
getTargeting(key: string): string[]
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
Parameter | |
---|---|
key: string | Der Targeting-Schlüssel, nach dem gesucht werden soll. |
Ausgabe | |
---|---|
string[] | Die mit diesem Schlüssel verknüpften Werte oder ein leeres Array, wenn es keinen solchen Schlüssel gibt. |
getTargetingKeys
getTargetingKeys(): string[]
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
Ausgabe | |
---|---|
string[] | Array von Targeting-Schlüsseln. Die Reihenfolge ist nicht definiert. |
set
set(key: string, value: string): Slot
Wenn Sie diese Methode mehrmals für denselben Schlüssel aufrufen, werden zuvor festgelegte Werte für diesen Schlüssel überschrieben. Alle Werte müssen festgelegt werden, bevor
display
oder refresh
aufgerufen wird.- Beispiel
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (alt)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- Weitere Informationen
Parameter | |
---|---|
key: string | Der Name des Attributs. |
value: string | Attributwert. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
setCategoryExclusion
setCategoryExclusion(categoryExclusion: string): Slot
- Beispiel
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (alt)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- Weitere Informationen
Parameter | |
---|---|
categoryExclusion: string | Das Label für den Ausschluss von Anzeigenkategorien, das hinzugefügt werden soll. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
setClickUrl
setClickUrl(value: string): Slot
Die Google Ad Manager-Server erfassen weiterhin einen Klick, auch wenn die Klick-URL ersetzt wird. Jede Landingpage-URL, die mit dem ausgelieferten Creative verknüpft ist, wird an den angegebenen Wert angehängt. Bei nachfolgenden Aufrufen wird der Wert überschrieben. Dies funktioniert nur für Anfragen ohne SRA.
- Beispiel
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
Parameter | |
---|---|
value: string | Die festzulegende Klick-URL. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
setCollapseEmptyDiv
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
div
ausgeblendet werden soll, wenn keine Anzeige im Slot vorhanden ist. Dadurch werden die Einstellungen auf Dienstebene überschrieben.- Beispiel
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Weitere Informationen
Parameter | |
---|---|
collapse: boolean | Gibt an, ob die Anzeigenfläche minimiert werden soll, wenn keine Anzeige zurückgegeben wird. |
| Gibt an, ob die Anzeigenfläche minimiert werden soll, noch bevor eine Anzeige abgerufen wird. Wird ignoriert, wenn „collapse“ nicht true ist. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
setConfig
setConfig(slotConfig: SlotSettingsConfig): void
Parameter | |
---|---|
slotConfig: SlotSettingsConfig | Das Konfigurationsobjekt. |
setForceSafeFrame
setForceSafeFrame(forceSafeFrame: boolean): Slot
Beachten Sie bei der Verwendung dieser API Folgendes:
- Diese Einstellung wird nur für nachfolgende Anzeigenanfragen für die entsprechenden Slots wirksam.
- Die Einstellung auf Anzeigenflächenebene überschreibt immer die Einstellung auf Seitenebene, sofern sie angegeben ist.
- Wenn der Wert auf
true
festgelegt ist (auf Anzeigenflächen- oder Seitenebene), wird die Anzeige immer mit einem SafeFrame-Container gerendert, unabhängig von der Auswahl in der Google Ad Manager-Benutzeroberfläche. - Wenn der Wert jedoch auf
false
festgelegt oder nicht angegeben ist, wird die Anzeige je nach Art des Creatives und der Auswahl in der Google Ad Manager-Benutzeroberfläche in einem SafeFrame-Container gerendert. - Diese API sollte mit Vorsicht verwendet werden, da sie sich auf das Verhalten von Creatives auswirken kann, die versuchen, aus ihren iFrames auszubrechen oder darauf angewiesen sind, direkt auf der Seite eines Publishers gerendert zu werden.
- Beispiel
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (alt)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- Weitere Informationen
Parameter | |
---|---|
forceSafeFrame: boolean | true , um zu erzwingen, dass alle Anzeigen in diesem Slot in SafeFrames gerendert werden, und false , um eine Einstellung auf Seitenebene zu deaktivieren (falls vorhanden). Wenn Sie diese Einstellung auf false setzen, wenn sie nicht auf Seitenebene angegeben ist, ändert sich nichts. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
setSafeFrameConfig
setSafeFrameConfig(config: SafeFrameConfig): Slot
Diese Einstellungen auf Slot-Ebene überschreiben, sofern angegeben, alle Einstellungen auf Seitenebene.
- Beispiel
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (alt)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Weitere Informationen
Parameter | |
---|---|
config: SafeFrameConfig | Das Konfigurationsobjekt. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
setTargeting
setTargeting(key: string, value: string | string[]): Slot
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Weitere Informationen
Parameter | |
---|---|
key: string | Schlüssel des Targeting-Parameters. |
value: string | string[] | Zielgruppenparameterwert oder Array von Werten. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
updateTargetingFromMap
updateTargetingFromMap(map: {
[adUnitPath: string]: string | string[];
}): Slot
Hinweise
- Im Fall des Überschreibens wird nur der letzte Wert beibehalten.
- Wenn der Wert ein Array ist, wird jeder vorherige Wert überschrieben, nicht zusammengeführt.
- Hier festgelegte Werte überschreiben Targeting-Parameter, die auf Dienstebene festgelegt wurden.
- Beispiel
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (alt)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
Parameter | |
---|---|
map: { | Schlüssel/Wert-Paare für Targeting-Parameter. |
Ausgabe | |
---|---|
Slot | Das Slot-Objekt, für das die Methode aufgerufen wurde. |
googletag.config
Schnittstellen | |
---|---|
Ad | Einstellungen zum Steuern der Anzeigenerweiterung. |
Ad | Einstellungen zur Steuerung des Verhaltens von AdSense-Anzeigen. |
Component | Ein Objekt, das eine einzelne Komponentenauktion in einer On-Device-Anzeigenauktion darstellt. |
Interstitial | Ein Objekt, das das Verhalten eines einzelnen Interstitial-Anzeigen-Slots definiert. |
Lazy | Einstellungen zur Steuerung der Verwendung von Lazy Loading in GPT. |
Page | Hauptkonfigurationsoberfläche für Einstellungen auf Seitenebene. |
Privacy | Einstellungen zum Steuern der Datenschutzmaßnahmen für Publisher. |
Publisher | Konfigurationsobjekt für vom Publisher bereitgestellte Signale (Publisher Provided Signals, PPS). |
Safe | Einstellungen zum Steuern von SafeFrame in GPT. |
Slot | Hauptkonfigurationsoberfläche für Einstellungen auf Slot-Ebene. |
Taxonomy | Ein Objekt mit den Werten für eine einzelne Taxonomie. |
Video | Einstellungen zum Konfigurieren von Einstellungen für Videoanzeigen. |
Typaliasse | |
---|---|
Collapse | Unterstützte Werte zum Steuern des Minimierungsverhaltens von Anzeigenflächen. |
Interstitial | Unterstützte Interstitial-Anzeigentrigger. |
Privacy | Unterstützte Publisher-Datenschutzbehandlungen. |
Taxonomy | Unterstützte Taxonomien für vom Publisher bereitgestellte Signale (PPS). |
Typaliasse
CollapseDivBehavior
CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"
- Weitere Informationen
InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar"
PrivacyTreatment
PrivacyTreatment: "disablePersonalization"
Taxonomie
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
- Weitere Informationen
googletag.config.AdExpansionConfig
Attribute | |
---|---|
enabled | Gibt an, ob die Anzeigenerweiterung aktiviert oder deaktiviert ist. |
- Beispiel
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (alt)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
Attribute
Optional
aktiviert
enabled?: boolean
Wenn Sie diesen Wert festlegen, wird die in Google Ad Manager konfigurierte Standardeinstellung überschrieben.
googletag.config.AdSenseAttributesConfig
Mit diesen Attributen können serverseitige Einstellungen pro Anfrage überschrieben werden.
Attribute | |
---|---|
adsense | AdSense-Anzeigenformat |
adsense | AdSense-Channel-IDs. |
adsense | Gibt an, ob der Testmodus aktiviert ist. |
document | Sprache der Seite, auf der Anzeigen ausgeliefert werden. |
page | URL der Seite, auf der Anzeigen ausgeliefert werden. |
- Weitere Informationen
Attribute
Optional
adsense_ad_format
adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"
Optional
adsense_channel_ids
adsense_channel_ids?: string
Zulässige Werte sind Channel-IDs, die durch „+“ getrennt sind.
Beispiel:
271828183+314159265
- Weitere Informationen
Optional
adsense_test_mode
adsense_test_mode?: "on"
Wenn der Wert auf
on
festgelegt ist, werden Anzeigen als „Nur für Testzwecke“ gekennzeichnet und nicht für die Zählung oder Abrechnung berücksichtigt. Diese Einstellung muss für Produktions- und Nicht-Test-Traffic deaktiviert werden.Optional
document_language
document_language?: string
Zulässige Werte sind gültige ISO 639-1-Sprachcodes.
Beispiel:
en
- Weitere Informationen
Optional
page_url
page_url?: string
Zulässige Werte sind gültige URLs.
Beispiel:
http://www.example.com
googletag.config.ComponentAuctionConfig
Attribute | |
---|---|
auction | Ein Auktionskonfigurationsobjekt für diese Komponentenauktion. |
config | Der Konfigurationsschlüssel, der mit dieser Komponentenauktion verknüpft ist. |
- Weitere Informationen
Attribute
auctionConfig
auctionConfig: {
auctionSignals?: unknown;
decisionLogicURL: string;
interestGroupBuyers?: string[];
perBuyerExperimentGroupIds?: {
[buyer: string]: number;
};
perBuyerGroupLimits?: {
[buyer: string]: number;
};
perBuyerSignals?: {
[buyer: string]: unknown;
};
perBuyerTimeouts?: {
[buyer: string]: number;
};
seller: string;
sellerExperimentGroupId?: number;
sellerSignals?: unknown;
sellerTimeout?: number;
trustedScoringSignalsURL?: string;
}
Wenn dieser Wert auf
null
festgelegt ist, wird jede vorhandene Konfiguration für die angegebene configKey
gelöscht.- Beispiel
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (alt)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicURL's origin seller: "https://testSeller.com", decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- Weitere Informationen
configKey
configKey: string
Dieser Wert darf nicht leer sein und sollte eindeutig sein. Wenn zwei
ComponentAuctionConfig
-Objekte denselben configKey-Wert haben, wird die letzte Konfiguration, die festgelegt wird, die vorherigen Konfigurationen überschreiben.googletag.config.InterstitialConfig
Attribute | |
---|---|
require | Gibt an, ob eine Einwilligung für die lokale Speicherung erforderlich ist, um dieses Interstitial zu präsentieren. |
triggers | Die Konfiguration des Interstitial-Triggers für diese Interstitial-Anzeige. |
Attribute
Optional
requireStorageAccess
requireStorageAccess?: boolean
GPT verwendet den lokalen Speicher, um ein Frequency Capping für Interstitials durchzusetzen. Nutzer, die keine Einwilligung zur lokalen Speicherung erteilt haben, können jedoch weiterhin Interstitial-Anzeigen sehen. Wenn Sie diese Eigenschaft auf
true
festlegen, wird das Standardverhalten deaktiviert und Interstitial-Anzeigen werden nur Nutzern präsentiert, die der lokalen Speicherung zugestimmt haben.- Beispiel
JavaScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
JavaScript (alt)
// Opt out of showing interstitials to users // without local storage consent. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
TypeScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
- Weitere Informationen
Optional
Triggers
triggers?: Partial<Record<InterstitialTrigger, boolean>>
Wenn Sie den Wert eines Interstitial-Triggers auf
true
setzen, wird er aktiviert. Wenn Sie ihn auf false
setzen, wird er deaktiviert. Dadurch werden die in Google Ad Manager konfigurierten Standardwerte überschrieben.- Beispiel
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (alt)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Weitere Informationen
googletag.config.LazyLoadConfig
Attribute | |
---|---|
fetch | Der Mindestabstand einer Anzeigenfläche vom aktuellen Darstellungsbereich, bevor eine Anzeige angefordert wird. Er wird als Prozentsatz der Darstellungsbereichsgröße ausgedrückt. |
mobile | Ein Multiplikator, der auf Ränder auf Mobilgeräten angewendet wird. |
render | Der Mindestabstand einer Anzeigenfläche vom aktuellen Darstellungsbereich, bevor eine Anzeige gerendert wird. Er wird als Prozentsatz der Darstellungsbereichsgröße ausgedrückt. |
- Weitere Informationen
Attribute
Optional
fetchMarginPercent
fetchMarginPercent?: number
In Verbindung mit renderMarginPercent ermöglicht diese Einstellung das Vorabrufen einer Anzeige, aber das Warten auf das Rendern und Herunterladen anderer untergeordneter Ressourcen. Dieser Wert sollte daher immer größer oder gleich renderMarginPercent sein.
Ein Wert von
0
bedeutet „wenn der Slot in den sichtbaren Bereich gelangt“, 100
bedeutet „wenn die Anzeige einen sichtbaren Bereich entfernt ist“ usw.Optional
mobileScaling
mobileScaling?: number
So können unterschiedliche Ränder für Mobilgeräte und Computer festgelegt werden, da sich die Darstellungsbereiche und Scrollgeschwindigkeiten unterscheiden können. Bei einem Wert von 2,0 werden beispielsweise alle Ränder auf Mobilgeräten verdoppelt.Dadurch wird der Mindestabstand, den ein Slot vom Viewport haben kann, bevor er abgerufen und gerendert wird, erhöht.
Optional
renderMarginPercent
renderMarginPercent?: number
In Verbindung mit fetchMarginPercent ermöglicht diese Einstellung das Vorabrufen einer Anzeige, aber das Warten auf das Rendern und Herunterladen anderer untergeordneter Ressourcen. Dieser Wert sollte daher immer kleiner oder gleich fetchMarginPercent sein.
Ein Wert von
0
bedeutet „wenn der Slot in den sichtbaren Bereich gelangt“, 100
bedeutet „wenn die Anzeige einen sichtbaren Bereich entfernt ist“ usw.googletag.config.PageSettingsConfig
Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf.
Alle unten aufgeführten Properties sind Beispiele und spiegeln nicht die tatsächlichen Funktionen wider, die „setConfig“ verwenden. Die Gruppe von Funktionen finden Sie unten in den Feldern des Typs „PageSettingsConfig“.
Beispiele:
- Es werden nur die Funktionen geändert, die im googletag.setConfig-Aufruf angegeben sind.
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Alle Einstellungen für ein bestimmtes Feature werden mit jedem Aufruf von googletag.setConfig aktualisiert.
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Alle Einstellungen für eine Funktion können durch Übergabe von
null
gelöscht werden.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
Attribute | |
---|---|
ad | Einstellungen zum Steuern der Anzeigenerweiterung. |
adsense | Einstellung zum Konfigurieren von AdSense-Attributen. |
ad | Eingestellt. |
category | Einstellung zum Konfigurieren von Ausschlüssen für Anzeigenkategorien. |
centering | Einstellung zum Steuern der horizontalen Zentrierung von Anzeigen. |
collapse | Mit dieser Einstellung lässt sich das Minimierungsverhalten von Anzeigenflächen steuern. |
disable | Einstellung, mit der gesteuert wird, wann Anzeigen angefordert werden. |
lazy | Einstellungen zur Steuerung der Verwendung von Lazy Loading in GPT. |
location | Einstellung für das geografische Targeting von Werbebuchungen auf Standorte. |
pps | Einstellungen zum Steuern von vom Publisher bereitgestellten Signalen (PPS). |
privacy | Einstellungen zum Steuern der Datenschutzmaßnahmen für Publisher. |
safe | Einstellungen zur Steuerung der Verwendung von SafeFrame in GPT. |
single | Einstellung zum Aktivieren oder Deaktivieren der Einzelanfrage-Architektur |
targeting | Einstellung zum Steuern des Schlüssel/Wert-Paar-Targetings. |
thread | Einstellung, mit der gesteuert wird, ob der JS-Thread von GPT freigegeben werden soll, wenn Creatives angefordert und gerendert werden. |
video | Einstellungen zum Steuern von Videoanzeigen |
Attribute
Optional
adExpansion
adExpansion?: AdExpansionConfig
Optional
adsenseAttributes
adsenseAttributes?: AdSenseAttributesConfig
Über diese Einstellung konfigurierte AdSense-Attribute werden auf alle Anzeigenblöcke auf der Seite angewendet. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Attributwerte zu definieren oder vorhandene Werte zu überschreiben.
Änderungen an AdSense-Attributen werden nur auf Anzeigen angewendet, die nach dem Aufrufen dieser Methode angefordert werden. Aus diesem Grund wird empfohlen, diese Methode vor Aufrufen von googletag.display oder PubAdsService.refresh aufzurufen.
- Beispiel
JavaScript
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
JavaScript (alt)
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
TypeScript
// Set the document language and page URL. googletag.setConfig({ adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" }, }); // Clear the page URL only. googletag.setConfig({ adsenseAttributes: { page_url: null } }); // Clear all AdSense attributes. googletag.setConfig({ adsenseAttributes: null });
Optional
adYield
adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
Optional
categoryExclusion
categoryExclusion?: string[]
- Beispiel
JavaScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
JavaScript (alt)
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
TypeScript
// Label = AirlineAd. googletag.setConfig({ categoryExclusion: ["AirlineAd"] }); // Clearing category exclusion setting. googletag.setConfig({ categoryExclusion: null });
- Weitere Informationen
Optional
Zentrierung
centering?: boolean
Horizontale Zentrierungsänderungen werden nur auf Anzeigen angewendet, die nach dem Aufrufen dieser Methode angefordert werden. Aus diesem Grund wird empfohlen, diese Methode vor Aufrufen von googletag.display oder PubAdsService.refresh aufzurufen.
- Beispiel
JavaScript
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
JavaScript (alt)
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
TypeScript
// Make ads centered. googletag.setConfig({ centering: true }); // Clear the centering setting. googletag.setConfig({ centering: null });
Optional
collapseDiv
collapseDiv?: CollapseDivBehavior
Eine minimierte Anzeigenfläche nimmt keinen Platz auf der Seite ein.
Unterstützte Werte:
null
(Standard): Der Slot wird nicht minimiert.DISABLED
: Die Anzeigenfläche wird nicht minimiert, unabhängig davon, ob eine Anzeige zurückgegeben wird.BEFORE_FETCH
: Die Anzeigenfläche ist anfangs minimiert und wird maximiert, wenn eine Anzeige zurückgegeben wird.ON_NO_FILL
: Die Anzeigenfläche wird zuerst maximiert und dann minimiert, wenn keine Anzeige zurückgegeben wird.
- Beispiel
JavaScript
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
JavaScript (alt)
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
TypeScript
// Collapse the div for this slot if no ad is returned. googletag.setConfig({ collapseDiv: "ON_NO_FILL" }); // Collapse the div for this slot by default, and expand only // if an ad is returned. googletag.setConfig({ collapseDiv: "BEFORE_FETCH" }); // Do not collapse the div for this slot. googletag.setConfig({ collapseDiv: "DISABLED" }); // Clear the collapse setting. googletag.setConfig({ collapseDiv: null });
- Weitere Informationen
Optional
disableInitialLoad
disableInitialLoad?: boolean
Standardmäßig werden mit der Methode googletag.display sowohl Anzeigenflächen registriert als auch Anzeigen für sie angefordert. Es gibt jedoch Fälle, in denen es besser ist, diese Aktionen zu trennen, um genauer zu steuern, wann Anzeigeninhalte geladen werden.
Wenn Sie diese Einstellung aktivieren, werden Anzeigen für registrierte Slots nicht angefordert, wenn die Methode
display()
aufgerufen wird. Stattdessen muss ein separater Aufruf von PubAdsService.refresh erfolgen, um eine Anzeigenanfrage zu starten.Diese Methode muss vor dem Aufruf von googletag.enableServices aufgerufen werden.
- Beispiel
JavaScript
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
JavaScript (alt)
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
TypeScript
// Prevent requesting ads when `display()` is called. googletag.setConfig({ disableInitialLoad: true });
- Weitere Informationen
Optional
lazyLoad
lazyLoad?: LazyLoadConfig
Lazy Loading ist eine Technik, mit der das Anfordern und Rendern von Anzeigen verzögert wird, bis sie sich dem Darstellungsbereich des Nutzers nähern. Ein detaillierteres Beispiel finden Sie im Lazy Loading-Beispiel.
Hinweis:Wenn
singleRequest
aktiviert ist, funktioniert das verzögerte Abrufen nur, wenn sich alle Slots außerhalb des Abrufrands befinden.Für alle Lazy Loading-Einstellungen, die beim Aufrufen von
setConfig()
nicht angegeben werden, wird ein von Google festgelegter Standardwert verwendet. Diese Standardeinstellungen können im Laufe der Zeit angepasst werden. Wenn Sie eine bestimmte Einstellung deaktivieren möchten, setzen Sie den Wert auf null
.- Beispiel
JavaScript
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
JavaScript (alt)
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
TypeScript
// Enable lazy loading. googletag.setConfig({ lazyLoad: { // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, }, }); // Clear fetch margin only. googletag.setConfig({ lazyLoad: { fetchMarginPercent: null }, }); // Clear all lazy loading settings. googletag.setConfig({ lazyLoad: null });
- Weitere Informationen
Optional
Standort
location?: string
- Beispiel
JavaScript
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
JavaScript (alt)
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
TypeScript
// Geo-target line items to US postal code 10001. googletag.setConfig({ location: "10001,US" }); // Clear the location setting. googletag.setConfig({ location: null });
- Weitere Informationen
Optional
pps
Optional
privacyTreatments
privacyTreatments?: PrivacyTreatmentsConfig
Optional
safeFrame
safeFrame?: SafeFrameConfig
Über diese Einstellung konfigurierte Werte gelten für alle Anzeigenblöcke auf der Seite. Diese Werte können für einzelne Anzeigenflächen über SlotSettingsConfig.safeFrame überschrieben werden.
- Beispiel
JavaScript
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
JavaScript (alt)
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
TypeScript
// Force SafeFrame for all ads on the page. googletag.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion. googletag.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting. googletag.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings. googletag.setConfig({ safeFrame: null });
Optional
singleRequest
singleRequest?: boolean
Wenn die SRA aktiviert ist, werden alle Anzeigenflächen, die vor einem googletag.display- oder PubAdsService.refresh-Aufruf definiert wurden, in einer einzigen Anzeigenanfrage zusammengefasst. Das bietet Leistungsvorteile und ist auch erforderlich, damit Roadblocks und Konkurrenzausschlüsse berücksichtigt werden.
Wenn die Einzelanfrage-Architektur deaktiviert ist, wird jede Anzeigenfläche einzeln angefordert. Das ist das Standardverhalten von GPT.
Diese Methode muss vor dem Aufrufen von googletag.enableServices aufgerufen werden.
- Beispiel
JavaScript
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
JavaScript (alt)
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
TypeScript
// Enable Single Request Architecture. googletag.setConfig({ singleRequest: true });
Optional
Targeting
targeting?: Record<string, string | string[]>
Das über diese Einstellung konfigurierte Targeting wird auf alle Anzeigenflächen auf der Seite angewendet. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Targeting-Schlüssel/Wert-Paare zu definieren oder vorhandene Werte zu überschreiben. Targeting-Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.
- Beispiel
JavaScript
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
JavaScript (alt)
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
TypeScript
// Setting a single targeting key-value. googletag.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key googletag.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. googletag.setConfig({ targeting: { interests: null } });
- Weitere Informationen
Optional
threadYield
threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
GPT gibt den Thread nur für Browser frei, die die API „Scheduler.postTask“ oder „Scheduler.yield“ unterstützen.
Unterstützte Werte:
null
(Standard): GPT gibt den JS-Thread für Slots außerhalb des Darstellungsbereichs frei.ENABLED_ALL_SLOTS
: GPT gibt den JS-Thread für alle Slots frei, unabhängig davon, ob sich der Slot im Darstellungsbereich befindet.DISABLED
: GPT gibt den JS-Thread nicht frei.
- Beispiel
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript (alt)
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- Weitere Informationen
Optional
videoAds
videoAds?: VideoAdsConfig
- Beispiel
JavaScript
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
JavaScript (alt)
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
TypeScript
// Enable video ads and set video content and content source IDs. googletag.setConfig({ videoAds: { enableVideoAds: true, videoContentId: "e1eGlRL7ju8", videoCmsId: "1234567", }, });
- Weitere Informationen
googletag.config.PrivacyTreatmentsConfig
Attribute | |
---|---|
treatments | Ein Array von Publisher Privacy Treatments, die aktiviert werden können. |
Attribute
Behandlungen
treatments: "disablePersonalization"[]
- 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
Attribute | |
---|---|
taxonomies | Ein Objekt mit Taxonomy-Zuordnungen oder „null“, um die Konfiguration zu löschen. |
- Beispiel
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (alt)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
Attribute
Taxonomien
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
googletag.config.SafeFrameConfig
Attribute | |
---|---|
allow | Gibt an, ob Anzeigeninhalte in SafeFrames durch Überlagerung von Seiteninhalten erweitert werden dürfen. |
allow | Ob Anzeigeninhalte durch Verschieben von Seiteninhalten erweitert werden dürfen. |
force | Gibt an, ob Anzeigen in einem SafeFrame-Container gerendert werden sollen. |
sandbox | Gibt an, ob SafeFrame das HTML5-Attribut „sandbox“ verwenden soll, um eine Navigation auf der obersten Ebene ohne Nutzerinteraktion zu verhindern. |
use | Eingestellt. Gibt an, ob für Reservierungs-Creatives zufällige Subdomains verwendet werden sollen. |
- Weitere Informationen
Attribute
Optional
allowOverlayExpansion
allowOverlayExpansion?: boolean
Optional
allowPushExpansion
allowPushExpansion?: boolean
Optional
forceSafeFrame
forceSafeFrame?: boolean
Optional
sandbox
sandbox?: boolean
true
(kann nicht auf false
festgelegt werden). Beachten Sie, dass durch das Attribut „sandbox“ Plug-ins (z.B. Flash) deaktiviert werden.Optional
useUniqueDomain
useUniqueDomain?: boolean
null
, um den gespeicherten Wert zu löschen.Hinweis: Diese Funktion ist standardmäßig aktiviert.
- Weitere Informationen
googletag.config.SlotSettingsConfig
Ermöglicht das Festlegen mehrerer Funktionen mit einem einzigen API-Aufruf für einen einzelnen Slot.
Alle unten aufgeführten Attribute sind Beispiele und spiegeln nicht die tatsächlichen Funktionen wider, die „setConfig“ verwenden. Die Gruppe von Funktionen finden Sie unten in den Feldern des Typs „SlotSettingsConfig“.
Beispiele:
- Es werden nur die Funktionen geändert, die im Slot.setConfig-Aufruf angegeben sind.
const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- Alle Einstellungen für ein bestimmtes Feature werden bei jedem Aufruf von Slot.setConfig aktualisiert.
// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- Alle Einstellungen für eine Funktion können durch Übergabe von
null
gelöscht werden.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
Attribute | |
---|---|
ad | Einstellungen zum Konfigurieren der Anzeigenerweiterung. |
adsense | Einstellung zum Konfigurieren von AdSense-Attributen. |
category | Einstellung zum Konfigurieren von Ausschlüssen für Anzeigenkategorien. |
click | Einstellung zum Konfigurieren der URL, zu der Nutzer nach dem Klicken auf die Anzeige weitergeleitet werden. |
collapse | Einstellung zum Konfigurieren des Minimierungsverhaltens des Anzeigen-Slots. |
component | Ein Array von Komponentenauktionen, die in eine On-Device-Anzeigenauktion aufgenommen werden sollen. |
interstitial | Einstellungen, mit denen das Verhalten von Interstitial-Anzeigen-Slots konfiguriert wird. |
safe | Einstellungen zum Konfigurieren der Verwendung von SafeFrame in GPT. |
targeting | Einstellung zum Konfigurieren des Schlüssel/Wert-Targetings. |
Attribute
Optional
adExpansion
adExpansion?: AdExpansionConfig
- Weitere Informationen
Optional
adsenseAttributes
adsenseAttributes?: AdSenseAttributesConfig
Über diese Einstellung konfigurierte AdSense-Attribute gelten nur für den Anzeigen-Slot. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Attributwerte zu definieren oder vorhandene Werte zu überschreiben.
Änderungen an AdSense-Attributen werden nur auf Anzeigen angewendet, die nach dem Aufrufen dieser Methode angefordert werden. Aus diesem Grund wird empfohlen, diese Methode vor Aufrufen von googletag.display oder PubAdsService.refresh aufzurufen.
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Set the AdSense ad format and channel IDs. slot.setConfig({ adsenseAttributes: { adsense_ad_format: "120x240_as", adsense_channel_ids: "271828183+314159265", }, }); // Clear the AdSense channel IDs only. slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } }); // Clear all AdSense attributes. slot.setConfig({ adsenseAttributes: null });
Optional
categoryExclusion
categoryExclusion?: string[]
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Label = AirlineAd slot.setConfig({ categoryExclusion: ["AirlineAd"], }); // Clearing category exclusion setting. slot.setConfig({ categoryExclusion: null });
- Weitere Informationen
Optional
clickUrl
clickUrl?: string
Die Google Ad Manager-Server erfassen weiterhin einen Klick, auch wenn die Klick-URL ersetzt wird. Jede Landingpage-URL, die mit dem ausgelieferten Creative verknüpft ist, wird an den angegebenen Wert angehängt. Wenn Sie diesen Wert mehr als einmal festlegen, wird jeder zuvor konfigurierte Wert überschrieben. Wenn Sie
null
übergeben, wird der Wert gelöscht.Hinweis:Diese Einstellung gilt nur für Anfragen ohne SRA.
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Sets the click URL to 'http://www.example.com?original_click_url='. slot.setConfig({ clickUrl: "http://www.example.com?original_click_url=", }); // Clears the click URL. slot.setConfig({ clickUrl: null, });
Optional
collapseDiv
collapseDiv?: CollapseDivBehavior
Eine minimierte Anzeigenfläche nimmt keinen Platz auf der Seite ein.
Unterstützte Werte:
null
(Standard): Der Slot wird nicht minimiert.DISABLED
: Die Anzeigenfläche wird nicht minimiert, unabhängig davon, ob eine Anzeige zurückgegeben wird.BEFORE_FETCH
: Die Anzeigenfläche ist anfangs minimiert und wird maximiert, wenn eine Anzeige zurückgegeben wird.ON_NO_FILL
: Die Anzeigenfläche wird zuerst maximiert und dann minimiert, wenn keine Anzeige zurückgegeben wird.
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Collapse the div for this slot if no ad is returned. slot.setConfig({ collapseDiv: "ON_NO_FILL", }); // Collapse the div for this slot by default, and expand only // if an ad is returned. slot.setConfig({ collapseDiv: "BEFORE_FETCH", }); // Do not collapse the div for this slot. slot.setConfig({ collapseDiv: "DISABLED", }); // Clear the collapse setting. slot.setConfig({ collapseDiv: null, });
- Weitere Informationen
Optional
componentAuction
componentAuction?: ComponentAuctionConfig[]
Optional
Interstitial
interstitial?: InterstitialConfig
- Weitere Informationen
Optional
safeFrame
safeFrame?: SafeFrameConfig
Über diese Einstellung konfigurierte Werte gelten nur für den Anzeigen-Slot und überschreiben Werte, die über PageSettingsConfig.safeFrame festgelegt wurden.
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Force SafeFrame for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: true }, }); // Configure SafeFrame to allow overlay expansion for the slot. slot.setConfig({ safeFrame: { allowOverlayExpansion: true }, }); // Clear forceSafeFrame setting for the slot. slot.setConfig({ safeFrame: { forceSafeFrame: null }, }); // Clear all SafeFrame settings for the slot. slot.setConfig({ safeFrame: null });
Optional
Targeting
targeting?: Record<string, string | string[]>
Das über diese Einstellung konfigurierte Targeting wird nur auf die Anzeigenfläche angewendet. Diese Einstellung kann mehrmals aufgerufen werden, um mehrere Targeting-Schlüssel/Wert-Paare zu definieren oder vorhandene Werte zu überschreiben. Targeting-Schlüssel werden in Ihrem Google Ad Manager-Konto definiert.
- Beispiel
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
JavaScript (alt)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Setting a single targeting key-value. slot.setConfig({ targeting: { interests: "sports" } }); // Setting multiple values for a single targeting key. slot.setConfig({ targeting: { interests: ["sports", "music"] } }); // Setting multiple targeting key-values at once. slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } }); // Clearing a single targeting key. slot.setConfig({ targeting: { interests: null } }); // Clear all targeting keys. slot.setConfig({ targeting: null });
- Weitere Informationen
googletag.config.TaxonomyData
Attribute | |
---|---|
values | Eine Liste mit Taxonomy-Werten. |
Attribute
Werte
values: readonly string[]
googletag.config.VideoAdsConfig
Attribute | |
---|---|
enable | Gibt an, ob Videoanzeigen auf der Seite ausgeliefert werden. |
video | Die ID der Videoinhaltsquelle. |
video | Die ID des Videoinhalts. |
- Weitere Informationen
Attribute
enableVideoAds
enableVideoAds: boolean
Wenn der Wert auf
true
gesetzt ist, werden Einschränkungen für auszuschließende Inhalte für Display- und Videoanzeigen aktiviert.Wenn der Videoinhalt bekannt ist, legen Sie videoContentId und videoCmsId auf die Werte fest, die dem Google Ad Manager-Dienst für die Aufnahme von Inhalten bereitgestellt werden, um den Ausschluss von Inhalten für Displayanzeigen zu nutzen.
Optional
videoCmsId
videoCmsId?: string
Dies ist ein eindeutiger Wert, der vom Google Ad Manager-Dienst für die Contentaufnahme zugewiesen wird, um die Quelle des Videocontents zu identifizieren, der durch videoContentId angegeben wird.
- Weitere Informationen
Optional
videoContentId
videoContentId?: string
Dies ist ein eindeutiger Wert, der ein bestimmtes Video aus der Contentquelle identifiziert, die durch videoCmsId angegeben wird. Dieser Wert wird vom CMS zugewiesen, das Ihren Videocontent hostet.
- Weitere Informationen
googletag.enums
Aufzählungen | |
---|---|
Out | Von GPT unterstützte Out-of-Page-Formate |
Traffic | Von GPT unterstützte Traffic-Quellen |
Aufzählungen
OutOfPageFormat
OutOfPageFormat
- Weitere Informationen
Enumerationsmitglieder | |
---|---|
AD_ | Format für auf der Nutzerabsicht basierende Links, Chips und Anker |
BOTTOM_ | Ankerformat, bei dem der Slot am unteren Rand des Darstellungsbereichs bleibt. |
GAME_ | Manuelles Interstitial-Format für Spiele. Hinweis:Das manuelle Interstitial für Spiele ist ein Format mit eingeschränktem Zugriff. |
INTERSTITIAL | Creative-Format für Web-Interstitial-Anzeigen. |
LEFT_ | Format des seitlichen Anzeigenstreifens links. |
REWARDED | Format mit Prämie. |
RIGHT_ | Format des seitlichen Anzeigenstreifens rechts. |
TOP_ | Ankerformat, bei dem die Anzeigenfläche am oberen Rand des Darstellungsbereichs fixiert ist. |
TrafficSource
TrafficSource
- Weitere Informationen
googletag.events
Schnittstellen | |
---|---|
Event | Basisschnittstelle für alle GPT-Ereignisse. |
Event | Dies ist ein Pseudotyp, der einen Ereignisnamen dem entsprechenden Ereignisobjekttyp für Service.addEventListener und Service.removeEventListener zuordnet. |
Game | Dieses Ereignis wird ausgelöst, wenn ein manueller Interstitial-Slot für Spiele vom Nutzer geschlossen wurde. |
Game | Dieses Ereignis wird ausgelöst, wenn eine manuelle Interstitial-Anzeigenfläche für Spiele bereit ist, dem Nutzer präsentiert zu werden. |
Impression | Dieses Ereignis wird ausgelöst, wenn eine Impression gemäß den Active View-Kriterien sichtbar wird. |
Rewarded | Dieses Ereignis wird ausgelöst, wenn ein Nutzer einen Anzeigen-Slot mit Prämie schließt. |
Rewarded | Dieses Ereignis wird ausgelöst, wenn eine Prämie für das Ansehen einer Anzeige mit Prämie gewährt wird. |
Rewarded | Dieses Ereignis wird ausgelöst, wenn eine Anzeige mit Prämie bereit ist, angezeigt zu werden. |
Rewarded | Dieses Ereignis wird ausgelöst, wenn die Wiedergabe einer Videoanzeige mit Prämie abgeschlossen ist. |
Slot | Dieses Ereignis wird ausgelöst, wenn das Load-Ereignis des iFrames des Creatives ausgelöst wird. |
Slot | Dieses Ereignis wird ausgelöst, wenn der Creative-Code in einen Slot eingefügt wird. |
Slot | Dieses Ereignis wird ausgelöst, wenn eine Anzeige für einen bestimmten Slot angefordert wurde. |
Slot | Dieses Ereignis wird ausgelöst, wenn eine Anzeigenantwort für einen bestimmten Slot empfangen wurde. |
Slot | Dieses Ereignis wird immer dann ausgelöst, wenn sich der Prozentsatz der Fläche eines Anzeigen-Slots ändert, der auf dem Bildschirm zu sehen ist. |
googletag.events.Event
Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. |
slot | Der Slot, der das Ereignis ausgelöst hat. |
- Weitere Informationen
Attribute
serviceName
serviceName: string
slot
slot: Slot
googletag.events.EventTypeMap
Attribute
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
gameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
impressionViewable
impressionViewable: ImpressionViewableEvent
rewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEvent
rewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEvent
rewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEvent
rewardedSlotVideoCompleted
rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent
slotOnload
slotOnload: SlotOnloadEvent
slotRenderEnded
slotRenderEnded: SlotRenderEndedEvent
slotRequested
slotRequested: SlotRequestedEvent
slotResponseReceived
slotResponseReceived: SlotResponseReceived
slotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEvent
googletag.events.GameManualInterstitialSlotClosedEvent
ErweitertHinweis:Manuelle Interstitials für Spiele sind ein Format mit eingeschränktem Zugriff.
Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (alt)
// This listener is called when a game manual interstitial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a game manual interstitial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
- Weitere Informationen
googletag.events.GameManualInterstitialSlotReadyEvent
ErweitertHinweis:Manuelle Interstitials für Spiele sind ein Format mit eingeschränktem Zugriff.
Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
Methoden | |
---|---|
make | Zeigt dem Nutzer die manuelle Interstitial-Anzeige für Spiele an. |
- Beispiel
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (alt)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); // Slot returns null if the page or device does not support game manual interstitial ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log( "Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.", ); // Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
- Weitere Informationen
Methoden
makeGameManualInterstitialVisible
makeGameManualInterstitialVisible(): void
googletag.events.ImpressionViewableEvent
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
// This listener is called when an 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
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (alt)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the user closes a rewarded ad slot. googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } }); }
- Weitere Informationen
googletag.events.RewardedSlotGrantedEvent
ErweitertAttribute | |
---|---|
payload | Ein Objekt mit Informationen zur gewährten Prämie. |
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (alt)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount, ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } }); }
- Weitere Informationen
Attribute
payload
payload: RewardedPayload
googletag.events.RewardedSlotReadyEvent
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
Methoden | |
---|---|
make | Die Anzeige mit Prämie wird eingeblendet. |
- Beispiel
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (alt)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called whenever a reward is granted for a // rewarded ad. googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } }); }
- Weitere Informationen
Methoden
makeRewardedVisible
makeRewardedVisible(): void
googletag.events.RewardedSlotVideoCompletedEvent
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the video in a rewarded ad slot has // finished playing. googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => { const slot = event.slot; console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing."); if (slot === targetSlot) { // Slot specific logic. } }); }
JavaScript (alt)
var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the video in a rewarded ad slot has // finished playing. googletag.pubads().addEventListener("rewardedSlotVideoCompleted", function (event) { var slot = event.slot; console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing."); if (slot === targetSlot) { // Slot specific logic. } }); }
TypeScript
const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.REWARDED, ); // Slot returns null if the page or device does not support rewarded ads. if (targetSlot) { targetSlot.addService(googletag.pubads()); // This listener is called when the video in a rewarded ad slot has // finished playing. googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => { const slot = event.slot; console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing."); if (slot === targetSlot) { // Slot specific logic. } }); }
- Weitere Informationen
googletag.events.SlotOnloadEvent
ErweitertSlotOnloadEvent
ausgelöst.Attribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
// This listener is called when 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
ErweitertAttribute | |
---|---|
advertiser | Werbetreibenden-ID der gerenderten Anzeige. |
campaign | Die Kampagnen-ID der gerenderten Anzeige. |
company | IDs der Unternehmen, die Gebote für die gerenderte Backfill-Anzeige abgegeben haben. |
creative | Creative-ID der gerenderten Reservierungsanzeige. |
creative | Creative-Vorlagen-ID der gerenderten Reservierungsanzeige. |
is | Gibt an, ob eine Anzeige eine Backfill-Anzeige war. |
is | Gibt an, ob für die Anzeigenfläche eine Anzeige zurückgegeben wurde. |
label | Eingestellt. |
line | Werbebuchungs-ID der gerenderten Reservierungsanzeige. |
response | Die Antwort-ID ist eine eindeutige Kennung für die Anzeigenantwort. |
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
size | Gibt die Pixelgröße des gerenderten Creatives an. |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
slot | Gibt an, ob der Slot-Content mit der gerenderten Anzeige geändert wurde. |
source | Die Creative-ID der gerenderten Reservierungs- oder Backfill-Anzeige. |
source | Werbebuchungs-ID der gerenderten Reservierungs- oder Backfill-Anzeige. |
yield | IDs der Ertragsgruppen für die gerenderte Backfill-Anzeige. |
- Beispiel
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
Attribute
advertiserId
advertiserId: number
null
für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.campaignId
campaignId: number
null
für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.companyIds
companyIds: number[]
null
für leere Slots, Reservierungsanzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.creativeId
creativeId: number
null
für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.creativeTemplateId
creativeTemplateId: number
null
für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.isBackfill
isBackfill: boolean
true
, wenn die Anzeige eine Backfill-Anzeige war, andernfalls false
.isEmpty
isEmpty: boolean
true
, wenn keine Anzeige zurückgegeben wurde, andernfalls false
.labelIds
labelIds: number[]
lineItemId
lineItemId: number
null
für leere Slots, Backfill-Anzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.responseIdentifier
responseIdentifier: string
size
size: string | number[]
[728, 90]
. Bei leeren Anzeigenflächen ist der Wert null
.slotContentChanged
slotContentChanged: boolean
true
, wenn der Inhalt geändert wurde, andernfalls false
.sourceAgnosticCreativeId
sourceAgnosticCreativeId: number
null
, wenn die Anzeige keine Reservierungs- oder Backfill-Werbebuchung ist oder das Creative von anderen Diensten als PubAdsService gerendert wird.sourceAgnosticLineItemId
sourceAgnosticLineItemId: number
null
, wenn die Anzeige keine Reservierungs- oder Backfill-Werbebuchung ist oder das Creative von anderen Diensten als PubAdsService gerendert wird.yieldGroupIds
yieldGroupIds: number[]
null
für leere Slots, Reservierungsanzeigen und Creatives, die von anderen Diensten als PubAdsService gerendert werden.googletag.events.SlotRequestedEvent
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der 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
ErweitertAttribute | |
---|---|
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
googletag.events.SlotVisibilityChangedEvent
ErweitertAttribute | |
---|---|
in | Der Prozentsatz der Fläche der Anzeige, die sichtbar ist. |
service | Name des Dienstes, der das Ereignis ausgelöst hat. Von |
slot | Der Slot, der das Ereignis ausgelöst hat. Von |
- Beispiel
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (alt)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Weitere Informationen
Attribute
inViewPercentage
inViewPercentage: number
googletag.secureSignals
Schnittstellen | |
---|---|
Bidder | Gibt ein sicheres Signal für einen bestimmten Bieter zurück. |
Publisher | Gibt ein sicheres Signal für einen bestimmten Publisher zurück. |
Secure | Eine Schnittstelle zum Verwalten sicherer Signale. |
Typaliasse | |
---|---|
Secure | Schnittstelle zum Zurückgeben eines sicheren Signals für einen bestimmten Bieter oder Anbieter. |
Typaliasse
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider
id
oder networkCode
angegeben werden, aber nicht beides.googletag.secureSignals.BidderSignalProvider
Ein Anbieter für sichere Bietersignale besteht aus zwei Teilen:
- Eine Collector-Funktion, die ein
Promise
zurückgibt, das in ein sicheres Signal aufgelöst wird. - Eine
id
, die den mit dem Signal verknüpften Bieter identifiziert.
Attribute | |
---|---|
collector | Eine Funktion, die ein Promise zurückgibt, das in ein sicheres Signal aufgelöst wird. |
id | Eine eindeutige Kennung für den Collector, der mit diesem sicheren Signal verknüpft ist, wie in Google Ad Manager registriert. |
- Beispiel
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (alt)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Weitere Informationen
Attribute
collectorFunction
collectorFunction: (() => Promise<string>)
Promise
zurückgibt, das in ein sicheres Signal aufgelöst wird.id
id: string
googletag.secureSignals.PublisherSignalProvider
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.
Attribute | |
---|---|
collector | Eine Funktion, die ein Promise zurückgibt, das in ein sicheres Signal aufgelöst wird. |
network | Der Netzwerkcode (wie im Anzeigenblockpfad zu sehen) für den Publisher, der mit diesem sicheren Signal verknüpft ist. |
- Beispiel
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (alt)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Weitere Informationen
Attribute
collectorFunction
collectorFunction: (() => Promise<string>)
Promise
zurückgibt, das in ein sicheres Signal aufgelöst wird.networkCode
networkCode: string
googletag.secureSignals.SecureSignalProvidersArray
Methoden | |
---|---|
clear | Löscht alle Signale für alle Collectors aus dem Cache. |
push | Fügt dem Signalanbieter-Array einen neuen secureSignals.SecureSignalProvider hinzu und startet die Signalerstellung. |
Methoden
clearAllCache
clearAllCache(): void
Wenn Sie diese Methode aufrufen, werden Signale möglicherweise seltener in Anzeigenanfragen für den aktuellen und potenziell späteren Seitenaufruf einbezogen. Daher sollte sie nur aufgerufen werden, wenn sich der Status wesentlich ändert, z. B. bei Ereignissen, die auf einen neuen Nutzer hinweisen (Anmeldung, Abmeldung, Registrierung usw.).
push
push(provider: SecureSignalProvider): void
Parameter | |
---|---|
provider: SecureSignalProvider | Das Objekt secureSignals.SecureSignalProvider, das dem Array hinzugefügt werden soll. |