IMA DAI SDK für Roku

    1. ima
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Klasse ima

Methoden

Globale Funktionen, mit denen das IMA SDK gesteuert wird

disableLogging()

Deaktiviert das SDK-Logging. Logging ist standardmäßig aktiviert.

getStreamManager()

Gibt einen Stream-Manager zurück, sofern verfügbar. Wenn der Stream-Manager noch nicht verfügbar ist, wird „Ungültig“ zurückgegeben. Wenn beim Erstellen des Stream-Managers ein Fehler aufgetreten ist, wird ein Fehlerobjekt zurückgegeben.

Gibt object zurück: Das ist das Stream-Manager- oder Fehlerobjekt.

initSdk(settings)

Initialisiert das SDK.

Parameter Typ Beschreibung
settings object

Optionales IMA-Einstellungsobjekt

requestStream(streamRequest)

Startet eine asynchrone Streamanfrage. Nach dem Aufrufen dieser Methode kehrt die Steuerung sofort zum Player zurück.

Gibt object zurück: Ein Fehler oder ungültig, wenn kein Fehler vorliegt.

Parameter Typ Beschreibung
streamRequest object

Nach oben

Klasse ima.AdBreakInfo

Fields

Methoden

Enthält Informationen zu einer Werbeunterbrechung. Wird vom SDK an Ereignis-Callbacks übergeben.

Attribute

Name Typ Beschreibung
adPosition

Der Index der Anzeige in der Werbeunterbrechung. Bei eigenständigen Anzeigen wird der Wert auf 1 gesetzt.

duration

Die maximale Dauer der Unterbrechung in Sekunden oder -1, falls unbekannt.

podIndex

Bei Livestreams wird immer -1 zurückgegeben. Bei Video-on-Demand (VOD) wird der Index des Anzeigen-Pods zurückgegeben. Für einen Pre-Roll-Pod wird 0 zurückgegeben. Für Mid-Rolls wird 1, 2, ..., n zurückgegeben. Für einen Post-Roll-Pod wird n+1...n+x zurückgegeben. Die Standardeinstellung ist 0, wenn diese Anzeige nicht Teil eines Pods oder der Pod nicht Teil einer Playlist ist.

timeOffset

Die Position des Pods im Content in Sekunden. Pre-Roll gibt 0, Post-Roll -1 und Mid-Rolls die geplante Zeit des Pods zurück.

totalAds

Die Gesamtzahl der Anzeigen in dieser Werbeunterbrechung. Bei eigenständigen Anzeigen wird der Wert auf 1 gesetzt.

createAdBreakInfo()


Gibt ima.AdBreakInfo zurück:

Nach oben

Klasse ima.AdEvent

Fields

Ereignisse, die vom Google Ads-Manager ausgelöst werden

Attribute

Name Typ Beschreibung
AD_PERIOD_ENDED

Wird jedes Mal ausgelöst, wenn der Stream von Werbung oder Slate zu Content wechselt. Dieses wird auch dann ausgelöst, wenn eine Anzeige ein zweites Mal wiedergegeben wird oder wenn nach einer Anzeige gesucht wird.

AD_PERIOD_STARTED

Wird jedes Mal ausgelöst, wenn im Stream von Content zu Werbung oder Slate gewechselt wird. Dieses wird auch dann ausgelöst, wenn eine Anzeige ein zweites Mal wiedergegeben wird oder wenn nach einer Anzeige gesucht wird.

COMPLETE

Wird ausgelöst, wenn die Anzeige vollständig wiedergegeben wurde

ERROR

Wird ausgelöst, wenn ein Fehler auftritt

FIRST_QUARTILE

Wird ausgelöst, wenn der Abspielkopf der Anzeige das erste Quartil überschreitet

MIDPOINT

Wird ausgelöst, wenn der Abspielkopf der Anzeige den Mittelpunkt überschreitet

PROGRESS

Wird ausgelöst, wenn der Fortschritt einer Anzeige aktualisiert wird

SKIPPABLE_STATE_CHANGED

Wird ausgelöst, wenn sich der Status der überspringbaren Anzeige einer Anzeige ändert

SKIPPED

Wird ausgelöst, wenn eine Anzeige übersprungen wird

START

Wird ausgelöst, wenn die Wiedergabe einer Anzeige beginnt

THIRD_QUARTILE

Wird ausgelöst, wenn der Abspielkopf der Anzeige das dritte Quartil überschreitet

Nach oben

Klasse ima.AdInfo

Fields

Methoden

Enthält Informationen zu einer Anzeige. Wird vom SDK an Ereignis-Callbacks übergeben.

Attribute

Name Typ Beschreibung
adBreakInfo

Informationen zur gesamten Unterbrechung, in der diese Anzeige erscheint.

adDescription

Die Beschreibung der Anzeige.

adId

Die ID der Anzeige oder ein leerer String, falls unbekannt.

adSystem

Das Anzeigensystem, mit dem das Creative geliefert wird.

adTitle

Der Titel der Anzeige.

advertiserName

Der vom Anzeigenanbieter festgelegte Name des Werbetreibenden

companions

Die Companion-Anzeigen, die in der VAST-Antwort angegeben sind.

currentTime

Die aktuelle Zeit in einer Anzeige in Sekunden oder -1, falls unbekannt.

duration

Die Dauer dieser einzelnen Anzeige in Sekunden oder -1, falls unbekannt.

universalAdIDRegistry

Ein String, mit dem die URL der Registry-Website identifiziert wird, auf der die universelle Anzeigen-ID des ausgewählten Creatives katalogisiert wird.

universalAdIDValue

Die universelle Anzeigen-ID des ausgewählten Creatives für die Anzeige.

wrappers

Ein Array von ima.WrapperInfo mit Wrapper-Informationen für diese Anzeige. Die Reihenfolge ist vom äußeren Wrapper zum inneren.

createAdInfo()


Gibt ima.AdInfo zurück:

Nach oben

Klasse ima.Companion

Fields

Methoden

Enthält Informationen zu den Companion-Creatives einer Anzeige.

Attribute

Name Typ Beschreibung
apiFramework

Die API, die zum Ausführen dieser Anzeige erforderlich ist, oder ist ungültig, falls nicht verfügbar.

creativeType

Der Creative-Typ ist normalerweise ein MIME-Typ.

height

Die Höhe des Companion in Pixeln. 0, falls nicht verfügbar.

trackingEvents

Eine Zuordnung von Tracking-Ereignissen, wobei der Schlüssel das Ereignis und der Wert eine Liste von URLs ist, die bei diesem Ereignis angepingt werden sollen.

url

Die URL für die statische Ressource dieses Companion.

width

Die Breite der Companion-Anzeige in Pixeln. 0, falls nicht verfügbar.

createCompanion()


Gibt ima.Companion zurück:

Nach oben

Klasse ima.CuePoint

Fields

Methoden

Enthält Informationen zu einem Cue-Punkt.

Attribute

Name Typ Beschreibung
end

Die Endzeit für einen Cue-Punkt in Sekunden. Sie entspricht einer Werbeunterbrechung.

hasPlayed

Ein boolescher Wert, der angibt, dass der Cue-Punkt bereits abgespielt wurde.

start

Die Startzeit für einen Cue-Point in Sekunden. Sie entspricht einer Werbeunterbrechung.

createCuePoint()


Gibt ima.CuePoint zurück:

Nach oben

Klasse ima.Error

Fields

Methoden

Objekt, das an den Fehler-Handler übergeben wird, wenn ein Fehler vorliegt.

Attribute

Name Typ Beschreibung
id

Die ID des Fehlers. Eine Liste der Fehlercodes finden Sie in der ErrorEvent-Konstante.

info

Weitere Informationen zum Fehler.

type

Wird immer auf „error“ gesetzt, um den Typ dieses Objekts anzugeben.

createError()


Gibt ima.Error zurück:

Nach oben

Klasse ima.ErrorEvent

Fields

Alle Fehler, die das SDK möglicherweise zurücksendet.

Attribute

Name Typ Beschreibung
BAD_STREAM_REQUEST

Die Streamanfrage wurde nicht richtig ausgefüllt.

COULD_NOT_LOAD_STREAM

Der Stream konnte nicht geladen werden.

ERROR

Unbekannter Fehler.

INVALID_RESPONSE

Die Serverantwort war ungültig.

STREAM_API_KEY_NOT_VALID

Der angegebene API-Schlüssel wurde vom Server nicht akzeptiert.

Nach oben

Klasse ima.Player

Methoden

adBreakEnded(adBreakInfo)

Optional. Wird nach dem Ende einer Werbeunterbrechung aufgerufen

Parameter Typ Beschreibung
adBreakInfo ima.AdBreakInfo

Enthält Informationen zur Werbeunterbrechung.

adBreakStarted(adBreakInfo)

Optional. Wird aufgerufen, wenn eine Werbeunterbrechung begonnen hat

Parameter Typ Beschreibung
adBreakInfo ima.AdBreakInfo

Enthält Informationen zur Werbeunterbrechung.

allVideoComplete()

Optional. Wird aufgerufen, wenn alle Videos abgeschlossen sind.

createPlayer()

Erstellt ein leeres IMA-Player-Objekt. Sie müssen die Funktion loadUrl implementieren, damit Anzeigen wiedergegeben werden. Andere Funktionen sind optional.

Gibt ima.Player zurück:

loadUrl(streamInfo)

Wird aufgerufen, wenn der Player mit der Wiedergabe einer URL beginnen soll. Sie müssen diese Methode implementieren, um den Stream zu laden.

Parameter Typ Beschreibung
streamInfo ima.StreamInfo

Enthält Informationen, die zum Abspielen von Inhalten erforderlich sind.

Nach oben

Klasse ima.StreamFormat

Fields

DASH und HLS

Definiert das Format des Streams.

Attribute

Name Typ Beschreibung
DASH

HLS

Nach oben

Klasse ima.StreamInfo

Fields

Methoden

Informationen, die vom SDK an den Player zum Stream übergeben werden.

Attribute

Name Typ Beschreibung
format

Das Format des Videos: hls oder Bindestrich. Wird in ima.StreamFormat definiert.

manifest

URL für den Stream.

streamId

Eine eindeutige ID für den Stream.

streamType

Die Art des Videos: Live oder On-Demand. Wird in ima.StreamType definiert.

subtitles

Untertitel, falls verfügbar. Andernfalls ist dies ungültig.

createStreamInfo()


Gibt ima.StreamInfo zurück:

Nach oben

Klasse ima.StreamManager

Methoden

Objekt zur Verwaltung der Streamwiedergabe.

addEventListener(event, callback)

Fügt einen Listener für das angegebene Ereignis hinzu. Informationen zu unterstützten Ereignissen finden Sie in der AdEvents-Konstante.

Parameter Typ Beschreibung
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


Gibt ima.StreamManager zurück:

Parameter Typ Beschreibung
streamRequest ima.StreamRequest

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Nicht unterstützt. Leiten Sie die Daten stattdessen direkt von der Companion-Anzeige an RAF weiter. Das ist jetzt keine Operation.

getContentTime(streamTime)

Ruft eine Zeit in Millisekunden für einen VOD-Stream ab, die die Zeit im Content ohne Anzeigen darstellt. Weitere Informationen: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq So rufen Sie die Content-Zeit für die aktuelle Streamzeit in -1 ab.

Gibt Integer zurück: Die Contentzeit, die der angegebenen Streamzeit entspricht.

Parameter Typ Beschreibung
streamTime Integer

Die Zeit im Stream.

getCuePoints()

Gibt alle Cue-Punkte zurück, die allen Werbeunterbrechungen entsprechen Dies gilt nur für Video-on-Demand-Content, bei dem alle Werbeunterbrechungen im Voraus bekannt sind. Alle Zeiten stellen die Streamzeit in Sekunden dar.

Gibt Object zurück: Ein Array mit allen Cue-Punkten.

getPreviousCuePoint(time)

Gibt den Cue-Punkt vor dieser Zeit zurück. Der Cue-Punkt kennzeichnet eine Werbeunterbrechung. Alle Zeiten stellen die Streamzeit in Sekunden dar.

Gibt ima.CuePoint zurück: Ein Objekt mit „start“, „end“ und „hasPlayed“. Gibt "Ungültig" zurück, wenn kein Cue-Punkt verfügbar ist.

Parameter Typ Beschreibung
time Float

Nachschlagezeit, -1 steht für die aktuelle Zeit.

getStreamTime(contentTime)

Ruft die Zeit für den Stream ab einer Inhaltszeit für VOD in Millisekunden ab. Weitere Informationen: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

Gibt Integer zurück: Die Streamzeit, die der angegebenen Contentzeit entspricht.

Parameter Typ Beschreibung
contentTime Integer

Die Zeit des Inhalts.

loadThirdPartyStream(streamManifest, streamSubtitle)

Lädt die Anzeigenmetadaten und ruft die Funktion loadUrl mit den bereitgestellten streamManifestUrl- und streamSubtitle-Daten auf. Diese Funktion funktioniert nur, wenn der Streamanfragetyp ima.StreamType.POD_VOD ist.

Parameter Typ Beschreibung
streamManifest string

Die Stream-Manifest-URL mit den zusammengesetzten Anzeigen

streamSubtitle ifArray>|Invalid

Die Untertitel sind mit dem Stream verknüpft oder Invalid, wenn keiner vorhanden ist.

onMessage(msg)

Verarbeitet alle Nachrichten, die vom Videoobjekt kommen. Muss für jede über den roMessagePort empfangene Nachricht aufgerufen werden.

Parameter Typ Beschreibung
msg object

Die Nachricht vom roVideo-Port.

replaceAdTagParameters(adTagParameters)

Ersetzt alle Anzeigen-Tag-Parameter, die für die anstehenden Anzeigenanfragen für einen Livestream verwendet werden sollen. Dieser Aufruf ist für VOD-Streams funktionsunfähig.

Parameter Typ Beschreibung
adTagParameters string

Die neuen Anzeigen-Tag-Parameter.

start()

Startet die Wiedergabe des Streams.

Nach oben

Klasse ima.StreamRequest

Fields

Methoden

Wird zum Angeben von Attributen der Streamanfrage verwendet.

Attribute

Name Typ Beschreibung
adTagParameters

Optional. Sie können eine begrenzte Anzahl von Anzeigen-Tag-Parametern in Ihrer Streamanfrage überschreiben. Weitere Informationen finden Sie unter Targeting-Parameter an einen Stream senden. Sie können auch die Parameter „dai-ot“ und „dai-ov“ für die Präferenz der Streamvarianten verwenden. Weitere Informationen finden Sie unter Parameter von Streamvarianten überschreiben.

adUiNode

Knoten für Szenendiagramm, auf dem die Anzeigen-UI zu sehen ist Im IMA werden während der Anzeigen Elemente wie Warum sehe ich diese Werbung? und Überspringen in diesem Element platziert. Das Element muss das gesamte Videoelement überlagern.

apiKey

Optional. Diese Schlüssel können zum Authentifizieren von Streamanfragen verwendet werden. Authentifizierungsschlüssel für die dynamische Anzeigenbereitstellung müssen auf der DFP-Benutzeroberfläche eingerichtet werden.

assetKey

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

authToken

Das Autorisierungstoken für die Streamanfrage. Wird anstelle des API-Schlüssels für eine strengere Inhaltsautorisierung verwendet. Der Verlag oder Webpublisher kann die Autorisierungen einzelner Inhaltsstreams anhand dieses Tokens steuern.

contentSourceId

Erforderlich für On-Demand-Streams. Die cmsid stammt aus der Quelle für Videocontent in der DFP-Benutzeroberfläche.

customAssetKey

Mit dem benutzerdefinierten Asset-Schlüssel wird festgelegt, welcher Stream abgespielt werden soll. Für Streamanfragen für die Pod-Auslieferung sind benutzerdefinierte Asset-Schlüssel erforderlich.

format

Das Format des Streams. Die Standardeinstellung ist ima.StreamFormat.HLS.

networkCode

Netzwerkcode des Publishers, der die Streamanfrage stellt. Netzwerkcodes sind für Streamanfragen für die Pod-Bereitstellung erforderlich.

player

Eine Implementierung der Player-Oberfläche.

ppid

Veraltet. Verwenden Sie „adTagParameters“. Optional. Eine vom Publisher bereitgestellte Kennung in DFP Audience.

streamActivityMonitorId

Die ID, die zur Fehlerbehebung für den Stream mit der Überwachung der Streamingaktivitäten verwendet werden soll. So können Publisher ganz einfach ein Stream-Log im Tool zur Überwachung der Streamaktivität abrufen.

videoId

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

videoObject

Das Videoobjekt (z. B. das Video roSGNode), das für die Videowiedergabe in der Client-App verantwortlich ist. Dieses Objekt wird abgefragt, um verschiedene Daten für das richtige Timing von HLS ID3-Live-Ereignissen zu verwenden.

createLiveStreamRequest(assetKey, apiKey)

Initialisiert erforderliche Attribute einer Live-StreamRequest. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, erfolgt das Fehler-Logging und die API gibt eine generische StreamRequest zurück. Attribute werden dabei nicht ignoriert.

Gibt ima.StreamRequest zurück: ima.StreamRequest-Objekt mit den erforderlichen Live-Properties.

Parameter Typ Beschreibung
assetKey string

apiKey string

Optionaler Parameter, der dem zurückgegebenen Attribut apiKey von StreamRequest zugewiesen wird. Der Standardwert ist ein leerer String.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Initialisiert erforderliche Attribute einer Pod-Live-ima.StreamRequest. Bei Verwendung dieser API werden alle anderen ima.StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, erfolgt das Fehler-Logging und die API gibt eine generische StreamRequest zurück. Attribute werden dabei nicht ignoriert.

Gibt StreamRequest zurück: ima.StreamRequest-Objekt mit den erforderlichen PodLive-Attributen.

Parameter Typ Beschreibung
customAssetKey string

networkCode string

apiKey string

Optionaler Parameter, der dem Attribut ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequests zugewiesen wird. Der Standardwert ist ein leerer String.

createPodVodStreamRequest(networkCode)

Initialisiert die erforderlichen Attribute eines ima.StreamRequest, um einen VOD-Stream zu registrieren, wenn die Pod-Auslieferung mit dynamischer Anzeigenbereitstellung mit einem Video-Stitcher-Tool eines Drittanbieters verwendet wird. Diese Funktion setzt den Anfragetyp auf ima.StreamType.POD_VOD und validiert alle erforderlichen Attribute auf fehlende Daten. Bei fehlgeschlagenen Validierungen wird in der Debug-Konsole ein Fehler protokolliert.

Gibt StreamRequest zurück: ein ima.StreamRequest-Objekt. Wenn alle erforderlichen Attribute angegeben sind, wird der Anfragetyp auf ima.StreamType.POD_VOD festgelegt.

Parameter Typ Beschreibung
networkCode string

den Google Ad Manager-Netzwerkcode

createStreamRequest()


Gibt ima.StreamRequest zurück: Ein leeres ima.StreamRequest-Objekt.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Initialisiert erforderliche Eigenschaften einer Live-StreamRequest von Video Stitcher Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, erfolgt das Fehler-Logging und die API gibt eine generische StreamRequest zurück. Attribute werden dabei nicht ignoriert.

Gibt ima.StreamRequest zurück: ima.StreamRequest-Objekt mit den erforderlichen VideoStitcherLive-Eigenschaften.

Parameter Typ Beschreibung
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Initialisiert erforderliche Attribute eines Video Stitcher-VOD-StreamRequest. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, erfolgt das Fehler-Logging und die API gibt eine generische StreamRequest zurück. Attribute werden dabei nicht ignoriert.

Gibt ima.StreamRequest zurück: ima.StreamRequest-Objekt mit den erforderlichen VideoStitcherVod-Eigenschaften.

Parameter Typ Beschreibung
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey)

Initialisiert erforderliche Attribute eines VOD-ima.StreamRequest. Wenn Sie diese API verwenden, werden alle anderen ima.StreamType-spezifischen Attribute ignoriert. Wenn erforderliche Parameter leere Strings sind, erfolgt das Fehler-Logging und die API gibt eine generische StreamRequest zurück. Attribute werden dabei nicht ignoriert.

Gibt ima.StreamRequest zurück: ima.StreamRequest-Objekt mit den erforderlichen VOD-Attributen.

Parameter Typ Beschreibung
contentSourceId string

videoId string

apiKey string

Optionaler Parameter, der dem Attribut ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequests zugewiesen wird. Der Standardwert ist ein leerer String.

Nach oben

Klasse ima.StreamType

Fields

Definiert die Art des Streams, den der Player wiedergeben soll. Pre-Rolls und VOD sollten am Anfang des Streams abgespielt werden.

Attribute

Name Typ Beschreibung
LIVE

Das Video ist online.

VOD

Das Video ist on demand.

Nach oben

Klasse ima.WrapperInfo

Fields

Methoden

Enthält Informationen zu einem Wrapper.

Attribute

Name Typ Beschreibung
adId

Die ID der Anzeige oder ein leerer String, falls unbekannt.

adSystem

Der deklarierte Name des Anzeigensystems oder ein leerer String, falls unbekannt.

creativeAdId

Die Anzeigen-ID im Creative oder ein leerer String, falls unbekannt.

creativeId

Die ID des Creatives oder ein leerer String, falls unbekannt.

dealId

Die Deal-ID oder ein leerer String, falls unbekannt.

createWrapperInfo()


Gibt ima.WrapperInfo zurück:

Nach oben