APIs des Google IMA DAI SDK

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

Klasse google.ima.dai.api.Ad

Methoden

Eine Klasse, die ein Anzeigenobjekt während der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt eine Teilmenge der ima.Ad-Eigenschaften bereit.

getAdId()


Gibt zurückstring:

getAdPodInfo()


Gibt zurückgoogle.ima.dai.api.AdPodInfo:

getAdSystem()


Gibt zurückstring:

getAdvertiserName()


Gibt zurückstring:

getApiFramework()


Gibt zurückstring:

getCompanionAds()


Gibt zurückArray.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Gibt zurückstring:

getCreativeId()


Gibt zurückstring:

getDealId()


Gibt zurückstring:

getDescription()


Gibt zurückstring:

getDuration()


Gibt zurücknumber:

getTitle()


Gibt zurückstring:

getVastMediaHeight()


Gibt zurücknumber:

getVastMediaWidth()


Gibt zurücknumber:

getWrapperAdIds()


Gibt zurückArray.<string>:

getWrapperAdSystems()


Gibt zurückArray.<string>:

getWrapperCreativeIds()


Gibt zurückArray.<string>:

Klasse google.ima.dai.api.AdPodInfo

Methoden

Eine Klasse, die ein Anzeigen-Pod-Info-Objekt während der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt eine Teilmenge der ima.AdPodInfo-Attribute bereit.

getAdPosition()


Gibt zurücknumber:

getMaxDuration()


Gibt zurücknumber:

getPodIndex()


Gibt zurücknumber:

getTimeOffset()


Gibt zurücknumber:

getTotalAds()


Gibt zurücknumber:

Klasse google.ima.dai.api.AdProgressData

Fields

Eine Klasse zum Angeben von Daten zum Anzeigenfortschritt.

Attribute

Name Typ Beschreibung
adBreakDuration

adPosition

currentTime

duration

totalAds

Klasse google.ima.dai.api.CompanionAd

Methoden

Eine Klasse, die ein Companion-Anzeigenobjekt während der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt eine Teilmenge der ima.CompanionAd-Attribute bereit.

getAdSlotId()


Gibt zurückstring:

getContent()


Gibt zurückstring:

getContentType()


Gibt zurückstring:

getHeight()


Gibt zurücknumber:

getWidth()


Gibt zurücknumber:

Klasse google.ima.dai.api.CuePoint

Fields

Eine Klasse zum Angeben von Eigenschaften eines Cuepoints, der eine Werbeunterbrechung in DAI-VOD-Streams darstellt.

Attribute

Name Typ Beschreibung
end

Die Endzeit für diesen Cuepoint.
played

Gibt an, ob dieser Cuepoint abgespielt wurde.
start

Die Startzeit für diesen Cuepoint.

Klasse google.ima.dai.api.LiveStreamRequest

Fields

Eine Klasse zum Angeben von Eigenschaften der Livestreamanfrage.

Konstruktor:
Parameter Typ Beschreibung
opt_liveStreamRequest Object

Objekt, dem bereits Stream-Anfrageattribute zugewiesen sind.

Attribute

Name Typ Beschreibung
assetKey

Damit wird festgelegt, welcher Stream wiedergegeben werden soll. Der Asset-Schlüssel für die Livestreamanfrage ist eine Kennung, die auf der DFP-Benutzeroberfläche zu finden ist.

Klasse google.ima.dai.api.StreamData

Fields

Eine Klasse zum Angeben von Streamdaten.

Attribute

Name Typ Beschreibung
adProgressData

Zeitbezogene Informationen zur aktuell laufenden Anzeige.
cuepoints

Die Cuepoints für Anzeigen für den On-Demand-Stream. Diese können sich im Laufe des Streams ändern. Dieser Wert wird nur im Ereignis-Listener für das AdEvent CUEPOINTS_CHANGED ausgefüllt.
errorMessage

streamId

subtitles

url

Klasse google.ima.dai.api.StreamEvent

Methoden

Dieser Ereignistyp wird vom Stream-Manager als Benachrichtigung ausgelöst, wenn sich der Stream-Status ändert.

getAd()


Gibt google.ima.dai.api.Ad zurück:Rückgabeobjekt mit Anzeigeninformationen.

getStreamData()


Gibt google.ima.dai.api.StreamData zurück:Rückgabeobjekt mit Streaminformationen.

Enum google.ima.dai.api.StreamEvent.Type

Fields

Liste der vom IMA SDK unterstützten Ereignistypen.

Werte

Wert Beschreibung
AD_BREAK_ENDED

Wird ausgelöst, wenn eine Werbeunterbrechung endet.
AD_BREAK_STARTED

Wird ausgelöst, wenn eine Werbeunterbrechung beginnt.
AD_PROGRESS

Wird ausgelöst, wenn es Neuigkeiten zum Fortschritt einer Anzeige gibt.
CLICK

Wird ausgelöst, wenn auf das Klickelement geklickt oder getippt wird, während eine Anzeige wiedergegeben wird.
COMPLETE

Wird ausgelöst, wenn eine Anzeige vollständig wiedergegeben wurde.
CUEPOINTS_CHANGED

Wird für On-Demand-Streams gesendet, wenn sich die Cuepoints ändern.
ERROR

Wird ausgelöst, wenn ein Fehler auftritt.
FIRST_QUARTILE

Wird ausgelöst, wenn eine Anzeige das erste Quartil erreicht.
LOADED

Wird ausgelöst, wenn das Streammanifest verfügbar ist.
MIDPOINT

Wird ausgelöst, wenn eine Anzeige die Hälfte ihrer Laufzeit erreicht hat.
STARTED

Wird ausgelöst, wenn eine Anzeige beginnt.
STREAM_INITIALIZED

Wird ausgelöst, wenn der Stream initialisiert wird.
THIRD_QUARTILE

Wird ausgelöst, wenn eine Anzeige das dritte Quartil erreicht.

Klasse google.ima.dai.api.StreamManager

Methoden

Verarbeitet Streams für die dynamische Anzeigenbereitstellung. Es verwaltet die Interaktionen mit dem DAI-Backend und verarbeitet Tracking-Pings sowie die Weiterleitung von Stream- und Anzeigenereignissen an den Publisher. Dieser Manager erbt nicht von BaseAdsManager, da er kein Manager für eine bestimmte Anzeige, sondern für den gesamten Stream ist.

Konstruktor:
Parameter Typ Beschreibung
videoElement HTMLVideoElement

Das eigentliche Videoplayer-Element.

contentTimeForStreamTime(streamTime)

Gibt die Inhaltszeit ohne Anzeigen für eine bestimmte Streamzeit zurück. Gibt die angegebene Streamzeit für Livestreams zurück.

Rückgabe number:Die Inhaltszeit, die der angegebenen Streamzeit entspricht, nachdem Anzeigen entfernt wurden.

Parameter Typ Beschreibung
streamTime number

Die Stream-Zeit mit eingefügten Anzeigen (in Sekunden).

onTimedMetadata(metadata)

Übergibt ein Dictionary mit verarbeiteten Metadaten. Das Dictionary erwartet den Schlüssel „TXXX“ mit dem benutzerdefinierten Metadatenstring als Wert. Wenn dein Player Rohmetadaten bereitstellt, rufe stattdessen ima.dai.api.StreamManager.processMetadata auf.

Parameter Typ Beschreibung
metadata Object

Das Metadaten-Dictionary.

previousCuePointForStreamTime(streamTime)

Gibt den vorherigen Cuepoint für die angegebene Streamzeit zurück. Gibt „null“ zurück, wenn kein solcher Cuepoint vorhanden ist. Diese Funktion wird verwendet, um Funktionen wie „Zurückspringen“ zu implementieren. Sie wird aufgerufen, wenn der Publisher erkennt, dass der Nutzer gesucht hat, um ihn zu einer Werbeunterbrechung zurückzubringen.

Gibt google.ima.dai.api.CuePoint zurück:den vorherigen Cuepoint für die angegebene Streamzeit.

Parameter Typ Beschreibung
streamTime number

Die Streamzeit, zu der gesucht wurde.

processMetadata(type, data, timestamp)

Verarbeitet zeitgesteuerte Metadaten für Livestreams. Verwenden Sie diese Funktion, wenn Ihr Videoplayer ungeparste Metadaten zusammen mit Zeitstempeln bereitstellt. Rufen Sie andernfalls ima.dai.api.StreamManager.onTimedMetadata auf.

Parameter Typ Beschreibung
type string

Typ für Metadaten. Muss „ID3“ sein.
data Uint8Array

Rohdaten für Tags. Bei ID3 muss es sich um das gesamte Tag handeln.
timestamp number

Zeitpunkt, zu dem Daten verarbeitet werden sollen.

requestStream(streamRequest)

Fordert an, dass ein Stream mit den angegebenen Streamparametern geladen wird.

Parameter Typ Beschreibung
streamRequest google.ima.dai.api.StreamRequest

enthält Parameter zum Laden der Stream-Metadaten.

setClickElement(clickElement)

Legt das Element für Anzeigenklicks fest. Dieses Element wird als Empfänger für Klicks oder Berührungen verwendet, während eine Anzeige ausgeliefert wird. Es kann dazu führen, dass Nutzer von der aktuellen Seite weggeleitet werden.

Parameter Typ Beschreibung
clickElement Element

Das Element, das als Anzeigenklick verwendet wird.

streamTimeForContentTime(contentTime)

Gibt die Streamzeit mit Anzeigen für eine bestimmte Contentzeit zurück. Gibt die angegebene Inhaltszeit für Livestreams zurück.

Rückgabe number:Die Streamzeit, die der angegebenen Inhaltszeit entspricht, nachdem Anzeigen eingefügt wurden.

Parameter Typ Beschreibung
contentTime number

Die Dauer des Inhalts ohne Werbeunterbrechungen in Sekunden.

Klasse google.ima.dai.api.StreamRequest

Fields

Eine Klasse zum Angeben von Eigenschaften der Streamanfrage.

Attribute

Name Typ Beschreibung
adTagParameters

Sie können eine begrenzte Anzahl von Anzeigen-Tag-Parametern in Ihrer Streamanfrage überschreiben. Weitere Informationen finden Sie unter Targeting-Parameter an einen Stream übertragen. Sie können die Parameter „dai-ot“ und „dai-ov“ für die bevorzugte Streamvariante verwenden. Weitere Informationen finden Sie unter Parameter für Streamvarianten überschreiben.
apiKey

Der API-Schlüssel für die Streamanfrage. Sie wird über die DFP Admin UI konfiguriert und dem Publisher zur Verfügung gestellt, damit er seine Inhalte entsperren kann. Es wird geprüft, welche Anwendungen auf die Inhalte zugreifen möchten.
streamActivityMonitorId

Die ID, die zum Debuggen des Streams mit der Überprüfung der Streamingaktivitäten verwendet werden soll. So können Publisher Streamprotokolle im Tool zur Überprüfung der Streamingaktivitäten leichter finden.

Klasse google.ima.dai.api.VODStreamRequest

Fields

Eine Klasse zum Angeben von Eigenschaften der VOD-Streamanfrage.

Konstruktor:
Parameter Typ Beschreibung
opt_VODStreamRequest Object

Objekt, dem bereits Eigenschaften für Streamanfragen zugewiesen sind.

Attribute

Name Typ Beschreibung
contentSourceId

Eindeutige Kennung für die Publisher-Inhalte aus einem CMS. Erforderlich für On-Demand-Streams.
videoId

Kennung für die Video-Contentquelle. Erforderlich für On-Demand-Streams.

Konstante google.ima.VERSION

Ein String, der die vollständige Version des SDK enthält.