このページは Cloud Translation API によって翻訳されました。

Roku 向け IMA DAI SDK

クラス ima

メソッド

disableLogging、getStreamManager、initSdk、requestStream

IMA SDK を制御するグローバル関数。

`disableLogging()`

SDK のロギングを無効にします。ロギングはデフォルトでオンになります。

`getStreamManager()`

ストリームマネージャーが利用可能な場合は、ストリームマネージャーを返します。ストリームマネージャーがまだ利用できない場合は、Invalid が返されます。ストリームマネージャーの作成中にエラーが発生した場合は、エラーオブジェクトが返されます。

object を返します。ストリームマネージャーまたはエラーオブジェクト。

`initSdk(settings)`

SDK を初期化します。

パラメータ	型	説明
`settings`	`object`	オプションの IMA 設定オブジェクト。

`requestStream(streamRequest)`

非同期ストリーミングリクエストを開始します。このメソッドを呼び出すと、コントロールはすぐにプレーヤーに戻ります。

object を返します。エラー、またはエラーがなければ無効です

パラメータ	型	説明
`streamRequest`	`object`

名前	型	説明
`adPosition`		広告ブレーク内の広告のインデックス。スタンドアロン広告の場合、インデックスは `1` です。
`duration`		ミッドロール挿入点の最大時間（秒）。不明な場合は `-1` です。
`podIndex`		ライブ配信の場合は、ブレーク ID を Pod インデックスとして返します。プレロールの場合は `0` を返します。ライブ配信にはポストロールはありません。デフォルトは `-2` です。ビデオオンデマンド（VOD）の場合、連続配信広告のインデックスを返します。プレロールポッドの場合は `0` を返します。ミッドロールの場合は、`1`、`2`、...、n を返します。ポストロールポッドの場合は、n+1...n+x を返します。この広告が連続配信広告の一部でない場合、またはこの連続配信広告が再生リストの一部でない場合、デフォルトは `0` です。
`timeOffset`		コンテンツ内の連続配信広告の位置（秒単位）。プレロールは `0` を返します。ポストロールは `-1` を返します。ミッドロールは、Pod のスケジュールされた時間を返します。
`totalAds`		このミッドロール挿入点に含まれる広告の総数。スタンドアロン広告の場合、値は `1` です。

名前	型	説明
`AD_PERIOD_ENDED`		ストリームが広告またはスレートからコンテンツに切り替わるたびに発生します。これは、広告が 2 回目に再生された場合や、広告にシークした場合でも呼び出されます。
`AD_PERIOD_STARTED`		ストリームがコンテンツから広告またはスレートに変換されるたびにトリガーされます。これは、広告が 2 回目に再生された場合や、広告にシークした場合でも呼び出されます。
`COMPLETE`		広告の再生が終了すると呼び出されます。
`ERROR`		エラーが発生すると呼び出されます。
`FIRST_QUARTILE`		広告の再生ヘッドが最初の四分位を超えると呼び出されます。
`ICON_FALLBACK_IMAGE_CLOSED`		ユーザーがアイコンの代替画像ダイアログを閉じると発行されます。
`ICON_FALLBACK_IMAGE_SHOWN`		アイコンの代替画像が表示されたときに発生します。
`MIDPOINT`		広告の再生ヘッドが中間点を通過すると呼び出されます。
`PROGRESS`		広告の進行状況が更新されると呼び出されます。
`SKIPPABLE_STATE_CHANGED`		広告のスキップ可能状態が変更されたときに呼び出されます。
`SKIPPED`		広告がスキップされると呼び出されます。
`START`		広告の再生が開始されると呼び出されます。
`THIRD_QUARTILE`		広告の再生ヘッドが第 3 四分位を超えると呼び出されます。

名前	型	説明
`adBreakInfo`		この広告が含まれるブレーク全体に関する情報。
`adDescription`		広告の説明。
`adId`		広告の ID。不明な場合は空の文字列。
`adSystem`		クリエイティブを提供する広告システム。
`adTitle`		広告のタイトル。
`advertiserName`		配信元が定義した広告主名。
`companions`		VAST レスポンスで指定されたコンパニオン広告。
`creativeAdId`		広告の ISCI（業界標準の商業識別子）コード。VAST レスポンスで選択されたクリエイティブの Ad-ID です。
`creativeId`		広告に選択したクリエイティブの ID。
`currentTime`		広告内の現在の時刻（秒単位）。不明な場合は -1 です。
`dealId`		現在の広告のラッパーチェーンに存在する最初の取引 ID（上から順に）を返します。
`duration`		この単一の広告の再生時間（秒単位）。不明な場合は -1 です。
`skipOffset`		広告がスキップ可能になるまでの時間（不明な場合は -1）。
`universalAdIDRegistry`		選択したクリエイティブのユニバーサル広告 ID がカタログ化されているレジストリウェブサイトの URL を識別するために使用される文字列。
`universalAdIDValue`		広告に選択したクリエイティブのユニバーサル広告 ID。
`wrappers`		この広告のラッパー情報を含む ima.WrapperInfo の配列。順序は外側のラッパーから内側になります。

名前	型	説明
`apiFramework`		この広告の実行に必要な API。利用できない場合は「無効」です。
`creativeType`		クリエイティブタイプ（通常は MIME タイプ）を表します。
`height`		コンパニオンの高さ（ピクセル単位）。利用できない場合は 0 です。
`trackingEvents`		トラッキングイベントのマップ。キーはイベントで、値はそのイベントで ping する URL のリストです。
`url`		このコンパニオンの静的リソースの URL。
`width`		コンパニオンの幅（ピクセル単位）。利用できない場合は 0 です。

名前	型	説明
`end`		キューポイントの終了時間（秒単位）。これはミッドロール挿入点に対応しています。
`hasPlayed`		キューポイントがすでに再生されていることを示すブール値。
`start`		キューポイントの開始時間（秒単位）。これはミッドロール挿入点に対応しています。

名前	型	説明
`id`		エラーの ID。エラーコードの一覧については、ErrorEvent 定数をご覧ください。
`info`		エラーに関する追加情報。
`type`		このオブジェクトのタイプを示すため、常に error に設定します。

名前	型	説明
`BAD_STREAM_REQUEST`		ストリームリクエストが正しく入力されていません。
`COULD_NOT_LOAD_STREAM`		ライブ配信を読み込めませんでした。
`ERROR`		不明なエラーです。
`INVALID_RESPONSE`		サーバーレスポンスが有効ではありませんでした。
`STREAM_API_KEY_NOT_VALID`		指定された API キーがサーバーで受け入れられませんでした。

名前	型	説明
`format`		動画の形式: hls または dash。ima.StreamFormat で定義されています。
`manifest`		ストリームの URL。
`streamId`		ストリームの一意の ID。
`streamType`		動画の種類: ライブまたはオンデマンド。ima.StreamType で定義されています。
`subtitles`		字幕（利用可能な場合）。そうでない場合は無効です。

パラメータ	型	説明
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

パラメータ	型	説明
`streamManifest`	`string`	広告が挿入されたストリームマニフェストの URL。
`streamSubtitle`	`ifArray>\|Invalid`	ストリームに関連付けられた字幕。関連付けられていない場合は `Invalid`。

名前	型	説明
`adTagParameters`		省略可。ストリームリクエストで、限定された広告タグパラメータをオーバーライドできます。詳しくは、ストリームにターゲティングパラメータを指定するをご覧ください。ストリームバリアントの優先度には、dai-ot パラメータと dai-ov パラメータを使用することもできます。詳細については、ストリームのバリエーションパラメータをオーバーライドするをご覧ください。
`adUiNode`		広告 UI が表示されるシーングラフノード。IMA は、広告中に [広告の表示について] ボタンや [スキップ] ボタンなどの要素をこの要素に配置します。要素は動画要素全体をオーバーレイする必要があります。
`apiKey`		省略可。これらのキーは、ストリームリクエストの認証に使用できます。DAI 認証キーは、DFP UI で設定する必要があります。
`assetKey`		ライブ配信には必須です。これは、再生するストリームを決定するために使用されます。ライブストリームリクエストのアセットキーは、DFP の管理画面で確認できる ID です。
`authToken`		ストリームリクエストの認可トークン。より厳格なコンテンツ認可のために、API キーの代わりに使用されます。パブリッシャーは、このトークンに基づいて個々のコンテンツストリームの承認を制御できます。
`contentSourceId`		オンデマンドストリームに必須です。cmsid は、DFP UI の DFP 動画コンテンツソースから取得します。
`customAssetKey`		カスタムアセットキーは、再生するストリームを決定するために使用されます。Pod サービングストリームリクエストにはカスタムアセットキーが必要です。
`format`		ストリームの形式。デフォルトは `ima.StreamFormat.HLS` です。
`networkCode`		ストリーミングリクエストを行うパブリッシャーのネットワークコード。ネットワークコードは、createPodLiveStreamRequest または createPodVodStreamRequest で行われた連続広告配信ストリームリクエストに必要です。これらのコードは、createVideoStitcherLiveStreamRequest、createVideoStitcherVodStreamRequest、または createVideoStitcherVodStreamRequestWithVodConfig で行われた Cloud ステッチングストリームリクエストにも必要です。これらのコードは省略可能ですが、createLiveStreamRequest または createVodStreamRequest で行うフルサービスストリームリクエストには推奨されます。ネットワークコードを追加すると、アドマネージャーの UI で選択した設定（プログラマティック限定広告の有効化など）が適用されます。Pod サービングと Cloud ステッチングの場合、ネットワークコードを追加すると、ストリームが検出されて再生されます。ネットワークコードを確認する方法については、こちらの記事をご覧ください。
`player`		プレーヤーインターフェースの実装。
`ppid`		非推奨です。adTagParameters を使用します。省略可。DFP オーディエンスのパブリッシャー指定の識別子。
`streamActivityMonitorId`		ストリームアクティビティモニターでストリームのデバッグに使用する ID。これは、パブリッシャーがストリームアクティビティモニターツールでストリームログを簡単に見つけられるようにするために使用されます。
`videoId`		オンデマンドストリームに必須です。動画コンテンツソースの ID。
`videoObject`		クライアントアプリでの動画再生を担当する動画オブジェクト（Video roSGNode など）。このオブジェクトは、ライブ HLS ID3 イベントのタイミングを適切に設定するために使用されるさまざまなデータについてポーリングされます。
`videoStitcherSessionOptions`		セッションオプションは、VideoStitcher の streamRequests に動画ステッチャー固有のパラメータを設定するために使用されます。

パラメータ	型	説明
`assetKey`	`string`
`apiKey`	`string`	返された `ima.StreamRequest` の `ima.StreamRequest.apiKey` プロパティに割り当てられるパラメータ。API キーが存在しない場合は、空の文字列を渡します。
`networkCode`	`string`	ストリーミングリクエストを行うパブリッシャーのネットワークコード。ネットワークコードを含めるかどうかは任意ですが、含めることをおすすめします。

パラメータ	型	説明
`customAssetKey`	`string`
`networkCode`	`string`
`apiKey`	`string`	返された `ima.StreamRequest` の `ima.StreamRequest.apiKey` プロパティに割り当てられるオプションパラメータ。デフォルトは空の文字列です。

パラメータ	型	説明
`contentSourceId`	`string`
`videoId`	`string`
`apiKey`	`string`	返された `ima.StreamRequest` の `ima.StreamRequest.apiKey` プロパティに割り当てられるパラメータ。API キーが存在しない場合は、空の文字列を渡します。
`networkCode`	`string`	ストリーミングリクエストを行うパブリッシャーのネットワークコード。ネットワークコードを含めるかどうかは任意ですが、含めることをおすすめします。

パラメータ	型	説明
`adTagUrl`	`string`
`networkCode`	`string`
`contentSourceUrl`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

パラメータ	型	説明
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

名前	型	説明
`LIVE`		動画が公開されています。
`VOD`		動画はオンデマンドです。

Roku 向け IMA DAI SDK

クラス ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

クラス ima.AdBreakInfo

プロパティ

createAdBreakInfo()

クラス ima.AdEvent

プロパティ

クラス ima.AdInfo

プロパティ

createAdInfo()

クラス ima.Companion

プロパティ

createCompanion()

クラス ima.CuePoint

プロパティ

createCuePoint()

クラス ima.Error

プロパティ

createError()

クラス ima.ErrorEvent

プロパティ

クラス ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

クラス ima.StreamFormat

プロパティ

クラス ima.StreamInfo

プロパティ

createStreamInfo()

クラス ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

クラス ima.StreamRequest

プロパティ

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

クラス ima.StreamType

プロパティ

クラス ima.WrapperInfo

プロパティ

createWrapperInfo()

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

`createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`