Klasse: Ad

google.ima.Anzeige

class   statisch

Eine Anzeigenklasse, die durch Klassen erweitert wird, die verschiedene Anzeigentypen repräsentieren.

Methoden

Anzeigen-ID abrufen

getAdId() gibt String zurück.

Die Anzeigen-ID wird zum Synchronisieren der Haupt- und Companion-Anzeigen verwendet.

Gibt Folgendes zurück:

string Die ID der Anzeige oder der leere String, wenn diese Informationen nicht verfügbar sind.

AdPodInfo abrufen

getAdPodInfo() gibt AdPodInfo zurück

Gibt die Pod-Informationen der Anzeige zurück.

Gibt Folgendes zurück:

non-null AdPodInfo Die Pod-Informationen der Anzeige.

Anzeigensystem abrufen

getAdSystem() gibt String zurück.

Die Informationen zum Quell-Ad-Server, die in der Anzeigenantwort enthalten sind

Gibt Folgendes zurück:

string Der Quell-Ad-Server der Anzeige oder der leere String, wenn diese Informationen nicht verfügbar sind.

Werbetreibender abrufen

getWerbetreibendeName() gibt String zurück

Der vom Drittanbieter definierte Name des Werbetreibenden.

Gibt Folgendes zurück:

string Der Name des Werbetreibenden oder der leere String, wenn diese Informationen nicht verfügbar sind.

GetApiFramework

getApiFramework() gibt String zurück.

Identifiziert die API, die zum Ausführen der Anzeige erforderlich ist. Dies entspricht dem in vast angegebenen apiFramework.

Gibt Folgendes zurück:

nullable string Das API-Framework muss die Anzeige ausführen oder null, wenn diese Informationen nicht verfügbar sind.

GetCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, settings) Returns Array von Nicht-Null-CompanionAd

Ruft die Companion-Anzeigen für diese Anzeige basierend auf der Größe der Companion-Anzeigenfläche ab. Optional können Einstellungen für die erweiterte Auswahl akzeptiert werden. Bei dieser Methode wird nur ein nicht leeres Array für Anzeigeninstanzen zurückgegeben, die am oder nach dem STARTED-Ereignis erfasst wurden. Anzeigen aus dem Ereignis LOADED geben ein leeres Array zurück.

Parameter
Breite_Anzeigenfläche	Zahl Breite der Companion-Anzeigenfläche
Höhe der Anzeigenfläche	Zahl Höhe der Companion-Anzeigenfläche
einstellungen	Optional Einstellungen für die Companion-Anzeigenauswahl Die Auswahleinstellungen für Companion-Anzeigen. Der Wert darf nicht null sein.

Gibt Folgendes zurück:

non-null Array of non-null CompanionAd Array mit Companion-Anzeigen, das den Einstellungen und der Größe der Anzeigenfläche entspricht.

getContentType

getContentType() gibt String zurück.

Gibt den Inhaltstyp des derzeit ausgewählten Creatives zurück oder einen leeren String, wenn kein Creative ausgewählt ist oder der Inhaltstyp nicht verfügbar ist. Bei linearen Anzeigen ist der Inhaltstyp erst nach dem START-Ereignis verfügbar, wenn die Mediendatei ausgewählt wird.

Gibt Folgendes zurück:

string Inhaltstyp. Leerer String, falls nicht verfügbar.

Creative-ID abrufen

getCreativeAdId() gibt einen String zurück

Gibt den ISCI-Code (Industry Standard Commercial Identifier) für eine Anzeige zurück. Wenn der Code nicht verfügbar ist, wird ein leerer String ausgegeben. Das ist die Anzeigen-ID des Creatives in der VAST-Antwort.

Gibt Folgendes zurück:

string 

Creative-ID abrufen

getCreativeId() gibt einen String zurück

Ruft die ID des ausgewählten Creatives für die Anzeige ab

Gibt Folgendes zurück:

string Die ID des ausgewählten Creatives für die Anzeige oder der leere String, wenn diese Informationen nicht verfügbar sind.

DealDealID

getDealId() gibt String zurück.

Gibt die erste Deal-ID in der Wrapper-Kette für die aktuelle Anzeige zurück, beginnend oben. Gibt den leeren String zurück, falls nicht vorhanden

Gibt Folgendes zurück:

string 

getDescription

getDescription() gibt einen String zurück.

Gibt die Beschreibung dieser Anzeige aus der VAST-Antwort zurück

Gibt Folgendes zurück:

string Die Beschreibung, wenn nicht angegeben, leer.

Dauer

getDuration() gibt eine Zahl zurück.

Gibt die Dauer des ausgewählten Creatives oder -1 für nicht lineare Creatives zurück

Gibt Folgendes zurück:

number Die ausgewählte Creative-Dauer in Sekunden, -1, wenn nicht linear.

getHeight

getHeight() gibt eine Zahl zurück

Gibt die Höhe des ausgewählten nicht linearen Creatives zurück

Gibt Folgendes zurück:

number Die Höhe des ausgewählten nicht linearen Creatives oder 0 für ein lineares Creative

getMediaUrl (GetMediaUrl)

getMediaUrl() gibt einen String zurück.

Gibt die URL der Mediendatei zurück, die anhand der aktuell verwendeten Medienauswahleinstellungen aus der Anzeige ausgewählt wurde. Gibt null zurück, wenn diese Informationen nicht verfügbar sind. Verfügbar am Ereignis STARTED.

Gibt Folgendes zurück:

nullable string 

GetMinSuggestedDuration

getMinSuggestedDuration() returns number

Gibt die vorgeschlagene Mindestdauer in Sekunden zurück, die das nicht lineare Creative angezeigt werden soll. Gibt -2 zurück, wenn die minimale vorgeschlagene Dauer unbekannt ist. Bei linearen Creatives wird die gesamte Dauer der Anzeige zurückgegeben.

Gibt Folgendes zurück:

number Die empfohlene Mindestdauer in Sekunden, die ein Creative zu sehen sein soll.

getSkipTimeOffset

getSkipTimeOffset() returns number

Die Wiedergabedauer in Sekunden, bis die Anzeige überspringbar wird. –1 wird für nicht überspringbare Anzeigen zurückgegeben oder wenn diese nicht verfügbar sind.

Gibt Folgendes zurück:

number Der Versatz in Sekunden oder -1

Fragebogen-URL

getSurveyUrl() gibt String zurück.

Die mit der Umfrage verknüpfte URL für die entsprechende Anzeige wird zurückgegeben. Gibt null zurück, wenn nicht verfügbar.

Gibt Folgendes zurück:

nullable string 

Titel abrufen

getTitle() gibt einen String zurück

Gibt den Titel dieser Anzeige aus der VAST-Antwort zurück

Gibt Folgendes zurück:

string Der Titel ist leer, falls nicht angegeben.

getTraffickingParameters

getTraffickingParameters() gibt Objekt mit String-Properties zurück.

Ruft benutzerdefinierte Parameter ab, die der Anzeige zum Zeitpunkt des Anzeigen-Traffickings zugeordnet sind.

Gibt Folgendes zurück:

non-null Object with string properties Eine Zuordnung von Trafficking-Schlüsseln zu ihren Werten oder das leere Objekt, wenn diese Informationen nicht verfügbar sind.

GetTraffickingParametersString

getTraffickingParametersString() String zurückgeben

Ruft benutzerdefinierte Parameter ab, die der Anzeige zum Zeitpunkt des Anzeigen-Traffickings zugeordnet sind. Gibt eine Rohstringversion der geparsten Parameter von getTraffickingParameters zurück.

Gibt Folgendes zurück:

string Trafficking-Parameter oder der leere String, wenn diese Informationen nicht verfügbar sind.

GetUiElements

getUiElements() gibt ein String-Array zurück

Gibt die UI-Elemente zurück, die bei der Wiedergabe dieser Anzeige eingeblendet werden Mögliche Elemente des zurückgegebenen Arrays finden Sie unter UiElements.

Gibt Folgendes zurück:

non-null Array of string Die angezeigten UI-Elemente.

universelleAnzeigen-ID abrufen

getUniversalAdIdRegistry() returns string

Die Registry, die mit der Katalogisierung der UniversalAdId des ausgewählten Creatives für die Anzeige verknüpft ist.

Verworfen

Verwenden Sie stattdessen „ad.getUniversalAdIds()“.

Gibt Folgendes zurück:

string Gibt den Registrierungswert oder „unknown“ zurück, falls nicht verfügbar.

universellerAnzeigen-ID-Wert abrufen

getUniversalAdIdValue() String zurückgeben

Die UniversalAdId des ausgewählten Creatives für die Anzeige.

Verworfen

Verwenden Sie stattdessen „ad.getUniversalAdIds()“.

Gibt Folgendes zurück:

string Gibt den ID-Wert oder „unknown“ zurück, falls nicht verfügbar.

universelleAnzeigen-IDs abrufen

getUniversalAdIds() gibt Array von UniversalAdIdInfo zurück, die nicht null ist.

Die Liste der UniversalAdIds des ausgewählten Creatives für die Anzeige.

Gibt Folgendes zurück:

non-null Array of non-null UniversalAdIdInfo Liste mit universellen Anzeigen-ID-Informationen, die für diese Anzeige gelten.

GetVastMediaBitrate

getVastMediaBitrate() gibt eine Zahl zurück

Wenn sowohl das Creative als auch die Mediadatei vom SDK ausgewählt wurden, wird die Bitrate für die Mediadatei zurückgegeben, wie in der VAST-Antwort aufgeführt.

Gibt Folgendes zurück:

number: Bitrate für die ausgewählte Mediendatei oder „0“

GetVastMediaHeight

getVastMediaHeight() gibt eine Zahl zurück

Gibt die VAST-Mediahöhe des ausgewählten Creatives zurück

Gibt Folgendes zurück:

number Die VAST-Medienhöhe des ausgewählten Creatives oder „0“, wenn keine ausgewählt ist

GetVastMediaWidth

getVastMediaWidth() gibt Rückgabenummer zurück

Gibt die VAST-Medienbreite des ausgewählten Creatives zurück

Gibt Folgendes zurück:

number Die VAST-Medienbreite des ausgewählten Creatives oder „0“, wenn keine ausgewählt ist.

getWidth

getWidth() liefert Rückgabenummer

Gibt die Breite des ausgewählten Creatives zurück

Gibt Folgendes zurück:

number Die Breite des ausgewählten nicht linearen Creatives oder 0 für ein lineares Creative

GetWrapperAdIds

getWrapperAdIds() gibt String-Array zurück.

Anzeigen-IDs, die für Wrapper verwendet werden Die zurückgegebenen IDs beginnen an der Inline-Anzeige (innere Anzeige) und durchlaufen diese in der äußersten Wrapper-Anzeige. Wenn keine Wrapper vorhanden sind, wird ein leeres Array zurückgegeben.

Gibt Folgendes zurück:

non-null Array of string Die IDs der Anzeigen, die bei der Inline-Anzeige beginnen, oder ein leeres Array, wenn keine Wrapper vorhanden sind.

WrapperAdSystems

getWrapperAdSystems() gibt ein String-Array zurück.

Anzeigensysteme, die für Wrapper verwendet werden Die zurückgegebenen Anzeigensysteme beginnen bei der Inline-Anzeige und durchlaufen die äußerste Wrapper-Anzeige. Wenn keine Wrapper vorhanden sind, wird ein leeres Array zurückgegeben.

Gibt Folgendes zurück:

non-null Array of string Die Anzeigensysteme der Anzeigen, beginnend mit der Inline-Anzeige. Wenn die Wrapper nicht vorhanden sind, ist das Array leer.

GetWrapperCreativeIds

getWrapperCreativeIds() gibt ein String-Array zurück.

Ausgewählte Creative-IDs, die für Wrapper-Anzeigen verwendet werden. Die zurückgegebenen Creative-IDs beginnen an der Inline-Anzeige und werden durch die äußere Wrapper-Anzeige geleitet. Wenn keine Wrapper vorhanden sind, wird ein leeres Array zurückgegeben.

Gibt Folgendes zurück:

non-null Array of string Die IDs der Creatives der Anzeige, beginnend mit der Inline-Anzeige. Wenn die Wrapper nicht vorhanden sind, sehen Sie ein leeres Array.

isLinear (ist linear)

isLinear() gibt boolesch zurück

Gibt an, ob der aktuelle Betriebsmodus der Anzeige linear oder nicht linear ist. Falls der Wert auf „true“ gesetzt ist, bedeutet das, dass die Anzeige im linearen Modus ausgeliefert wird. Bei „false“ wird der nicht lineare Modus angezeigt. Der Player prüft die lineare Property und aktualisiert ihren Status gemäß den Details des Anzeigen-Placements. Während die Anzeige im linearen Modus ist, pausiert der Player das Contentvideo. Wenn die lineare Umsetzung anfangs wahr ist und die Anzeige eine Pre-Roll-Anzeige ist (extern definiert), kann der Player das Laden des Contentvideos bis zum Ende der Anzeigenwiedergabe verzögern.

Gibt Folgendes zurück:

boolean „true“, wenn die Anzeige linear ist, andernfalls „false“.