Dokumentacja interfejsu PAL SDK na Roku API

Ostrzeżenie: pakiet SDK PAL na Roku został wycofany, a nowe aplikacje na Roku, które implementują ten pakiet, nie mają już certyfikatu Roku na potrzeby publikacji. Starsze wersje pakietu PAL SDK na Roku przestaną być obsługiwane 7 maja 2025 r. Aby uzyskać więcej informacji o wysyłaniu sygnałów GAM z Roku, skontaktuj się ze swoim opiekunem klienta.

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

Obraz klasy

Globalne funkcje sterujące Roku IMA dla platformy PAL.

Powrót do góry

Klasa ima.NonceLoader

Metody

createNonceLoader, loadNonceManager

Biblioteka zautomatyzowanego dostępu umożliwia wydawcom gromadzenie sygnałów, które można wykorzystać do odblokowania źródeł ofert reklamowych AdX. W przypadku każdego żądania reklamy wywołaj w razie potrzeby odpowiednie ustawienia, a potem wywołaj metodęloadNonceManager. Wydawcy mogą wywołać funkcję NonceManager.getNonce(), by uzyskać ciąg znaków, który powinien zostać dodany do żądań reklamy jako wartość parametru

createNonceLoader()

Zwraca ima.NonceLoader:

loadNonceManager(request)

Zwraca ima.NonceManager: menedżer liczby jednorazowej służący do generowania liczby jednorazowej dla żądania reklamy.

Parametr	Typ	Opis
request	ima.NonceRequest	Żądanie zawierające informacje o żądanej liczbie jednorazowej.

Powrót do góry

Klasa ima.NonceManager

Metody

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

Zarządza liczbą jednorazową i raportowaniem jej zdarzeń w ramach pojedynczej sesji odtwarzania treści. Aby można było włączyć zautomatyzowane zarabianie, należy wywoływać metody cyklu życia sesji odtwarzania treści, w tym ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart i sendPlaybackEnd, ponieważ te zdarzenia występują w trakcie ich trwania.

getNonce()

Zwraca String: liczba jednorazowa wygenerowana dla tego menedżera po jego wczytaniu. Ta wartość nigdy się nie zmieni w przypadku danej instancji NonceManager. Ta wartość jednorazowa jest ważna tylko przez 1 sesję odtwarzania treści, która trwa maksymalnie 6 godzin.

poll()

Aktualizuje stan menedżera, umożliwiając śledzenie postępu odtwarzania.

sendAdClick()

Informuje serwery reklam Google, że podczas danej sesji odtwarzania treści wystąpiło kliknięcie reklamy.

sendAdImpression()

Rola wycofana. Użyj właściwości ima.NonceManager.sendPlaybackStart i 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