PAL SDK Roku API Referansı

Uyarı: Roku için PAL SDK kullanımdan kaldırılmıştır ve Roku için PAL SDK'sını uygulayan yeni Roku uygulamaları artık yayın için Roku tarafından onaylanmamaktadır. Roku için PAL SDK desteği 7 Mayıs 2025'te sona erecek. Roku için GAM sinyalleri gönderme hakkında daha fazla bilgi edinmek için hesap temsilcinizle iletişime geçin.

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

Ima sınıfı

PAL için Roku IMA'yı kontrol eden genel işlevler.

Başa dön

ima.NonceLoader Sınıfı

Yöntemler

createNonceLoader, loadNonceManager

Programatik erişim kitaplığı, yayıncıların AdX talebinin kilidini açmak için kullanılabilecek sinyalleri toplamasına olanak tanır. Her reklam isteği için gereken şekilde ilgili setter'ları çağırın ve ardından loadNonceManager'ı çağırın. Böylece yayıncılar, reklam isteklerine

createNonceLoader()

ima.NonceLoader değerini döndürür:

loadNonceManager(request)

ima.NonceManager değerini döndürür: Bir reklam isteği için tek seferlik rastgele oluşturan bir nonce yöneticisi.

Parametre	Tür	Açıklama
request	ima.NonceRequest	İstenen tek seferlik rastgele sayıyla ilgili bilgileri içeren istek.

Başa dön

ima.NonceManager Sınıfı

Yöntemler

getNonce, anket, sendAdClick, sendAdImpression, sendAdTouch, sendPlaybackEnd, sendPlaybackStart

Tek bir içerik oynatma oturumu için tek seferlik bir rastgele sayısını ve etkinlik raporlamasını yönetir. Programatik para kazanmayı etkinleştirmek için ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart ve sendPlaybackEnd gibi içerik oynatma oturumu yaşam döngüsü yöntemleri, bu ilgili etkinlikler meydana geldiğinde çağrılmalıdır.

getNonce()

String değerini döndürür: Yönetici için yüklendiğinde tek seferlik rastgele sayı değeri. Bu değer belirli bir NonceManager örneği için hiçbir zaman değişmez. Bu tek seferlik değer değeri, maksimum 6 saate kadar tek bir içerik oynatma oturumu için geçerlidir.

poll()

Oynatma ilerleme durumunu izleyebilmesi için yönetici durumunu günceller.

sendAdClick()

Söz konusu içerik oynatma oturumu sırasında bir reklamın tıklanması gerektiğini Google reklam sunucularına bildirir.

sendAdImpression()

Kullanımdan kaldırıldı. ima.NonceManager.sendPlaybackStart ve ima.NonceManager.sendPlaybackEnd/code>.
özelliklerini kullanın

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