ima 类
用于控制 Roku IMA for PAL 的全局函数。
ima.NonceLoader 类
方法
借助程序化访问库，发布商可以收集可用于解锁 AdX 需求的信号。对于每个广告请求，根据需要调用相关的 setter，然后调用 loadNonceManager。然后，发布商可以调用 NonceManager.getNonce()，以获取应该添加到广告请求中的字符串作为
createNonceLoader()
返回 ima.NonceLoader：
loadNonceManager(request)
返回 ima.NonceManager：用于为广告请求生成 Nonce 的 Nonce 管理器。
| 参数 | 类型 | 说明 |
|---|---|---|
request |
ima.NonceRequest |
包含所请求 Nonce 相关信息的请求。 |
ima.NonceManager 类
方法
管理单个内容播放会话的 Nonce 及其事件报告。必须在发生相应事件时调用内容播放会话生命周期方法（包括 ima.NonceManager.sendAdClick、ima.NonceManager.sendAdTouch、ima.NonceManager.sendPlaybackStart 和 sendPlaybackEnd），才能启用程序化创收。
getNonce()
返回 String：此管理器在加载时生成的 Nonce。对于给定的 NonceManager 实例，此值永远不会更改。此 Nonce 值仅对单个内容播放会话有效，时长上限为 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
touchroInputEvent|StringThe 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.
Class
ima.NonceRequest
Fields
adWillAutoPlay,
adWillPlayMuted,
continuousPlayback,
descriptionUrl,
directedForChildOrUnknownAge,
iconsSupported,
ppid,
sessionId,
storageAllowed,
supportedApiFrameworks,
videoHeight,
videoWidth
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: