Wenn Sie sich mit anderen Nutzern über unsere Produkte austauschen und Feedback geben möchten, treten Sie dem offiziellen Ad Manager-Discord-Kanal auf dem Server der Google Advertising and Measurement Community bei.

Diese Seite wurde von der Cloud Translation API übersetzt.

IMA DAI SDK für Roku

Class ima

Methoden

disableLogging, getStreamManager, initSdk, requestStream

Globale Funktionen, mit denen das IMA SDK gesteuert wird.

`disableLogging()`

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

`getStreamManager()`

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

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

`initSdk(settings)`

Initialisiert das SDK.

Parameter	Typ	Beschreibung
`settings`	`object`	Optionales IMA-Einstellungsobjekt.

`requestStream(streamRequest)`

Startet eine asynchrone Streamanfrage. Die Steuerung wird sofort nach dem Aufrufen dieser Methode an den Player zurückgegeben.

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

Parameter	Typ	Beschreibung
`streamRequest`	`object`

Name	Typ	Beschreibung
`adPosition`		Der Index der Anzeige in der Werbeunterbrechung. Der Index ist `1` für eigenständige Anzeigen.
`duration`		Die maximale Dauer der Pause in Sekunden oder `-1`, falls unbekannt.
`podIndex`		Gibt für Livestreams die Pausen-ID als Pod-Index oder `0` für einen Preroll zurück. In Livestreams gibt es keine Post-Roll-Anzeigen. Die Standardeinstellung ist `-2`. Gibt für Video-on-Demand (VOD) den Index des Anzeigen-Pods zurück. Gibt für einen Preroll-Pod `0` zurück. Für Mid-Rolls werden `1`, `2`, ..., n zurückgegeben. Für einen Postroll-Pod werden die Werte n+1 bis 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 Content in Sekunden. Pre-Rolls geben `0` zurück, Post-Rolls `-1` und Mid-Rolls die geplante Zeit des Pods.
`totalAds`		Die Gesamtzahl der Anzeigen in dieser Werbebuchung. Bei eigenständigen Anzeigen ist der Wert `1`.

Name	Typ	Beschreibung
`AD_PERIOD_ENDED`		Wird jedes Mal ausgelöst, wenn der Stream von Werbung oder einem Slate zu Inhalten wechselt. Dieses Ereignis wird auch ausgelöst, wenn eine Anzeige zum zweiten Mal wiedergegeben wird oder wenn ein Nutzer in eine Anzeige vorspult.
`AD_PERIOD_STARTED`		Wird jedes Mal ausgelöst, wenn der Stream von Inhalten zu Werbung oder einem Slate wechselt. Dieses Ereignis wird auch ausgelöst, wenn eine Anzeige zum zweiten Mal wiedergegeben wird oder wenn ein Nutzer in eine Anzeige vorspult.
`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 Playhead der Anzeige das erste Quartil überschreitet.
`ICON_FALLBACK_IMAGE_CLOSED`		Wird ausgelöst, wenn der Nutzer das Dialogfeld für das Fallback-Bild für das Symbol 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 den Mittelpunkt überschreitet.
`PROGRESS`		Wird ausgelöst, wenn sich der Fortschritt einer Anzeige ändert.
`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 Playhead der Anzeige das dritte Quartil überschreitet.

Name	Typ	Beschreibung
`adBreakInfo`		Informationen zur gesamten Unterbrechung, in der diese Anzeige ausgeliefert wird.
`adDescription`		Die Beschreibung der Anzeige.
`adId`		Die ID der Anzeige oder ein leerer String, wenn sie unbekannt ist.
`adSystem`		Das Anzeigensystem, das das Creative bereitstellt.
`adTitle`		Der Titel der Anzeige.
`advertiserName`		Der Name des Werbetreibenden, wie er von der Serving-Partei definiert wurde.
`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, falls unbekannt.
`dealId`		Gibt die erste Deal-ID zurück, die in der Wrapper-Kette für die aktuelle Anzeige vorhanden ist, beginnend mit der obersten.
`duration`		Die Dauer dieser einzelnen Anzeige in Sekunden oder -1, falls unbekannt.
`skipOffset`		Die Zeit, bis die Anzeige überspringbar wird, oder -1, wenn dies nicht bekannt ist.
`universalAdIDRegistry`		Ein String zur Identifizierung der URL für die Registrierungswebsite, auf der die Universal Ad 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 Wrapper-Informationen für diese Anzeige. Die Reihenfolge ist von der äußeren zur inneren Verpackung.

Name	Typ	Beschreibung
`adSlotId`		Die Anzeigenflächen-ID des Companion-Elements. Leer, wenn nicht verfügbar.
`apiFramework`		Die API, die zum Ausführen dieser Anzeige erforderlich ist, oder „Invalid“, wenn sie nicht verfügbar ist.
`companionClickThrough`		Klick-URL des Companion-Banners.
`creativeType`		Stellt den Creative-Typ dar, in der Regel einen MIME-Typ.
`height`		Die Höhe des Companion-Creatives in Pixeln. 0, wenn 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 Begleitelements.
`width`		Die Breite des Companion-Creatives in Pixeln. 0, wenn nicht verfügbar.

Name	Typ	Beschreibung
`end`		Die Endzeit für einen Cuepoint in Sekunden. Dies entspricht einer Werbeunterbrechung.
`hasPlayed`		Ein boolescher Wert, der angibt, ob der Cuepoint bereits abgespielt wurde.
`start`		Die Startzeit für einen Cuepoint in Sekunden. Dies entspricht einer Werbeunterbrechung.

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

Name	Typ	Beschreibung
`BAD_STREAM_REQUEST`		Die Streamanfrage wurde nicht richtig ausgefüllt.
`COULD_NOT_LOAD_STREAM`		Der 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.

Name	Typ	Beschreibung
`format`		Das Format des Videos: hls oder dash. Wird in ima.StreamFormat definiert.
`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, sofern verfügbar. Ungültig, wenn nicht.

Parameter	Typ	Beschreibung
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

Parameter	Typ	Beschreibung
`streamManifest`	`string`	Die Stream-Manifest-URL mit eingefügten Anzeigen.
`streamSubtitle`	`ifArray>\|Invalid`	Die Untertitel, die dem Stream zugeordnet sind, oder `Invalid`, wenn keine vorhanden sind.

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. Sie können auch die Parameter „dai-ot“ und „dai-ov“ für die bevorzugte Stream-Variante verwenden. Weitere Informationen zum Überschreiben der Parameter von Streamvarianten
`adUiNode`		Ein Knoten im Szenengraphen, in dem die Benutzeroberfläche für Anzeigen angezeigt wird. Das IMA SDK platziert während der Anzeigenwiedergabe Elemente wie die Schaltflächen Warum sehe ich diese Werbung? und Überspringen in diesem Element. Das Element muss das gesamte Videoelement überlagern.
`apiKey`		Optional. Mit diesen Schlüsseln können Streamanfragen authentifiziert werden. Authentifizierungsschlüssel für die dynamische Anzeigenbereitstellung müssen in der DFP-Benutzeroberfläche eingerichtet werden.
`assetKey`		Für Livestreams erforderlich. Damit wird festgelegt, welcher Stream abgespielt werden soll. Der Asset-Schlüssel der Livestream-Anfrage 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 Publisher kann die Autorisierungen für einzelne Contentstreams anhand dieses Tokens steuern.
`contentSourceId`		Für On-Demand-Streams erforderlich. Die cmsid stammt aus der DFP-Videocontentquelle auf der DFP-Benutzeroberfläche.
`customAssetKey`		Mit dem benutzerdefinierten Assetschlüssel wird festgelegt, welcher Stream abgespielt werden soll. Benutzerdefinierte Asset-Schlüssel sind für Streamanfragen für Pods 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 für die Pod-Auslieferung erforderlich, die mit createPodLiveStreamRequest oder createPodVodStreamRequest gestellt werden. Diese Codes sind auch für Cloud Stitching-Streamanfragen erforderlich, die mit createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest oder createVideoStitcherVodStreamRequestWithVodConfig gestellt werden. Diese Codes sind optional und werden für Full-Service-Streamanfragen empfohlen, die mit createLiveStreamRequest oder createVodStreamRequest gestellt werden. Wenn Sie den Netzwerkcode hinzufügen, werden die in der Ad Manager-Benutzeroberfläche ausgewählten Einstellungen angewendet, z. B. die Aktivierung von programmatischen Anzeigen mit eingeschränktem Targeting. Beim Pod-Serving und Cloud Stitching wird durch Hinzufügen des Netzwerkcodes der Stream gefunden und wiedergegeben. Weitere Informationen
`player`		Eine Implementierung der Player-Schnittstelle.
`ppid`		Verworfen. Verwenden Sie „adTagParameters“. Optional. Eine vom Publisher bereitgestellte Kennung für DFP Audience.
`streamActivityMonitorId`		Die ID, die zum Debuggen des Streams mit der Überprüfung der Streamingaktivitäten verwendet werden soll. So können Publisher ganz einfach ein Streamlog im Tool zur Überprüfung der Streamingaktivitäten finden.
`videoId`		Für On-Demand-Streams erforderlich. Kennung für die Quelle für Videocontent.
`videoObject`		Das Videoobjekt (z. B. der Video-roSGNode), das für die Videowiedergabe in der Client-App verantwortlich ist. Dieses Objekt wird nach verschiedenen Daten abgefragt, die für das richtige Timing von Live-HLS-ID3-Ereignissen verwendet werden.
`videoStitcherSessionOptions`		Mit den Sitzungsoptionen werden Video Stitcher-spezifische Parameter für VideoStitcher-Streamanfragen festgelegt.

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

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

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

IMA DAI SDK für Roku Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Class ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Klasse ima.AdBreakInfo

Attribute

createAdBreakInfo()

Klasse ima.AdEvent

Attribute

Klasse ima.AdInfo

Attribute

createAdInfo()

Klasse ima.Companion

Attribute

createCompanion()

Klasse ima.CuePoint

Attribute

createCuePoint()

Klasse ima.Error

Attribute

createError()

Klasse ima.ErrorEvent

Attribute

Klasse ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

streamInitialized(streamInfo)

Klasse ima.StreamFormat

Attribute

Klasse ima.StreamInfo

Attribute

createStreamInfo()

Klasse ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Klasse ima.StreamRequest

Attribute

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

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

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Class ima.StreamType

Attribute

Klasse ima.WrapperInfo

Attribute

createWrapperInfo()

IMA DAI SDK für Roku

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`streamInitialized(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

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

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

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

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`