PAL SDK Roku API संदर्भ

    1. इमा
    2. ima.NonceLoader
    3. ima.NonceManager
    4. ima.NonceRequest

क्लास ima

PAL के लिए Roku IMA को कंट्रोल करने वाले ग्लोबल फ़ंक्शन.

वापस सबसे ऊपर जाएं

क्लास ima.NonceLoader

तरीके

प्रोग्राम के हिसाब से अपने-आप बनने वाली ऐक्सेस लाइब्रेरी की मदद से, पब्लिशर ऐसे सिग्नल इकट्ठा कर सकते हैं जिनका इस्तेमाल AdX की मांग को पूरा करने के लिए किया जा सकता है. हर विज्ञापन अनुरोध के लिए, ज़रूरत के हिसाब से काम के सेटर को कॉल करें. इसके बाद, loadNonceManager को कॉल करें. इसके बाद पब्लिशर, NonceManager.getNonce() को कॉल करके वह स्ट्रिंग पा सकते हैं जिसे विज्ञापन अनुरोधों में, वैल्यू के तौर पर

createNonceLoader()


लौटाता है ima.NonceLoader:

loadNonceManager(request)


लौटाए जाने वाला ima.NonceManager: एक नॉन्स मैनेजर, जो किसी विज्ञापन अनुरोध के लिए नॉन्स जनरेट करता है.

पैरामीटर टाइप ब्यौरा
request ima.NonceRequest

वह अनुरोध जिसमें उस नॉन्स के बारे में जानकारी दी गई है जिसका अनुरोध किया जा रहा है.

वापस सबसे ऊपर जाएं

क्लास ima.NonceManager

तरीके

कॉन्टेंट के किसी एक सेशन के लिए, नॉन्स और उसकी इवेंट रिपोर्टिंग को मैनेज करता है. प्रोग्रैम्ड तरीके से कमाई करने की सुविधा चालू करने के लिए, कॉन्टेंट प्लेबैक सेशन के लाइफ़साइकल तरीकों को ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart, और sendPlaybackEnd से जुड़े इवेंट के तौर पर शामिल किया जाना चाहिए.

getNonce()


String दिखाता है: इस मैनेजर के लोड होने के समय, इसके लिए जनरेट किया गया नॉन्स. दिए गए NonceManager इंस्टेंस के लिए, यह वैल्यू कभी नहीं बदलेगी. यह नॉन्स वैल्यू, कॉन्टेंट के किसी एक प्लेबैक सेशन के लिए ही मान्य है. यह ज़्यादा से ज़्यादा छह घंटे की अवधि तक मान्य है.

poll()

मैनेजर की स्थिति को अपडेट करता है, ताकि यह प्लेबैक की प्रोग्रेस को ट्रैक कर सके.

sendAdClick()

Google के विज्ञापन सर्वर को सूचना देता है कि किसी कॉन्टेंट के प्लेबैक सेशन के दौरान किसी विज्ञापन पर क्लिक किया गया है.

sendAdImpression()

समर्थन नहीं होना या रुकना. ima.NonceManager.sendPlaybackStart और 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

Methods

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