クラス ima
メソッド
IMA SDK を制御するグローバル関数。
disableLogging()
SDK ロギングを無効にします。Logging はデフォルトで有効になります。
getStreamManager()
可能であれば、ストリーム マネージャーを返します。ストリーム マネージャーがまだ提供されていない場合は、Invalid が返されます。
ストリーム マネージャーの作成中にエラーが発生した場合は、エラー オブジェクトが返されます。
戻り値 object: ストリーム マネージャーまたはエラー オブジェクト。
initSdk(settings)
SDK を初期化します。
| パラメータ | タイプ | 説明 |
|---|---|---|
settings |
object |
省略可能な IMA 設定オブジェクト。 |
requestStream(streamRequest)
非同期ストリーム リクエストを開始します。
このメソッドを呼び出すと、Control はプレーヤーにすぐに返されます。
object を返します。エラーまたはエラーがない場合は無効です。
| パラメータ | タイプ | 説明 |
|---|---|---|
streamRequest |
object |
クラス ima.AdBreakInfo
フィールド
メソッド
ミッドロール挿入点に関する情報が含まれます。SDK によってイベント コールバックに渡されます。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
adPosition |
|
ミッドロール挿入点内の広告のインデックス。スタンドアロンの広告の場合は 1 になります。 |
duration |
|
広告ブレークの最大時間（秒単位）。不明な場合は -1。 |
podIndex |
|
ライブ配信の場合は常に -1 を返します。ビデオ オンデマンド（VOD）の場合は、連続配信広告のインデックスを返します。プレロール連続配信広告の場合は 0 を返します。ミッドロールの場合は 1、2、...、n を返します。ポストロール連続配信広告の場合は n+1...n+x を返します。この広告が連続配信広告に含まれない場合、またはこの連続配信広告が再生リストに含まれない場合、デフォルトは 0 です。 |
timeOffset |
|
コンテンツ内の連続配信広告の位置（秒単位）。プレロールは 0、ポストロールは -1、ミッドロールは連続配信広告のスケジュール設定された時間を返します。 |
totalAds |
|
このミッドロール挿入点に含まれる広告の合計数。 スタンドアロンの広告の場合は 1 になります。 |
createAdBreakInfo()
ima.AdBreakInfo を返します。
クラス ima.AdEvent
フィールド
広告マネージャーによって呼び出されたイベント。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
AD_PERIOD_ENDED |
|
ストリームが広告またはスレートからコンテンツに切り替わるたびに呼び出されます。これは、広告が 2 回目に再生されたときや、広告内をシークしたときに発生します。 |
AD_PERIOD_STARTED |
|
ストリームがコンテンツから広告またはスレートに切り替わるたびに呼び出されます。これは、広告が 2 回目に再生されたときや、広告内をシークしたときに発生します。 |
COMPLETE |
|
広告の再生が完了すると呼び出されます。 |
ERROR |
|
エラーが発生したときに呼び出されます。 |
FIRST_QUARTILE |
|
広告のプレイヘッドが 25% 再生されると呼び出されます。 |
MIDPOINT |
|
広告のプレイヘッドが中間点を通過したときに呼び出されます。 |
PROGRESS |
|
広告の進捗状況が更新されたときに呼び出されます。 |
SKIPPABLE_STATE_CHANGED |
|
広告のスキップ可能の状態が変化すると呼び出されます。 |
SKIPPED |
|
広告がスキップされたときに呼び出されます。 |
START |
|
広告の再生開始時に呼び出されます。 |
THIRD_QUARTILE |
|
広告のプレイヘッドが 75% を超えると呼び出されます。 |
クラス ima.AdInfo
フィールド
メソッド
広告に関する情報が含まれています。SDK によってイベント コールバックに渡されます。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
adBreakInfo |
|
この広告が含まれる広告ブレーク全体に関連する情報。 |
adDescription |
|
広告の説明。 |
adId |
|
広告の ID。不明な場合は空の文字列。 |
adSystem |
|
クリエイティブを提供する広告システム。 |
adTitle |
|
広告のタイトル。 |
advertiserName |
|
配信元で定義された広告主名。 |
companions |
|
VAST レスポンスで指定されたレスポンシブ広告。 |
currentTime |
|
広告内の現在の時刻（秒単位）。不明な場合は -1 です。 |
duration |
|
この 1 つの広告の再生時間（秒単位）。不明な場合は -1 です。 |
universalAdIDRegistry |
|
選択したクリエイティブのユニバーサル広告 ID が登録されているレジストリ ウェブサイトの URL を識別するために使用される文字列。 |
universalAdIDValue |
|
広告で選択されたクリエイティブのユニバーサル広告 ID。 |
wrappers |
|
この広告のラッパー情報を含む ima.WrapperInfo の配列。外側のラッパーから内側のラッパーの順になります。 |
createAdInfo()
ima.AdInfo を返します。
クラス ima.Companion
フィールド
メソッド
広告のコンパニオンに関する情報が含まれています。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
apiFramework |
|
この広告の実行に必要な API です。利用できない場合は無効です。 |
creativeType |
|
クリエイティブ タイプ（通常は MIME タイプ）を表します。 |
height |
|
コンパニオンの高さ（ピクセル単位）。使用できない場合は 0。 |
trackingEvents |
|
トラッキング イベントのマップ。キーはイベント、値はそのイベントで ping する URL のリストです。 |
url |
|
このコンパニオンの静的リソースの URL です。 |
width |
|
コンパニオンの幅（ピクセル単位）。使用できない場合は 0。 |
createCompanion()
ima.Companion を返します。
クラス ima.CuePoint
フィールド
メソッド
キューポイントに関する情報が含まれます。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
end |
|
キューポイントの終了時間（秒単位）。これはミッドロール挿入点に相当します。 |
hasPlayed |
|
キューポイントがすでに再生されたことを示すブール値。 |
start |
|
キューポイントの開始時間（秒単位）。これはミッドロール挿入点に相当します。 |
createCuePoint()
ima.CuePoint を返します。
クラス ima.Error
フィールド
メソッド
エラーが発生した場合にエラーハンドラに渡されるオブジェクト。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
id |
|
エラーの ID。エラーコードのリストについては、ErrorEvent 定数をご覧ください。 |
info |
|
エラーに関する追加情報。 |
type |
|
このオブジェクトのタイプを示すには、常に error に設定します。 |
createError()
ima.Error を返します。
クラス ima.ErrorEvent
フィールド
SDK から返される可能性のあるすべてのエラー。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
BAD_STREAM_REQUEST |
|
ストリーム リクエストが正しく入力されませんでした。 |
COULD_NOT_LOAD_STREAM |
|
ストリームを読み込めませんでした。 |
ERROR |
|
不明なエラーが発生しました。 |
INVALID_RESPONSE |
|
サーバーの応答が無効です。 |
STREAM_API_KEY_NOT_VALID |
|
指定された API キーはサーバーで承認されませんでした。 |
クラス ima.Player
メソッド
adBreakEnded(adBreakInfo)
省略可。ミッドロール挿入点が終了すると呼び出されます。
| パラメータ | タイプ | 説明 |
|---|---|---|
adBreakInfo |
ima.AdBreakInfo |
ミッドロール挿入点に関する情報が含まれています。 |
adBreakStarted(adBreakInfo)
省略可。広告ブレークの開始時に呼び出されます。
| パラメータ | タイプ | 説明 |
|---|---|---|
adBreakInfo |
ima.AdBreakInfo |
ミッドロール挿入点に関する情報が含まれています。 |
allVideoComplete()
省略可。すべての動画の再生完了時に呼び出されます。
createPlayer()
空の IMA Player オブジェクトを作成します。広告を再生するには、loadUrl 関数を実装する必要があります。その他の関数は省略可能です。
ima.Player を返します。
loadUrl(streamInfo)
プレーヤーが URL の再生を開始する必要があるときに呼び出されます。ストリームを読み込むには、このメソッドを実装する必要があります。
| パラメータ | タイプ | 説明 |
|---|---|---|
streamInfo |
ima.StreamInfo |
コンテンツの再生に必要な情報が含まれています。 |
クラス ima.StreamFormat
フィールド
ストリームの形式を定義します。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
DASH |
|
|
HLS |
|
クラス ima.StreamInfo
フィールド
メソッド
SDK からプレーヤーに渡されるストリームに関する情報。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
format |
|
動画の形式（hls またはダッシュ）。 ima.StreamFormat で定義されます。 |
manifest |
|
ストリームの URL。 |
streamId |
|
ストリームの一意の ID。 |
streamType |
|
動画の種類（ライブまたはオンデマンド）。 ima.StreamType で定義されます。 |
subtitles |
|
字幕（利用可能な場合）。そうでない場合は無効です。 |
createStreamInfo()
ima.StreamInfo を返します。
クラス ima.StreamManager
メソッド
ストリーム再生を管理するためのオブジェクト。
addEventListener(event, callback)
指定されたイベントのリスナーを追加します。サポートされているイベントについては、AdEvents 定数をご覧ください。
| パラメータ | タイプ | 説明 |
|---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
ima.StreamManager を返します。
| パラメータ | タイプ | 説明 |
|---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
サポート対象外。代わりに、データをコンパニオン広告から RAF に直接渡します。
これは現在は処理されていません。
getContentTime(streamTime)
VOD ストリームの時間をミリ秒単位で取得します。これは、広告のないコンテンツ内の時間を表します。参照: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
現在のストリーム時間のコンテンツ時刻を取得するには、-1 を渡します。
戻り値 Integer: 指定されたストリーム時間に対応するコンテンツ時間。
| パラメータ | タイプ | 説明 |
|---|---|---|
streamTime |
Integer |
ストリーム内の時間。 |
getCuePoints()
すべてのミッドロール挿入点に対応するすべてのキューポイントを返します。これは、すべてのミッドロール挿入点が事前にわかっているビデオ オンデマンド コンテンツにのみ有効です。時間はすべて秒単位のストリーミング時間を表します。
戻り値 Object: すべてのキューポイントを含む配列。
getPreviousCuePoint(time)
この時間前のキューポイントを返します。キューポイントはミッドロール挿入点を示します。時間はすべて秒単位のストリーミング時間を表します。
戻り値 ima.CuePoint: start、end、hasPlayed を持つオブジェクト。キューポイントがない場合は無効です。
| パラメータ | タイプ | 説明 |
|---|---|---|
time |
Float |
検索する時刻。-1 は現在時刻を示します。 |
getStreamTime(contentTime)
VOD のコンテンツ時間から配信の時間をミリ秒単位で取得します。参照: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
戻り値 Integer: 指定されたコンテンツの時間に対応するストリーム時間。
| パラメータ | タイプ | 説明 |
|---|---|---|
contentTime |
Integer |
コンテンツの時刻。 |
loadThirdPartyStream(streamManifest, streamSubtitle)
広告メタデータを読み込み、指定された streamManifestUrl データと streamSubtitle データで loadUrl 関数を呼び出します。この関数は、ストリーム リクエスト タイプが ima.StreamType.POD_VOD の場合にのみ機能します。
| パラメータ | タイプ | 説明 |
|---|---|---|
streamManifest |
string |
広告が合成されたストリーム マニフェスト URL。 |
streamSubtitle |
ifArray |
ストリームに関連付けられている字幕。ない場合は |
onMessage(msg)
Video オブジェクトからのすべてのメッセージを処理します。
roMessagePort で受信するメッセージごとに呼び出す必要があります。
| パラメータ | タイプ | 説明 |
|---|---|---|
msg |
object |
roVideo ポートからのメッセージ。 |
replaceAdTagParameters(adTagParameters)
ライブ ストリームで配信予定の広告リクエストに使用されるすべての広告タグパラメータを置き換えます。なお、この呼び出しは VOD ストリームには影響しません。
| パラメータ | タイプ | 説明 |
|---|---|---|
adTagParameters |
string |
新しい広告タグのパラメータ。 |
start()
ストリームの再生を開始します。
クラス ima.StreamRequest
フィールド
メソッド
ストリーム リクエストのプロパティを指定するために使用します。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
adTagParameters |
|
省略可。ストリーム リクエストで一部の広告タグパラメータをオーバーライドできます。詳しくは、ストリームにターゲティング パラメータを指定するをご覧ください。ストリーム バリアントの設定で dai-ot パラメータと dai-ov パラメータを使用することもできます。詳しくは、ストリーム バリアント パラメータをオーバーライドするをご覧ください。 |
adUiNode |
|
広告 UI が表示されるシーングラフのノード。IMA は、広告中にこの要素に [広告の表示について] ボタンや [スキップ] ボタンなどの要素を配置します。この要素は動画要素全体を覆う必要があります。 |
apiKey |
|
省略可。これらのキーは、ストリーム リクエストの認証に使用できます。DAI 認証キーを DFP の管理画面で設定する必要があります。 |
assetKey |
|
ライブ配信の場合は必須。再生するストリームを決定するために使用されます。ライブ ストリーム リクエストのアセットキーは識別子です。この識別子は DFP の管理画面で確認できます。 |
authToken |
|
ストリーム リクエストの認証トークン。API キーの代わりに使用して、より厳密なコンテンツ認証を行います。ニュース メディアは、このトークンに基づいて個々のコンテンツ ストリームの承認を制御できます。 |
contentSourceId |
|
オンデマンド ストリームの場合は必須です。cmsid は、 DFP 管理画面の DFP 動画コンテンツ ソースから取得されます。 |
customAssetKey |
|
カスタム アセットキーは、再生するストリームを決定するために使用されます。 ストリーム リクエストを処理する Pod にはカスタム アセットキーが必要です。 |
format |
|
ストリームの形式。デフォルトは |
networkCode |
|
ストリーム リクエストを行うパブリッシャーのネットワーク コード。ストリーム リクエストを処理する Pod にはネットワーク コードが必要です。 |
player |
|
プレーヤー インターフェースの実装。 |
ppid |
|
非推奨です。adTagParameters を使用します。省略可。DFP オーディエンスのパブリッシャー指定の識別子。 |
streamActivityMonitorId |
|
ストリーム アクティビティ モニターでストリームをデバッグする際に使用される ID。 これは、パブリッシャーがストリーム アクティビティ モニタリング ツールでストリーム ログを見つける便利な方法を提供するために使用されます。 |
videoId |
|
オンデマンド ストリームの場合は必須です。動画コンテンツ ソースの識別子。 |
videoObject |
|
クライアント アプリでの動画再生を担当する動画オブジェクト（Video roSGNode など）。このオブジェクトは、ライブ HLS ID3 イベントの適切なタイミングに使用されるさまざまなデータについてポーリングされます。 |
createLiveStreamRequest(assetKey, apiKey)
ライブ StreamRequest の必須プロパティを初期化します。この API を使用すると、他の StreamType 固有のプロパティは無視されます。必須パラメータが空の文字列の場合、エラーロギングが発生して、API は汎用の StreamRequest を返します。プロパティは無視されません。
戻り値 ima.StreamRequest: 必要なライブ プロパティを含む ima.StreamRequest オブジェクト。
| パラメータ | タイプ | 説明 |
|---|---|---|
assetKey |
string |
|
apiKey |
string |
返される |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
Pod Live ima.StreamRequest の必須プロパティを初期化します。この API を使用すると、他の ima.StreamType 固有のプロパティは無視されます。必須パラメータが空の文字列の場合、エラーロギングが発生して、API は汎用の StreamRequest を返します。プロパティは無視されません。
戻り値 StreamRequest: 必要な PodLive プロパティを含む ima.StreamRequest オブジェクト。
| パラメータ | タイプ | 説明 |
|---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
返された |
createPodVodStreamRequest(networkCode)
サードパーティの動画スティッチャーで DAI Pod 配信を使用する場合、VOD ストリームを登録するために ima.StreamRequest の必須プロパティを初期化します。この関数はリクエスト タイプを ima.StreamType.POD_VOD に設定し、欠落しているデータの必須プロパティをすべて検証します。検証で不合格だった場合は、デバッグ コンソールにエラーが記録されます。
戻り値 StreamRequest: ima.StreamRequest オブジェクト。すべての必須プロパティを指定すると、リクエスト タイプは ima.StreamType.POD_VOD に設定されます。
| パラメータ | タイプ | 説明 |
|---|---|---|
networkCode |
string |
Google アドマネージャーネットワークの コードを入力します |
createStreamRequest()
戻り値 ima.StreamRequest: 空の ima.StreamRequest オブジェクト。
createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)
動画スティッチャー ライブ StreamRequest の必須プロパティを初期化します。この API を使用すると、他の StreamType 固有のプロパティは無視されます。必須パラメータが空の文字列の場合、エラーロギングが発生して、API は汎用の StreamRequest を返します。プロパティは無視されません。
戻り値 ima.StreamRequest: 必要な VideoStitcherLive プロパティを含む ima.StreamRequest オブジェクト。
| パラメータ | タイプ | 説明 |
|---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
liveConfigId |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)
動画スティッチャーの VOD StreamRequest の必須プロパティを初期化します。この API を使用すると、他の StreamType 固有のプロパティは無視されます。必須パラメータが空の文字列の場合、エラーロギングが発生して、API は汎用の StreamRequest を返します。プロパティは無視されません。
戻り値 ima.StreamRequest: 必要な VideoStitcherVod プロパティを含む ima.StreamRequest オブジェクト。
| パラメータ | タイプ | 説明 |
|---|---|---|
adTagUrl |
string |
|
networkCode |
string |
|
contentSourceUrl |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVodStreamRequest(contentSourceId, videoId, apiKey)
VOD ima.StreamRequest の必須プロパティを初期化します。この API を使用すると、他の ima.StreamType 固有のプロパティは無視されます。必須パラメータが空の文字列の場合、エラーロギングが発生して、API は汎用の StreamRequest を返します。プロパティは無視されません。
戻り値 ima.StreamRequest: 必要な VOD プロパティを含む ima.StreamRequest オブジェクト。
| パラメータ | タイプ | 説明 |
|---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
返された |
クラス ima.StreamType
フィールド
プレーヤーが再生するよう要求されるストリームのタイプを定義します。 プレロールと VOD は、ストリーミングの先頭から再生する必要があります。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
LIVE |
|
動画が公開されています。 |
VOD |
|
この動画はオンデマンド視聴です。 |
クラス ima.WrapperInfo
フィールド
メソッド
ラッパーに関する情報が含まれています。
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
adId |
|
広告の ID。不明な場合は空の文字列。 |
adSystem |
|
広告システムの宣言された名前。不明な場合は空の文字列。 |
creativeAdId |
|
クリエイティブの広告 ID。不明な場合は空の文字列。 |
creativeId |
|
クリエイティブの ID。不明な場合は空の文字列。 |
dealId |
|
取引 ID。不明な場合は空の文字列。 |
createWrapperInfo()
ima.WrapperInfo を返します。