IMA DAI SDK für Roku

1. 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

Class ima

Methoden

disableLogging, getStreamManager, initSdk, requestStream

Globale Funktionen, die das IMA SDK steuern.

disableLogging()

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

getStreamManager()

Gibt einen Streammanager zurück, falls verfügbar. Wenn der Streammanager 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.

object zurückgibt:den Streammanager oder das Fehlerobjekt.

initSdk(settings)

Initialisiert das SDK.

Parameter	Typ	Beschreibung
settings	object	Optionales IMA-Einstellungen-Objekt.

requestStream(streamRequest)

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

Gibt object zurück: einen Fehler oder „ungültig“, wenn kein Fehler vorliegt

Parameter	Typ	Beschreibung
streamRequest	object

Nach oben

Klasse ima.AdBreakInfo

Fields

adPosition, duration, podIndex, timeOffset, totalAds

Methoden

createAdBreakInfo

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. Für eigenständige Anzeigen ist der Index 1.
duration		Die maximale Dauer der Werbeunterbrechung in Sekunden oder -1, wenn sie unbekannt ist.
podIndex		Bei Livestreams wird die Unterbrechungs-ID als Pod-Index zurückgegeben. Bei Prerolls wird 0 zurückgegeben. In Livestreams gibt es keine Postrolls. Die Standardeinstellung ist -2. Bei Video-on-Demand (VOD) wird der Index des Anzeigen-Pods zurückgegeben. Für einen Preroll-Pod wird 0 zurückgegeben. Für Mid-Roll-Anzeigen wird 1, 2, …, n zurückgegeben. Für einen Postroll-Pod wird n + 1…n + x zurückgegeben. Standardmäßig wird 0 verwendet, wenn diese Anzeige nicht Teil eines Pods ist oder dieser Pod nicht Teil einer Playlist ist.
timeOffset		Die Position des Pods im Video in Sekunden. Für Pre-Rolls wird 0, für Post-Rolls -1 und für Mid-Rolls die geplante Zeit des Pods zurückgegeben.
totalAds		Die Gesamtzahl der Anzeigen in dieser Werbeunterbrechung. Bei eigenständigen Anzeigen ist der Wert 1.

createAdBreakInfo()

Rückgaben ima.AdBreakInfo:

Nach oben

Klasse ima.AdEvent

Fields

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED, START, THIRD_QUARTILE

Vom Anzeigenmanager ausgelöste Ereignisse.

Attribute

Name	Typ	Beschreibung
AD_PERIOD_ENDED		Wird jedes Mal ausgelöst, wenn der Stream von Werbung oder einem Slate zu Inhalten wechselt. Das Ereignis wird auch ausgelöst, wenn eine Anzeige ein zweites Mal wiedergegeben wird oder wenn ein Nutzer zu einer Anzeige springt.
AD_PERIOD_STARTED		Wird jedes Mal ausgelöst, wenn der Stream von Inhalten zu Werbung oder einem Slate wechselt. Das Ereignis wird auch ausgelöst, wenn eine Anzeige ein zweites Mal wiedergegeben wird oder wenn ein Nutzer zu einer Anzeige springt.
COMPLETE		Wird ausgelöst, wenn die Anzeige vollständig ausgeliefert wurde
ERROR		Wird ausgelöst, wenn ein Fehler auftritt.
FIRST_QUARTILE		Wird ausgelöst, wenn der Wiedergabevorlauf der Anzeige das erste Quartil überschreitet.
ICON_FALLBACK_IMAGE_CLOSED		Wird ausgelöst, wenn der Nutzer das Dialogfeld für das Symbol-Fallback-Bild schließt.
ICON_FALLBACK_IMAGE_SHOWN		Wird ausgelöst, wenn das Ersatzbild für das Symbol angezeigt wird.
MIDPOINT		Wird ausgelöst, wenn der Abspielkopf der Anzeige die Mitte erreicht.
PROGRESS		Wird ausgelöst, wenn es Neuigkeiten zum Fortschritt einer Anzeige gibt.
SKIPPABLE_STATE_CHANGED		Wird ausgelöst, wenn sich der Status einer überspringbaren Anzeige ändert.
SKIPPED		Wird ausgelöst, wenn eine Anzeige übersprungen wird.
START		Wird ausgelöst, wenn die Auslieferung der Anzeige beginnt
THIRD_QUARTILE		Wird ausgelöst, wenn der Wiedergabevorlauf der Anzeige das dritte Quartil überschreitet.

Nach oben

Klasse ima.AdInfo

Fields

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, creativeAdId, creativeId, currentTime, dealId, duration, skipOffset, universalAdIDRegistry, universalAdIDValue, wrappers

Methoden

createAdInfo

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

Attribute

Name	Typ	Beschreibung
adBreakInfo		Informationen zur gesamten Werbeunterbrechung, in der sich die Anzeige befindet.
adDescription		Die Beschreibung der Anzeige.
adId		Die ID der Anzeige oder ein leerer String, falls unbekannt.
adSystem		Das Anzeigensystem, das das Creative bereitstellt.
adTitle		Der Titel der Anzeige.
advertiserName		Der vom Anzeigenbereitsteller angegebene Name des Werbetreibenden.
companions		Die in der VAST-Antwort angegebenen Companion-Anzeigen.
creativeAdId		Der ISCI-Code (Industry Standard Commercial Identifier) für eine Anzeige. Das ist die Anzeigen-ID des ausgewählten Creatives in der VAST-Antwort.
creativeId		Die ID des ausgewählten Creatives für die Anzeige.
currentTime		Die aktuelle Zeit in einer Anzeige in Sekunden oder -1, wenn unbekannt.
dealId		Gibt die erste Deal-ID zurück, die in der Wrapper-Kette für die aktuelle Anzeige vorhanden ist, beginnend oben.
duration		Die Dauer dieser einzelnen Anzeige in Sekunden oder „-1“, wenn sie nicht bekannt ist.
skipOffset		Die Zeit, die vergeht, bis die Anzeige übersprungen werden kann, oder „-1“, wenn das nicht bekannt ist.
universalAdIDRegistry		Ein String, mit dem die URL der Registrierungswebsite angegeben wird, auf der die Universal-Anzeigen-ID des ausgewählten Creatives katalogisiert ist.
universalAdIDValue		Die universelle Anzeigen-ID des ausgewählten Creatives für die Anzeige.
wrappers		Ein Array von ima.WrapperInfo mit Informationen zum Wrapper für diese Anzeige. Die Reihenfolge ist vom äußeren zum inneren Umschlag.

createAdInfo()

Rückgaben ima.AdInfo:

Nach oben

Klasse ima.Companion

Fields

apiFramework, creativeType, height, trackingEvents, url, width

Methoden

createCompanion

Enthält Informationen zu Companion-Creatives einer Anzeige.

Attribute

Name	Typ	Beschreibung
apiFramework		Die API, die für die Ausführung dieser Anzeige erforderlich ist, oder „Ungültig“, falls nicht verfügbar.
creativeType		Stellt den Creative-Typ dar, in der Regel ein MIME-Typ.
height		Die Höhe des Companion-Widgets in Pixeln. 0, wenn nicht verfügbar.
trackingEvents		Eine Zuordnung von Tracking-Ereignissen, bei der das Ereignis der Schlüssel und der Wert eine Liste von URLs ist, die bei diesem Ereignis gepingt werden sollen.
url		Die URL für die statische Ressource dieses Companion-Videos.
width		Die Breite des Companion-Widgets in Pixeln. 0, wenn nicht verfügbar.

createCompanion()

Rückgaben ima.Companion:

Nach oben

Klasse ima.CuePoint

Fields

end, hasPlayed, start

Methoden

createCuePoint

Enthält Informationen zu einem Cue-Punkt.

Attribute

Name	Typ	Beschreibung
end		Die Endzeit eines Cue-Punkts in Sekunden. Das entspricht einer Werbeunterbrechung.
hasPlayed		Ein boolescher Wert, der angibt, ob der Cue-Punkt bereits wiedergegeben wurde.
start		Der Startzeitpunkt eines Cue-Punkts in Sekunden. Das entspricht einer Werbeunterbrechung.

createCuePoint()

Rückgaben ima.CuePoint:

Nach oben

Klasse ima.Error

Fields

id, info, type

Methoden

createError

Objekt, das an den Fehlerhandler übergeben wird, wenn ein Fehler auftritt.

Attribute

Name	Typ	Beschreibung
id		Die ID des Fehlers. Eine Liste der Fehlercodes finden Sie in der Konstante „ErrorEvent“.
info		Zusätzliche Informationen zum Fehler.
type		Geben Sie immer „error“ an, um den Typ dieses Objekts anzugeben.

createError()

Rückgaben ima.Error:

Nach oben

Klasse ima.ErrorEvent

Fields

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Alle Fehler, die vom SDK zurückgegeben werden können.

Attribute

Name	Typ	Beschreibung
BAD_STREAM_REQUEST		Die Streamanfrage wurde nicht richtig ausgefüllt.
COULD_NOT_LOAD_STREAM		Stream konnte nicht geladen werden.
ERROR		Ein 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, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

Optional. Wird aufgerufen, wenn eine Werbeunterbrechung beendet wurde.

Parameter	Typ	Beschreibung
adBreakInfo	ima.AdBreakInfo	Enthält Informationen zur Werbeunterbrechung.

adBreakStarted(adBreakInfo)

Optional. Wird aufgerufen, wenn eine Werbeunterbrechung gestartet wird.

Parameter	Typ	Beschreibung
adBreakInfo	ima.AdBreakInfo	Enthält Informationen zur Werbeunterbrechung.

allVideoComplete()

Optional. Wird aufgerufen, wenn das gesamte Video fertig ist.

createPlayer()

Erstellt ein leeres IMA-Player-Objekt. Du musst die Funktion loadUrl implementieren, um Anzeigen wiederzugeben. Andere Funktionen sind optional.

Rückgabe von ima.Player:

loadUrl(streamInfo)

Wird aufgerufen, wenn der Player mit der Wiedergabe einer URL beginnen soll. Du musst 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, HLS

Definiert das Format des Streams.

Attribute

Name	Typ	Beschreibung
DASH
HLS

Nach oben

Klasse ima.StreamInfo

Fields

format, manifest, streamId, streamType, subtitles

Methoden

createStreamInfo

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

Attribute

Name	Typ	Beschreibung
format		Das Videoformat: hls oder dash. Definiert in „ima.StreamFormat“.
manifest		URL für den Stream.
streamId		Eine eindeutige ID für den Stream.
streamType		Der Videotyp: live oder on demand Definiert in ima.StreamType.
subtitles		Untertitel, falls verfügbar Andernfalls ist der Wert ungültig.

createStreamInfo()

Rückgaben ima.StreamInfo:

Nach oben

Klasse ima.StreamManager

Methoden

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters, start

Objekt zum Verwalten 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)

Rückgaben ima.StreamManager:

Parameter	Typ	Beschreibung
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Nicht unterstützt. Geben Sie die Daten stattdessen direkt von der Companion-Anzeige an die RAF weiter. Dieser Vorgang ist jetzt nicht mehr erforderlich.

getContentTime(streamTime)

Gibt eine Zeit in Millisekunden für einen VOD-Stream zurück, die der Zeit im Video ohne Anzeigen entspricht. Weitere Informationen finden Sie in den häufig gestellten Fragen. Gib -1 ein, um die Inhaltszeit für die aktuelle Streamzeit abzurufen.

Gibt Integer zurück:Die Inhaltszeit, 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. Das gilt nur für VOD-Inhalte (Video on Demand), bei denen alle Werbeunterbrechungen im Voraus bekannt sind. Alle Zeiten geben die Streamingzeit in Sekunden an. Bei Cloud Stitching API-Streams ist das hasPlayed-Attribut jedes ima.CuePoint immer „false“.

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

getPreviousCuePoint(time)

Gibt den Cue-Punkt zurück, der diesem Zeitpunkt vorausgeht. Der Cue-Punkt gibt eine Werbeunterbrechung an. Alle Zeiten geben die Streamingzeit in Sekunden an.

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

Parameter	Typ	Beschreibung
time	Float	Die Zeit, die abgefragt werden soll. -1 gibt die aktuelle Zeit an und für alle anderen Streams wird Invalid zurückgegeben.

getStreamTime(contentTime)

Ermittelt die Zeit für den Stream aus einer Inhaltszeit für VOD in Millisekunden. Weitere Informationen finden Sie in den häufig gestellten Fragen.

Integer zurückgibt:Die Streamzeit, die der angegebenen Inhaltszeit entspricht.

Parameter	Typ	Beschreibung
contentTime	Integer	Die Zeit der Inhalte.

loadThirdPartyStream(streamManifest, streamSubtitle)

Hier werden die Anzeigenmetadaten geladen und die Funktion loadUrl mit den angegebenen streamManifestUrl- und streamSubtitle-Daten aufgerufen. Diese Funktion funktioniert nur, wenn der Streamanfragetyp ima.StreamType.POD_VOD ist.

Parameter	Typ	Beschreibung
streamManifest	string	Die Manifest-URL des Streams mit eingeblendeten Anzeigen.
streamSubtitle	ifArray>|Invalid	Die Untertitel, die mit dem Stream verknüpft sind, oder Invalid, falls keine vorhanden sind.

onMessage(msg)

Hier werden alle Nachrichten verarbeitet, die vom Videoobjekt stammen. Muss für jede Nachricht aufgerufen werden, die über den roMessagePort empfangen wird.

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. Hinweis: Bei VOD-Streams ist dieser Aufruf ohne Funktion.

Parameter	Typ	Beschreibung
adTagParameters	string	Die neuen Parameter für Anzeigen-Tags.

start()

Startet die Wiedergabe des Streams.

Nach oben

Klasse ima.StreamRequest

Fields

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, ppid, streamActivityMonitorId, videoId, videoObject, videoStitcherSessionOptions

Methoden

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

Wird verwendet, um Eigenschaften der Streamanfrage anzugeben.

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 übertragen. Du kannst auch die Parameter „dai-ot“ und „dai-ov“ für die Streamvariantenpräferenz verwenden. Weitere Informationen finden Sie unter Parameter von Streamvarianten überschreiben.
adUiNode		Ein Knoten der Szenengraphik, auf dem die Anzeigen-UI angezeigt wird. IMA platziert während der Anzeigen Elemente wie Warum sehe ich diese Werbung? und Schaltflächen wie Überspringen auf diesem Element. Das Element muss das gesamte Videoelement überlagern.
apiKey		Optional. Diese Schlüssel können zur Authentifizierung von Streamanfragen verwendet werden. Authentifizierungsschlüssel für die dynamische Anzeigenbereitstellung müssen in der DFP-Benutzeroberfläche eingerichtet werden.
assetKey		Erforderlich für Livestreams. Damit wird festgelegt, welcher Stream wiedergegeben werden soll. Der Asset-Schlüssel der Livestreamanfrage ist eine Kennung, die du in der DFP-Benutzeroberfläche findest.
authToken		Das Autorisierungstoken für die Streamanfrage. Wird anstelle des API-Schlüssels für eine strengere Inhaltsautorisierung verwendet. Der Publisher kann die Autorisierungen für einzelne Inhaltsstreams basierend auf diesem Token steuern.
contentSourceId		Erforderlich für On-Demand-Streams. Die cmsid stammt aus der DFP-Videocontentquelle auf der DFP-Benutzeroberfläche.
customAssetKey		Anhand des benutzerdefinierten Asset-Schlüssels wird bestimmt, welcher Stream wiedergegeben werden soll. Benutzerdefinierte Asset-Schlüssel sind für Streamanfragen beim Pod-Auslieferungsmodus erforderlich.
format		Das Format des Streams. Die Standardeinstellung ist ima.StreamFormat.HLS.
networkCode		Der Netzwerkcode des Publishers, der die Streamanfrage stellt. Netzwerkcodes sind für Streamanfragen zur Pod-Auslieferung erforderlich, die mit „createPodLiveStreamRequest“ oder „createPodVodStreamRequest“ gesendet werden. Diese Codes sind auch für Cloud Stitching-Streamanfragen erforderlich, die mit den Funktionen „createVideoStitcherLiveStreamRequest“, „createVideoStitcherVodStreamRequest“ oder „createVideoStitcherVodStreamRequestWithVodConfig“ gesendet werden. Diese Codes sind optional und werden für Anfragen für Full-Service-Streams empfohlen, die mit createLiveStreamRequest oder createVodStreamRequest gesendet werden. Wenn Sie den Netzwerkcode hinzufügen, werden die in der Ad Manager-Benutzeroberfläche ausgewählten Einstellungen angewendet, z. B. die Aktivierung programmatisch eingeschränkter Anzeigen. Beim Pod-Auslieferung und Cloud-Stitching wird der Stream durch Hinzufügen des Netzwerkcodes gefunden und wiedergegeben. Wie du den Netzwerkcode findest, erfährst du hier.
player		Eine Implementierung der Player-Oberfläche.
ppid		Verworfen. Verwenden Sie „adTagParameters“. Optional. Eine vom Publisher bereitgestellte Kennung für DFP Audience
streamActivityMonitorId		Die ID, die für die Fehlerbehebung des Streams mit der Überwachung der Streamingaktivitäten verwendet werden soll. So können Publisher ganz einfach ein Streamprotokoll im Tool zur Überwachung der Streamingaktivitäten finden.
videoId		Erforderlich für On-Demand-Streams. Kennung für die Quelle der Videoinhalte.
videoObject		Das Videoobjekt (z. B. der Video-roSGNode), das für die Videowiedergabe in der Client-App verantwortlich ist. Dieses Objekt wird auf verschiedene Daten geprüft, die für die korrekte Zeitabfolge von Live-HLS-ID3-Ereignissen verwendet werden.
videoStitcherSessionOptions		Mit den Sitzungsoptionen werden Video Stitcher-spezifische Parameter für VideoStitcher-Streamanfragen festgelegt.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Erforderliche Properties einer Live-StreamRequest initialisieren. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Properties ignoriert. Wenn erforderliche Parameter leere Strings sind, wird eine Fehlerprotokollierung ausgeführt und die API gibt eine generische StreamRequest zurück, wobei keine Eigenschaften ignoriert werden.

Ergibt ima.StreamRequest:ima.StreamRequest-Objekt mit erforderlichen Live-Properties.

Parameter	Typ	Beschreibung
assetKey	string
apiKey	string	Parameter, der der Eigenschaft ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequest zugewiesen ist. Wenn kein API-Schlüssel vorhanden ist, geben Sie einen leeren String an.
networkCode	string	Netzwerkcode des Publishers, der die Streamanfrage stellt. Das Einfügen des Netzwerkcodes ist optional, wird aber empfohlen.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Erforderliche Eigenschaften eines Pod Live ima.StreamRequest initialisieren Wenn Sie diese API verwenden, werden alle anderen ima.StreamType-spezifischen Properties ignoriert. Wenn erforderliche Parameter leere Strings sind, wird eine Fehlerprotokollierung ausgeführt und die API gibt eine generische StreamRequest zurück, wobei keine Eigenschaften ignoriert werden.

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

Parameter	Typ	Beschreibung
customAssetKey	string
networkCode	string
apiKey	string	Optionaler Parameter, der der Eigenschaft ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequest zugewiesen ist. Standardmäßig ist der String leer.

createPodVodStreamRequest(networkCode)

Die erforderlichen Eigenschaften eines ima.StreamRequest werden initialisiert, um einen VOD-Stream zu registrieren, wenn die Auslieferung von DAI-Pods mit einem Video-Stitcher von Drittanbietern verwendet wird. Mit dieser Funktion wird der Anfragetyp auf ima.StreamType.POD_VOD festgelegt und alle erforderlichen Properties werden auf fehlende Daten geprüft. Bei fehlgeschlagenen Validierungen wird ein Fehler in der Debugkonsole protokolliert.

Rückgabe von StreamRequest:ein ima.StreamRequest-Objekt. Wenn alle erforderlichen Properties angegeben sind, wird der Anfragetyp auf ima.StreamType.POD_VOD festgelegt.

Parameter	Typ	Beschreibung
networkCode	string	den Google Ad Manager-Netzwerkcode

createStreamRequest()

ima.StreamRequest zurückgibt:Ein leeres ima.StreamRequest-Objekt.

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

Erforderliche Properties eines Video Stitcher Live-StreamRequest werden initialisiert. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Properties ignoriert. Wenn erforderliche Parameter leere Strings sind, wird eine Fehlerprotokollierung ausgeführt und die API gibt eine generische StreamRequest zurück, wobei keine Eigenschaften ignoriert werden.

Ergibt ima.StreamRequest:ima.StreamRequest-Objekt mit den erforderlichen VideoStitcherLive-Properties.

Parameter	Typ	Beschreibung
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

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

Erforderliche Properties einer Video Stitcher VOD-StreamRequest werden initialisiert. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Properties ignoriert. Wenn erforderliche Parameter leere Strings sind, wird eine Fehlerprotokollierung ausgeführt und die API gibt eine generische StreamRequest zurück, wobei keine Eigenschaften ignoriert werden.

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

Parameter	Typ	Beschreibung
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Erforderliche Eigenschaften einer Video Stitcher VOD-StreamRequest werden mit vodConfigId initialisiert, die im Cloud-Video-Stitching-Tool erstellt wurden. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Properties ignoriert. Wenn erforderliche Parameter leere Strings sind, wird eine Fehlerprotokollierung ausgeführt und die API gibt eine generische StreamRequest zurück, wobei keine Eigenschaften ignoriert werden.

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

Parameter	Typ	Beschreibung
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Erforderliche Properties einer VOD-ima.StreamRequest initialisieren. Wenn Sie diese API verwenden, werden alle anderen ima.StreamType-spezifischen Properties ignoriert. Wenn erforderliche Parameter leere Strings sind, wird eine Fehlerprotokollierung ausgeführt und die API gibt eine generische StreamRequest zurück, wobei keine Eigenschaften ignoriert werden.

Ergibt ima.StreamRequest: ima.StreamRequest-Objekt mit erforderlichen VOD-Properties.

Parameter	Typ	Beschreibung
contentSourceId	string
videoId	string
apiKey	string	Parameter, der der Eigenschaft ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequest zugewiesen ist. Wenn kein API-Schlüssel vorhanden ist, geben Sie einen leeren String an.
networkCode	string	Netzwerkcode des Publishers, der die Streamanfrage stellt. Das Einfügen des Netzwerkcodes ist optional, wird aber empfohlen.

Nach oben

Class ima.StreamType

Fields

LIVE, VOD

Definiert den Streamtyp, der vom Player wiedergegeben werden soll. Prerolls und VODs sollten vom Anfang des Streams an wiedergegeben werden.

Attribute

Name	Typ	Beschreibung
LIVE		Das Video ist online.
VOD		Das Video ist on demand verfügbar.

Nach oben

Klasse ima.WrapperInfo

Fields

adId, adSystem, creativeAdId, creativeId, dealId

Methoden

createWrapperInfo

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, wenn er unbekannt ist.
creativeAdId		Die Anzeigen-ID im Creative oder ein leerer String, falls nicht bekannt.
creativeId		Die ID des Creatives oder ein leerer String, wenn sie nicht bekannt ist.
dealId		Die Deal-ID oder ein leerer String, falls unbekannt.

createWrapperInfo()

Rückgaben ima.WrapperInfo:

Nach oben