PAL SDK Roku API-Referenz

Warnung:Das PAL SDK für Roku wurde eingestellt. Neue Roku-Apps, die das PAL SDK für Roku implementieren, werden nicht mehr von Roku für die Veröffentlichung zertifiziert. Bisherige Unterstützung für das PAL SDK für Roku wird am 7. Mai 2025 eingestellt. Weitere Informationen zum Senden von GAM-Signalen für Roku erhalten Sie von Ihrem Kundenbetreuer.

1. 1. ima
   2. ima.NonceLoader
   3. ima.NonceManager
   4. ima.NonceRequest

Klasse ima

Globale Funktionen, die Roku IMA für PAL steuern

Nach oben

Klasse ima.NonceLoader

Methoden

createNonceLoader, loadNonceManager

Über die Bibliothek für den programmatischen Zugriff können Publisher Signale erfassen, mit denen sich die AdX-Nachfrage steigern lässt. Rufen Sie für jede Anzeigenanfrage nach Bedarf die relevanten Setter auf, gefolgt von einem Aufruf von "loadNonceManager". Publisher können dann NonceManager.getNonce() aufrufen, um den String zu erhalten, der den Anzeigenanfragen als Wert für den

createNonceLoader()

Gibt ima.NonceLoader zurück:

loadNonceManager(request)

Gibt ima.NonceManager zurück: Ein Nonce-Manager zum Generieren einer Nonce für eine Anzeigenanfrage.

Parameter	Typ	Beschreibung
request	ima.NonceRequest	Die Anfrage mit Informationen zur angeforderten Nonce.

Nach oben

Klasse ima.NonceManager

Methoden

getNonce, poll, sendAdClick, sendAdImpression, sendAdTouch, sendPlaybackEnd, sendPlaybackStart

Verwaltet eine Nonce und ihre Ereignisberichte für eine einzelne Wiedergabesitzung der Inhalte. Die Lebenszyklusmethoden der Inhaltswiedergabe-Sitzung, einschließlich ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart und sendPlaybackEnd, müssen beim Eintreten der entsprechenden Ereignisse aufgerufen werden, um die programmatische Monetarisierung zu aktivieren.

getNonce()

Gibt String zurück:Die Nonce, die beim Laden für dieses Verwaltungskonto generiert wurde. Dieser Wert ändert sich für eine bestimmte NonceManager-Instanz nie. Dieser Nonce-Wert gilt nur für eine einzelne Wiedergabesitzung von Inhalten bis zu einer maximalen Dauer von 6 Stunden.

poll()

Aktualisiert den Manager-Status, sodass der Wiedergabefortschritt verfolgt werden kann

sendAdClick()

Informiert die Ad-Server von Google darüber, dass während der jeweiligen Wiedergabesitzung der Inhalte ein Klick auf eine Anzeige stattgefunden hat.

sendAdImpression()

Veraltet. Verwenden Sie ima.NonceManager.sendPlaybackStart und ima.NonceManager.sendPlaybackEnd/code>.


sendAdTouch(touch)

Notifies Google ad servers that a user touch or click on the ad other than a clickthrough (for example, skip, mute, tap, etc.) has occurred during the given content playback session.

Parameter	Type	Description
touch	roInputEvent|String	The key received from onKeyEvent (if using SceneGraph), or the roInputEvent otherwise.

sendPlaybackEnd()

Notifies Google ad servers that playback for the given content playback session has ended. This should be called when playback ends (for example, when the player reaches end of stream, or when the user exits playback mid-way, or when the user quits the channel, or when advancing to the next content item in a playlist setting). This method ends the asynchronous calls to Google servers started in sendPlaybackStart.

sendPlaybackStart()

Notifies Google ad servers that playback for the given content playback session has started. This should be called on "video player start". This may be in response to a user-initiated action (click-to-play) or a channel initiated action (autoplay). This method will start asynchronous calls to Google servers to collect signal needed for IVT monitoring and detection.

Back to top

Class ima.NonceRequest

Fields

adWillAutoPlay, adWillPlayMuted, continuousPlayback, descriptionUrl, directedForChildOrUnknownAge, iconsSupported, ppid, sessionId, storageAllowed, supportedApiFrameworks, videoHeight, videoWidth

Methods

createNonceRequest

Information a publisher can provide when requesting a PAL nonce.

Properties

Name	Type	Description
adWillAutoPlay		Set to true if the ad will be auto played without waiting for user interaction. Set to false if the ad will wait for user interaction before being played.
adWillPlayMuted		Set to true if the ad will be played while muted. Set to false if the ad will play unmuted.
continuousPlayback		Set to true if the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist. Set to false otherwise.
descriptionUrl		The description URL of the content during which the ad will be played. Any description URL string longer than 500 characters will be ignored and excluded from the nonce.
directedForChildOrUnknownAge		Whether the ad request is directed to a child or user of an unknown age (TFCD or TFUA). Default value is false.
iconsSupported		Whether VAST icons are supported by the video player. On Roku this value should always be false.
ppid		The publisher provided ID. Any PPID longer than 200 characters will be ignored. Note: The PPID will not be used in personalisation. If it is appropriate to use a ppid for personalization, include it separately in clear text in your ad request.
sessionId		Session ID is a temporary random ID. It is used exclusively for frequency capping. A session ID must be a UUID.
storageAllowed		Whether storage consent (purpose 1 consent) from the IAB TCF V2 spec has been granted by the user. Defaults to true.
supportedApiFrameworks		Accepts an array of strings representing API framweworks supported by the player as defined in AdCOM 1.0 "API Frameworks" list https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-. Example: ["2","7","9"] indicates this player supports VPAID 2.0, OMID 1.0, and SIMID 1.1.
videoHeight		The height of the ad video element.
videoWidth		The width of the ad video element.

createNonceRequest()

Returns ima.NonceRequest:

Back to top