Klasse: ImaSdkSettings

google.ima.ImaSdkSettings

class public statisch

Diese Klasse enthält SDK-weite Einstellungen.

Aufzählungen

Companion-Backfill-Modus

konstante statische

String

Definiert eine Reihe von Konstanten für die Companion-Backfill-Einstellung. Diese Einstellung gibt an, ob Companions in verschiedenen Szenarien einen Backfill nutzen sollen.

Wenn der Wert ALWAYS lautet, wird der Companion-Backfill in allen Situationen versucht, auch wenn keine Hauptanzeige zurückgegeben wird.

Wenn der Wert ON_MASTER_AD lautet, wird der Companion-Backfill versucht, wenn eine Hauptanzeige weniger Companion-Flächen hat. Die fehlenden Companions werden per Backfill ergänzt.

Der Standardwert ist ALWAYS.

Für den clientseitigen Companion-Backfill müssen die Companions mit einem Google Publisher-Tag (GPT) richtig getaggt werden. Zum Aktivieren des Backfills sind folgende Änderungen an der standardmäßigen GPT-Einrichtung erforderlich: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
Bei Autoplay-Videos wird die folgende zusätzliche Änderung empfohlen, um zu verhindern, dass Companion-Flächen vorab geladen und dann sofort durch Companions ersetzt werden. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Wert

IMMER

ON_MASTER_ANZEIGE

VPAID-Modus

konstante statische

Zahl

Eine Reihe von Konstanten zum Aktivieren der VPAID-Funktion.

Wert

DEAKTIVIERT

VPAID-Anzeigen werden nicht wiedergegeben und es wird ein Fehler zurückgegeben.

AKTIVIERT

VPAID-Anzeigen werden mit einem domainübergreifenden iFrame aktiviert. Die VPAID-Anzeige kann nicht auf die Website zugreifen. VPAID-Anzeigen, die auf den Friendly iFrame-Zugriff angewiesen sind, können fehlerhaft sein. Das ist die Standardeinstellung.

UNSICHER

VPAID-Anzeigen werden über einen Friendly iFrame aktiviert. Dadurch kann die Anzeige über JavaScript auf die Website zugreifen.

Attribute

Companion-Backfill-Modus

konstante statische

String

Definiert eine Reihe von Konstanten für die Companion-Backfill-Einstellung. Diese Einstellung gibt an, ob Companions in verschiedenen Szenarien einen Backfill nutzen sollen.

Wenn der Wert ALWAYS lautet, wird der Companion-Backfill in allen Situationen versucht, auch wenn keine Hauptanzeige zurückgegeben wird.

Wenn der Wert ON_MASTER_AD lautet, wird der Companion-Backfill versucht, wenn eine Hauptanzeige weniger Companion-Flächen hat. Die fehlenden Companions werden per Backfill ergänzt.

Der Standardwert ist ALWAYS.

Für den clientseitigen Companion-Backfill müssen die Companions mit einem Google Publisher-Tag (GPT) richtig getaggt werden. Zum Aktivieren des Backfills sind folgende Änderungen an der standardmäßigen GPT-Einrichtung erforderlich: 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
Bei Autoplay-Videos wird die folgende zusätzliche Änderung empfohlen, um zu verhindern, dass Companion-Flächen vorab geladen und dann sofort durch Companions ersetzt werden. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Wert

IMMER

ON_MASTER_ANZEIGE

VPAID-Modus

konstante statische

Zahl

Eine Reihe von Konstanten zum Aktivieren der VPAID-Funktion.

Wert

DEAKTIVIERT

VPAID-Anzeigen werden nicht wiedergegeben und es wird ein Fehler zurückgegeben.

AKTIVIERT

VPAID-Anzeigen werden mit einem domainübergreifenden iFrame aktiviert. Die VPAID-Anzeige kann nicht auf die Website zugreifen. VPAID-Anzeigen, die auf den Friendly iFrame-Zugriff angewiesen sind, können fehlerhaft sein. Das ist die Standardeinstellung.

UNSICHER

VPAID-Anzeigen werden über einen Friendly iFrame aktiviert. Dadurch kann die Anzeige über JavaScript auf die Website zugreifen.

Methoden

getCompanionBackfill

getCompanionBackfill() gibt CompanionBackfillMode zurück.

Gibt den aktuellen Companion-Backfill-Modus zurück.

Gibt Folgendes zurück:

non-null CompanionBackfillMode Der aktuelle Wert.

getDisableCustomPlaybackForIOS10Plus

getDisableCustomPlaybackForIOS10Plus() boolesch

Ruft ab, ob die benutzerdefinierte Wiedergabe unter iOS 10 oder höher deaktiviert wird. Der Standardwert ist "false".

Gibt Folgendes zurück:

boolean 

getFeatureFlags

getFeatureFlags() gibt Objekt mit allen Typeigenschaften zurück.

Gibt ein Objekt mit Schlüsseln als Feature-Flags und Werten als ihrem aktuellen Status zurück.

Gibt Folgendes zurück:

non-null Object with any type properties 

getLocale

getLocale() zurück

Gibt das vom Publisher angegebene Gebietsschema zurück.

Gibt Folgendes zurück:

string Vom Publisher angegebene Sprache

getNumRedirects

getNumRedirects() gibt Zahl zurück

Gibt die maximale Anzahl von Weiterleitungen für nachfolgende Weiterleitungen zurück.

Gibt Folgendes zurück:

number die maximale Anzahl von Weiterleitungen.

Spielertyp abrufen

getPlayerType() gibt einen String zurück

Gibt den vom Partner bereitgestellten Player-Typ zurück

Gibt Folgendes zurück:

string Spielertyp des Partners.

getPlayerVersion

getPlayerVersion() gibt String zurück

Gibt die vom Partner bereitgestellte Player-Version zurück.

Gibt Folgendes zurück:

string Partner-Player-Version.

getPid

getPpid() gibt zurück (null oder String)

Gibt die vom Publisher bereitgestellte ID zurück.

Gibt Folgendes zurück:

(null or string) Publisher Provided ID.

isCookiesEnabled

isCookiesEnabled() gibt einen booleschen Wert zurück

Gibt Folgendes zurück:

boolean Gibt an, ob der Publisher die Verwendung von Cookies zulässt.

setAutoPlayWerbeunterbrechungen

setAutoPlayAdBreaks(autoPlayAdBreaks) gibt zurück

Legt fest, ob VMAP- und Anzeigenregeln automatisch abgespielt werden

Parameter

autoPlayAdBreaks (automatische Wiedergabe von Werbeunterbrechungen)

boolean

Gibt an, ob die Werbeunterbrechung automatisch wiedergegeben werden soll.
Gibt Folgendes zurück:

void 

setCompanionBackfill

setCompanionBackfill(mode) returns void

Legt den Companion-Backfill-Modus fest. Unter „ImaSdkSettings.CompanionBackfillMode“ sind die verschiedenen Modi aufgeführt.

Der Standardmodus ist ImaSdkSettings.CompanionBackfillMode.ALWAYS.

Parameter

Modus

Companion-Backfill-Modus

Der ausgewählte Companion-Backfill-Modus.

Der Wert darf nicht null sein.
Gibt Folgendes zurück:

void 

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) gibt void zurück

Gibt an, ob das SDK ein Google Ad Manager-Cookie (GFP-Cookie) in der Publisher-Domain als Erstanbieter-Cookie speichern soll. Dadurch wird die Persistenz mehrerer Besuche in derselben Domain ermöglicht, ohne dass Cookies von Drittanbietern verwendet werden. Der Standardwert ist „true“.

Diese Einstellung hat keine Auswirkungen auf andere Cookies, die von anderen Parteien oder für andere Zwecke gesetzt werden. Auch durch die Nutzereinwilligung und die Deaktivierung kann die Verwendung von eigenen Cookies deaktiviert werden. Sie werden vom Verlag oder Webpublisher abgerufen, wenn er einen IAB-konformen Consent Management Provider verwendet, sofern dies im selben Frame erfolgt.

Parameter

Cookies aktiviert

boolean
Gibt Folgendes zurück:

void 

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus(disable) gibt voids

Legt fest, ob die benutzerdefinierte Wiedergabe unter iOS 10 oder höher deaktiviert wird. Wenn der Wert „true“ ist, werden Anzeigen inline abgespielt, wenn das Content-Video inline ist. Dadurch können überspringbare TrueView-Anzeigen aktiviert werden. Die Anzeige bleibt jedoch inline und unterstützt nicht den nativen Vollbildmodus von iOS. Bei „false“ werden Anzeigen im selben Player wie dein Content wiedergegeben. Der hier festgelegte Wert wird bei der Erstellung eines AdDisplayContainers für die Lebensdauer des Containers verwendet. Der Standardwert ist "false".

Parameter

deaktivieren

boolean

Gibt an, ob die benutzerdefinierte Wiedergabe deaktiviert werden soll.
Gibt Folgendes zurück:

void 

setFeatureFlags

setFeatureFlags(featureFlags) gibt zurück

Legen Sie den Wert für Funktions-Flags fest. Legen Sie dies so früh wie möglich fest, bevor Sie Anzeigen anfordern. Die Einstellungen bleiben bis zur nächsten Anzeigenanfrage unverändert. Wenn Sie diese Methode noch einmal aufrufen, werden alle Funktions-Flags für die nächste Anzeigenanfrage zurückgesetzt.

Parameter

featureFlags

Objekt mit beliebigen Typeigenschaften

Der Wert darf nicht null sein.
Gibt Folgendes zurück:

void 

setLocale

setLocale(locale)-Rückgaben

Legt die vom Publisher angegebene Sprache fest. Muss vor dem Erstellen von AdsLoader oder AdDisplayContainer aufgerufen werden. Das Gebietsschema gibt die Sprache an, in der UI-Elemente angezeigt werden sollen. Die unterstützten Codes finden Sie unter Lokalisierung für Sprache und Sprache.

Parameter

locale

String

Vom Publisher bereitgestelltes Gebietsschema.
Gibt Folgendes zurück:

void 

setNumRedirects

setNumRedirects(numRedirects) ist ungültig

Gibt die maximale Anzahl von Weiterleitungen an, bevor die nachfolgenden Weiterleitungen abgelehnt werden und der Ladevorgang der Anzeige abgebrochen wird. Die Anzahl der Weiterleitungen wirkt sich direkt auf die Latenz und damit auf die Nutzerfreundlichkeit aus. Dies gilt für alle VAST-Wrapper-Anzeigen.

Parameter

numRedirects (Anzahl Weiterleitungen)

Zahl

die maximale Anzahl von Weiterleitungen.
Gibt Folgendes zurück:

void 

setPlayer-Typ

setPlayerType(playerType) gibt zurück

Legt den vom Partner bereitgestellten Playertyp fest Diese Einstellung sollte verwendet werden, um den Namen des Players anzugeben, der in das SDK eingebunden wird. Der Spielertyp mit mehr als 20 Zeichen wird abgeschnitten. Der angegebene Spielertyp muss kurz und eindeutig sein. Dies ist eine optionale Einstellung, mit der die Nutzerfreundlichkeit von SDKs durch das Tracking von Spielertypen verbessert wird.

Beispiel: 


settings.setPlayerType('google/gmf-player');

Parameter

Spielertyp

String

Der Typ des Partnerplayers.
Gibt Folgendes zurück:

void 

setPlayer-Version

setPlayerVersion(playerVersion) returns void

Legt die vom Partner bereitgestellte Player-Version fest. Diese Einstellung sollte verwendet werden, um die Version des Partnerplayers anzugeben, der in das SDK eingebunden wird. Playerversionen mit mehr als 20 Zeichen werden abgeschnitten. Dies ist eine optionale Einstellung, mit der die SDK-Nutzererfahrung durch Tracking der Player-Version verbessert wird.

Beispiel: 


settings.setPlayerVersion('1.0.0');

Parameter

Spielerversion

String

Die Version des Partnerplayers.
Gibt Folgendes zurück:

void 

SetPpid

setPpid(ppid) gibt zurück

Legt die vom Publisher bereitgestellte ID fest.

Parameter

ppid

String

vom Publisher angegebene ID.
Gibt Folgendes zurück:

void 

setSessionId (Sitzungs-ID festlegen)

setSessionId(sessionId) gibt zurück

Die Sitzungs-ID ist eine temporäre Zufalls-ID. Sie wird ausschließlich für das Frequency Capping verwendet. Eine Sitzungs-ID muss eine UUID sein.

Parameter

sessionId

String

Eine temporäre UUID für das Frequency Capping.
Gibt Folgendes zurück:

void 

setVpaidZulässig

setVpaidAllowed(allowVpaid) Rückgaben ist ungültig

Veraltet. SetVpaidMode verwenden Legt fest, ob VPAID-Creatives zulässig sind.

Parameter

allowVpaid

boolean

Gibt an, ob VPAID-Creatives zulässig sind.
Gibt Folgendes zurück:

void 

setVpaidMode

setVpaidMode(vpaidMode) gibt zurück

Legt den VPAID-Wiedergabemodus fest.

Parameter

VPAID-Modus

VPAID-Modus

Legt fest, wie VPAID-Anzeigen wiedergegeben werden. Standardmäßig ist der sichere Modus aktiviert.

Der Wert darf nicht null sein.
Gibt Folgendes zurück:

void