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 bei der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt einen Teil der ima.Ad-Eigenschaften bereit.

getAdId()


Gibt string zurück:

getAdPodInfo()


Gibt google.ima.dai.api.AdPodInfo zurück:

getAdSystem()


Gibt string zurück:

getAdvertiserName()


Gibt string zurück:

getApiFramework()


Gibt string zurück:

getCompanionAds()


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

getCreativeAdId()


Gibt string zurück:

getCreativeId()


Gibt string zurück:

getDealId()


Gibt string zurück:

getDescription()


Gibt string zurück:

getDuration()


Gibt number zurück:

getTitle()


Gibt string zurück:

getVastMediaHeight()


Gibt number zurück:

getVastMediaWidth()


Gibt number zurück:

getWrapperAdIds()


Gibt Array.<string> zurück:

getWrapperAdSystems()


Gibt Array.<string> zurück:

getWrapperCreativeIds()


Gibt Array.<string> zurück:

Klasse google.ima.dai.api.AdPodInfo

Methoden

Klasse, die ein Anzeigen-Pod-Infoobjekt bei der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt eine Teilmenge der ima.AdPodInfo-Eigenschaften bereit.

getAdPosition()


Gibt number zurück:

getMaxDuration()


Gibt number zurück:

getPodIndex()


Gibt number zurück:

getTimeOffset()


Gibt number zurück:

getTotalAds()


Gibt number zurück:

Klasse google.ima.dai.api.AdProgressData

Fields

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 bei der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt einen Teil der ima.CompanionAd-Eigenschaften bereit.

getAdSlotId()


Gibt string zurück:

getContent()


Gibt string zurück:

getContentType()


Gibt string zurück:

getHeight()


Gibt number zurück:

getWidth()


Gibt number zurück:

Klasse google.ima.dai.api.CuePoint

Fields

Eine Klasse zum Angeben der Attribute eines Cue-Punkts, der eine Werbeunterbrechung in VOD-Streams der dynamischen Anzeigenbereitstellung darstellt.

Attribute

Name Typ Beschreibung
end

Die Endzeit für diesen Cue-Point.
played

Gibt an, ob dieser Cue-Punkt abgespielt wurde.
start

Die Startzeit für diesen Cue-Point.

Klasse google.ima.dai.api.LiveStreamRequest

Fields

Eine Klasse zum Angeben von Attributen der Livestreamanfrage.

Konstruktor:
Parameter Typ Beschreibung
opt_liveStreamRequest Object

Objekt, dem bereits Eigenschaften von Streamanfragen zugewiesen sind.

Attribute

Name Typ Beschreibung
assetKey

Damit wird bestimmt, welcher Stream abgespielt werden soll. Der Assetschlüssel der Livestreamanfrage ist eine Kennung, die Sie auf der DFP-Benutzeroberfläche finden.

Klasse google.ima.dai.api.StreamData

Fields

Eine Klasse zum Angeben von Streamdaten.

Attribute

Name Typ Beschreibung
adProgressData

Zeitbezogene Informationen für die aktuell wiedergegebene Anzeige.
cuepoints

Die Anzeigenreferenzpunkte für den On-Demand-Stream. Diese können sich im Laufe des Streams ändern. Wird nur im Event-Listener für CUEPOINTS_CHANGED AdEvent ausgefüllt.
errorMessage

streamId

subtitles

url

Klasse google.ima.dai.api.StreamEvent

Methoden

Dieser Ereignistyp wird vom Streammanager als Benachrichtigung ausgegeben, wenn sich der Streamstatus ändert.

getAd()


Gibt google.ima.dai.api.Ad zurück:Gibt ein Objekt mit Anzeigeninformationen zurück.

getStreamData()


Gibt google.ima.dai.api.StreamData zurück:Gibt ein Objekt mit Streaminformationen zurück.

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 der Fortschritt einer Anzeige aktualisiert wird
CLICK

Wird ausgelöst, wenn während der Wiedergabe einer Anzeige auf das Klickelement geklickt oder getippt wird.
COMPLETE

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

Wird für On-Demand-Streams ausgelöst, wenn sich die Cue-Punkte ändern.
ERROR

Wird ausgelöst, wenn ein Fehler auftritt
FIRST_QUARTILE

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

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

Wird ausgelöst, wenn eine Anzeige ihren Mittelpunkt erreicht
STARTED

Wird ausgelöst, wenn eine Anzeige beginnt
STREAM_INITIALIZED

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

Wird ausgelöst, wenn das dritte Quartil einer Anzeige erreicht ist

Klasse google.ima.dai.api.StreamManager

Methoden

Verarbeitet Streams zum Einfügen dynamischer Anzeigen. Er verwaltet Interaktionen mit dem Back-End für die dynamische Anzeigenbereitstellung, verarbeitet Tracking-Pings sowie die Weiterleitung von Streams und Anzeigenereignissen an den Publisher. Dieser Manager übernimmt keine Änderungen vom BaseAdsManager, da er nicht für eine bestimmte Anzeige, sondern für den gesamten Stream verwaltet wird.

Konstruktor:
Parameter Typ Beschreibung
videoElement HTMLVideoElement

Das eigentliche Videoplayer-Element

contentTimeForStreamTime(streamTime)

Gibt die Content-Zeit ohne Anzeigen für einen bestimmten Stream-Zeitpunkt zurück. Gibt die angegebene Streamzeit für Livestreams zurück.

Gibt number zurück: Die Contentzeit, 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 Wörterbuch der verarbeiteten Metadaten. Das Wörterbuch 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 Wörterbuch der Metadaten.

previousCuePointForStreamTime(streamTime)

Gibt den vorherigen Cue-Punkt für die angegebene Streamzeit zurück. Gibt null zurück, wenn kein solcher Cue-Punkt vorhanden ist. Damit können Funktionen wie das Zurückspringen implementiert werden. Sie wird aufgerufen, wenn der Publisher erkennt, dass der Nutzer eine Suche ausgeführt hat, um ihn zu einer Werbeunterbrechung zurückzukehren.

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

Parameter Typ Beschreibung
streamTime number

die gewünschte Streamzeit.

processMetadata(type, data, timestamp)

Verarbeitet zeitgesteuerte Metadaten für Livestreams. Verwenden Sie diese Option, wenn Ihr Videoplayer nicht geparste 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

Roh-Tag-Daten. Für ID3 muss das gesamte Tag angegeben werden.
timestamp number

Zeitpunkt, zu dem Daten verarbeitet werden sollen.

requestStream(streamRequest)

Fordert an, dass ein Stream mithilfe der angegebenen Streamparameter geladen wird.

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

enthält Parameter zum Laden der Stream-Metadaten.

setClickElement(clickElement)

Legt das Click-through-Element der Anzeige fest. Dieses Element wird während der Wiedergabe einer Anzeige als Empfänger für Klicks oder Tippaktionen verwendet. Dies kann dazu führen, dass die aktuelle Seite verlassen wird.

Parameter Typ Beschreibung
clickElement Element

Das Element, das für den Klick auf die Anzeige verwendet wird.

streamTimeForContentTime(contentTime)

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

Gibt number zurück: Die Streamzeit, die der angegebenen Contentzeit nach dem Einfügen von Anzeigen entspricht.

Parameter Typ Beschreibung
contentTime number

die Content-Zeit ohne Anzeigen (in Sekunden).

Klasse google.ima.dai.api.StreamRequest

Fields

Eine Klasse zum Angeben von Attributen 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 übergeben. Sie können die Parameter „dai-ot“ und „dai-ov“ für die Einstellung der Streamvarianten verwenden. Weitere Informationen finden Sie unter Parameter der Streamvarianten überschreiben.
apiKey

Der API-Schlüssel für die Streamanfrage. Sie wird über die Admin-UI von DFP konfiguriert und dem Publisher bereitgestellt, damit er seinen Content entsperren kann. Dabei werden die Anwendungen überprüft, die versuchen, auf den Inhalt zuzugreifen.
streamActivityMonitorId

Die ID, die zur Behebung von Fehlern im Stream mit der Überprüfung der Streamingaktivitäten verwendet wird. Dies ist eine bequeme Möglichkeit für Publisher, ein Stream-Log im Tool zur Überwachung der Streamingaktivitäten zu finden.

Klasse google.ima.dai.api.VODStreamRequest

Fields

Eine Klasse zum Angeben von Attributen der VOD-Streamanfrage.

Konstruktor:
Parameter Typ Beschreibung
opt_VODStreamRequest Object

Objekt, dem bereits Eigenschaften der Streamanfrage zugewiesen sind.

Attribute

Name Typ Beschreibung
contentSourceId

Eindeutige Kennung für den Publisher-Content aus einem CMS. Für On-Demand-Streams erforderlich.
videoId

ID der Quelle des Videocontents. Erforderlich für On-Demand-Streams.

Konstante google.ima.VERSION

Ein String, der die Vollversion des SDK enthält.