プロダクトに関するご意見やフィードバックをお寄せいただくには、Google 広告および測定のコミュニティサーバーの公式アドマネージャー Discord チャンネルにご参加ください。

このページは 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 をポッドインデックスとして返します。プリロールの場合は `0` を返します。ライブ配信にはポストロールはありません。デフォルトは `-2` です。ビデオオンデマンド（VOD）の場合、広告ポッドのインデックスを返します。プリロールポッドの場合は、`0` を返します。ミッドロールの場合、`1`、`2`、...、n を返します。ポストロール Pod の場合、n+1...n+x を返します。この広告がポッドの一部でない場合、またはこのポッドがプレイリストの一部でない場合は、デフォルトで `0` になります。
`timeOffset`		コンテンツ内のポッドの位置（秒単位）。プレロールは `0` を返し、ポストロールは `-1` を返し、ミッドロールはポッドのスケジュールされた時間を返します。
`totalAds`		この広告ブレークに含まれる広告の総数。スタンドアロン広告の場合、値は `1` です。

名前	型	説明
`AD_PERIOD_ENDED`		ストリームが広告またはスレートからコンテンツに切り替わるたびに発生します。広告が 2 回目に再生された場合や、広告にシークした場合でも呼び出されます。
`AD_PERIOD_STARTED`		ストリームがコンテンツから広告またはスレートに切り替わるたびに発生します。広告が 2 回目に再生された場合や、広告にシークした場合でも呼び出されます。
`COMPLETE`		広告の再生が終了すると呼び出されます。
`ERROR`		エラーが発生すると呼び出されます。
`FIRST_QUARTILE`		広告の再生ヘッドが第 1 四分位を通過すると呼び出されます。
`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（Industry Standard Commercial Identifier）コード。VAST レスポンスで選択されたクリエイティブの Ad-ID です。
`creativeId`		広告用に選択されたクリエイティブの ID。
`currentTime`		広告内の現在の時間（秒単位）。不明な場合は -1。
`dealId`		現在の広告のラッパーチェーンに存在する最初の取引 ID を、上から順に返します。
`duration`		この単一広告の長さ（秒単位）。不明な場合は -1。
`skipOffset`		広告がスキップ可能になるまでの時間。不明な場合は -1。
`universalAdIDRegistry`		選択したクリエイティブのユニバーサル広告 ID がカタログに登録されているレジストリウェブサイトの URL を識別するために使用される文字列。
`universalAdIDValue`		広告用に選択されたクリエイティブのユニバーサル広告 ID。
`wrappers`		この広告のラッパー情報を含む ima.WrapperInfo の配列。順序は外側のラッパーから内側のラッパーになります。

名前	型	説明
`adSlotId`		コンパニオンの広告スロット ID。利用できない場合は空になります。
`apiFramework`		この広告の実行に必要な API。利用できない場合は無効。
`companionClickThrough`		コンパニオンのリンク先 URL。
`creativeType`		通常は MIME タイプである creativetype を表します。
`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 の管理画面で設定する必要があります。
`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 サービングとクラウドステッチングでは、ネットワークコードを追加すると、ストリームが特定されて再生されます。ネットワークコードを確認するには、こちらの記事をご覧ください。
`player`		プレーヤーインターフェースの実装。
`ppid`		非推奨です。adTagParameters を使用します。省略可。DFP オーディエンスのパブリッシャー指定の識別子。
`streamActivityMonitorId`		ストリームアクティビティモニターでストリームのデバッグに使用する ID。これは、パブリッシャーがストリームアクティビティモニターツールでストリームログを簡単に見つけられるようにするために使用されます。
`videoId`		オンデマンドストリームに必要です。動画コンテンツソースの識別子。
`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)

streamInitialized(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()

Roku 向け IMA DAI SDK

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`streamInitialized(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()`