مرجع واجهة برمجة التطبيقات لمجموعة أدوات PAL SDK Roku

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

Class ima

الدوال الشاملة التي تتحكم في Roku IMA for PAL

الرجوع إلى الأعلى

الفئة ima.NonceLoader

الطُرق

تتيح مكتبة الوصول الآلي للناشرين جمع الإشارات التي يمكن استخدامها لإتاحة طلبات AdX. بالنسبة إلى كل طلب إعلان، استدعِ أدوات الضبط ذات الصلة حسب الحاجة متبوعةً باستدعاء دالة loadNonceManager. ويمكن للناشرين بعد ذلك استدعاء NonceManager.getNonce() للحصول على السلسلة التي يجب إضافتها إلى طلبات الإعلان كقيمة إلى

createNonceLoader()


إرجاع ima.NonceLoader:

loadNonceManager(request)


يعرض ima.NonceManager: حسابًا غير إداري لإنشاء رقم خاص لطلب الإعلان.

المَعلمة النوع الوصف
request ima.NonceRequest

تمثّل هذه السمة الطلب الذي يحتوي على معلومات عن الميزة غير المطلوبة.

الرجوع إلى الأعلى

Class ima.NonceManager

الطُرق

يدير nonce وإعداد تقارير الأحداث لجلسة تشغيل محتوى واحدة. يجب استدعاء طرق مراحل نشاط جلسات تشغيل المحتوى، بما في ذلك ima.NonceManager.sendAdClick وima.NonceManager.sendAdTouch وima.NonceManager.sendPlaybackStart وsendPlaybackEnd عند وقوع هذه الأحداث ذات الصلة لتفعيل تحقيق الربح الآلي.

getNonce()


تعرض String: الرقم الخاص الذي تم إنشاؤه لهذا المدير عند تحميله. ولن تتغيّر هذه القيمة أبدًا لمثيل NonceManager معيّن. وهذه القيمة الخاصة غير صالحة فقط لجلسة تشغيل محتوى واحدة كحدّ أقصى لمدة 6 ساعات كحد أقصى.

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