Roku 向け IMA DAI SDK

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

クラス ima

メソッド

disableLogging、 getStreamManager、 initSdk、 requestStream

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

disableLogging()

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

getStreamManager()

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

戻り値 object: ストリーム マネージャーまたはエラー オブジェクト。

initSdk(settings)

SDK を初期化します。

パラメータ	型	説明
settings	object	省略可能な IMA 設定オブジェクト。

requestStream(streamRequest)

非同期ストリーム リクエストを開始します。このメソッドを呼び出すと、すぐにプレーヤーに制御が戻ります。

object を返します。エラーがない場合はエラーまたは無効

パラメータ	型	説明
streamRequest	object

トップへ戻る

クラス ima.AdBreakInfo

フィールド

adPosition、duration、podIndex、timeOffset、totalAds

メソッド

createAdBreakInfo

広告ブレークに関する情報が含まれます。SDK によってイベント コールバックに渡されます。

プロパティ

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

createAdBreakInfo()

戻り値 ima.AdBreakInfo:

トップへ戻る

クラス ima.AdEvent

フィールド

AD_PERIOD_ENDED、AD_PERIOD_STARTED、COMPLETE、ERROR、FIRST_QUARTILE、ICON_FALLBACK_IMAGE_CLOSED、ICON_FALLBACK_IMAGE_SHOWN、MIDPOINT、PROGRESS、SKIPPABLE_STATE_CHANGED、SKIPPED、START、THIRD_QUARTILE

広告マネージャーによって発生したイベント。

プロパティ

名前	型	説明
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 四分位を通過すると呼び出されます。

トップへ戻る

クラス ima.AdInfo

フィールド

adBreakInfo、adDescription、adId、adSystem、adTitle、advertiserName、companions、creativeAdId、creativeId、currentTime、dealId、duration、skipOffset、universalAdIDRegistry、universalAdIDValue、wrappers

メソッド

createAdInfo

広告に関する情報が含まれます。SDK によってイベント コールバックに渡されます。

プロパティ

名前	型	説明
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 の配列。順序は外側のラッパーから内側のラッパーになります。

createAdInfo()

戻り値 ima.AdInfo:

トップへ戻る

クラス ima.Companion

フィールド

adSlotId、 apiFramework、 companionClickThrough、 creativeType、 height、 trackingEvents、 url、 width

メソッド

createCompanion

広告のコンパニオンに関する情報が含まれています。

プロパティ

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

createCompanion()

戻り値 ima.Companion:

トップへ戻る

クラス ima.CuePoint

フィールド

end、hasPlayed、start

メソッド

createCuePoint

キューポイントに関する情報が含まれています。

プロパティ

名前	型	説明
end		キューポイントの終了時間（秒単位）。これは広告ブレークに対応します。
hasPlayed		キューポイントがすでに再生されたかどうかを示すブール値。
start		キューポイントの開始時間（秒単位）。これは広告ブレークに対応します。

createCuePoint()

戻り値 ima.CuePoint:

トップへ戻る

クラス ima.Error

フィールド

id、 info、 type

メソッド

createError

エラーが発生した場合にエラーハンドラに渡されるオブジェクト。

プロパティ

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

createError()

戻り値 ima.Error:

トップへ戻る

クラス ima.ErrorEvent

フィールド

BAD_STREAM_REQUEST、COULD_NOT_LOAD_STREAM、ERROR、INVALID_RESPONSE、STREAM_API_KEY_NOT_VALID

SDK が返す可能性のあるすべてのエラー。

プロパティ

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

トップへ戻る

クラス ima.Player

メソッド

adBreakEnded、 adBreakStarted、 allVideoComplete、 createPlayer、 loadUrl、 streamInitialized

adBreakEnded(adBreakInfo)

省略可。ミッドロール挿入点が終了したときに呼び出されます。

パラメータ	型	説明
adBreakInfo	ima.AdBreakInfo	広告ブレークに関する情報が含まれます。

adBreakStarted(adBreakInfo)

省略可。ミッドロール挿入点が開始されたときに呼び出されます。

パラメータ	型	説明
adBreakInfo	ima.AdBreakInfo	広告ブレークに関する情報が含まれます。

allVideoComplete()

省略可。すべての動画が完了したときに呼び出されます。

createPlayer()

空の IMA Player オブジェクトを作成します。広告を再生するには、loadUrl 関数を実装する必要があります。その他の関数は省略可能です。

戻り値 ima.Player:

loadUrl(streamInfo)

プレーヤーが URL の再生を開始する必要があるときに呼び出されます。ストリームを読み込むには、このメソッドを実装する必要があります。

パラメータ	型	説明
streamInfo	ima.StreamInfo	コンテンツの再生に必要な情報が含まれています。

streamInitialized(streamInfo)

ストリームが初期化されたときに呼び出されます。

パラメータ	型	説明
streamInfo	ima.StreamInfo	コンテンツの再生に必要な情報が含まれています。

トップへ戻る

クラス ima.StreamFormat

フィールド

DASH、HLS

ストリームの形式を定義します。

プロパティ

名前	型	説明
DASH
HLS

トップへ戻る

クラス ima.StreamInfo

フィールド

format、manifest、streamId、streamType、subtitles

メソッド

createStreamInfo

ストリームについて SDK からプレーヤーに渡される情報。

プロパティ

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

createStreamInfo()

戻り値 ima.StreamInfo:

トップへ戻る

クラス ima.StreamManager

メソッド

addEventListener、 createStreamManager、 enableInteractiveAds、 getContentTime、 getCuePoints、 getPreviousCuePoint、 getStreamTime、 loadThirdPartyStream、 onMessage、 replaceAdTagParameters、 start

ストリームの再生を管理するためのオブジェクト。

addEventListener(event, callback)

指定されたイベントのリスナーを追加します。サポートされているイベントについては、AdEvents 定数をご覧ください。

パラメータ	型	説明
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

戻り値 ima.StreamManager:

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

enableInteractiveAds()

サポート対象外。代わりに、コンパニオン広告から RAF に直接データを渡します。これは現在 no op です。

getContentTime(streamTime)

VOD ストリームの時間をミリ秒単位で取得します。これは、広告なしのコンテンツの時間を表します。詳しくは、よくある質問をご覧ください。現在のストリーム時間のコンテンツ時間を取得するには、-1 で渡します。

Integer を返します: 指定されたストリーム時間に対応するコンテンツ時間。

パラメータ	型	説明
streamTime	Integer	ストリーム内の時間。

getCuePoints()

すべての広告ブレークに対応するすべてのキューポイントを返します。これは、すべての広告ブレークが事前にわかっているビデオ オンデマンド コンテンツでのみ有効です。すべての時間はストリーム時間を秒単位で表します。Cloud Stitching API ストリームの場合、各 ima.CuePoint の hasPlayed プロパティは常に false です。

Object を返します。すべてのキューポイントを含む配列。

getPreviousCuePoint(time)

この時刻の前のキューポイントを返します。キューポイントは広告ブレークを示します。すべての時間は、ストリーム時間を秒単位で表します。

戻り値 ima.CuePoint: start、end、hasPlayed を含むオブジェクト。キューポイントがない場合は Invalid を返します。

パラメータ	型	説明
time	Float	ルックアップする時間。-1 は現在の時間を示し、他のすべてのストリームに対して Invalid を返します。

getStreamTime(contentTime)

VOD のコンテンツ時間（ミリ秒単位）からストリームの時間を取得します。詳しくは、よくある質問をご覧ください。

Integer を返します: 指定されたコンテンツ時間に対応するストリーム時間。

パラメータ	型	説明
contentTime	Integer	コンテンツの時刻。

loadThirdPartyStream(streamManifest, streamSubtitle)

広告のメタデータを読み込み、指定された streamManifestUrl と streamSubtitle のデータを使用して loadUrl 関数を呼び出します。この関数は、ストリーム リクエストのタイプが ima.StreamType.POD_VOD の場合にのみ動作します。

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

onMessage(msg)

Video オブジェクトから送信されるすべてのメッセージを処理します。roMessagePort で受信したメッセージごとに呼び出す必要があります。

パラメータ	型	説明
msg	object	roVideo ポートからのメッセージ。

replaceAdTagParameters(adTagParameters)

ライブ ストリームの今後の広告リクエストに使用されるすべての広告タグ パラメータを置き換えます。この呼び出しは VOD ストリームでは no-op になります。

パラメータ	型	説明
adTagParameters	string	新しい広告タグのパラメータ。

start()

ストリームの再生を開始します。

トップへ戻る

クラス ima.StreamRequest

フィールド

adTagParameters、adUiNode、apiKey、assetKey、authToken、contentSourceId、customAssetKey、format、networkCode、player、ppid、streamActivityMonitorId、videoId、videoObject、videoStitcherSessionOptions

メソッド

createLiveStreamRequest、 createPodLiveStreamRequest、 createPodVodStreamRequest、 createStreamRequest、 createVideoStitcherLiveStreamRequest、 createVideoStitcherVodStreamRequest、 createVideoStitcherVodStreamRequestWithVodConfig、 createVodStreamRequest

ストリーム リクエストのプロパティを指定するために使用されます。

プロパティ

名前	型	説明
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 の動画スティッチャー固有のパラメータを設定するために使用されます。

createLiveStreamRequest(assetKey, apiKey, networkCode)

ライブ StreamRequest の必須プロパティを初期化します。この API を使用すると、他の StreamType 固有のプロパティはすべて無視されます。必須パラメータのいずれかが空の文字列の場合、エラー ロギングが発生し、API は一般的な StreamRequest を返します。プロパティは無視されません。

必須のライブ プロパティを含む ima.StreamRequest: ima.StreamRequest オブジェクトを返します。

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

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Pod Live ima.StreamRequest の必須プロパティを初期化します。この API を使用すると、他の ima.StreamType 固有のプロパティは無視されます。必須パラメータのいずれかが空の文字列の場合、エラー ロギングが発生し、API は一般的な StreamRequest を返します。プロパティは無視されません。

StreamRequest を返します。必要な PodLive プロパティを含む ima.StreamRequest オブジェクト。

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

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)

Video Stitcher Live 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)

Video Stitcher VOD StreamRequest の必須プロパティを初期化します。この API を使用すると、他の StreamType 固有のプロパティは無視されます。必須パラメータのいずれかが空の文字列の場合、エラー ロギングが発生し、API は一般的な StreamRequest を返します。プロパティは無視されません。

ima.StreamRequest: 必須の VideoStitcherVod プロパティを含む ima.StreamRequest オブジェクトを返します。

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

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

クラウド動画スティッチャーから作成された vodConfigId を使用して、Video Stitcher VOD StreamRequest の必須プロパティを初期化します。この API を使用すると、他の StreamType 固有のプロパティは無視されます。必須パラメータのいずれかが空の文字列の場合、エラー ロギングが発生し、API は一般的な StreamRequest を返します。プロパティは無視されません。

ima.StreamRequest: 必須の VideoStitcherVod プロパティを含む ima.StreamRequest オブジェクトを返します。

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

VOD ima.StreamRequest の必須プロパティを初期化します。この API を使用すると、他の ima.StreamType 固有のプロパティは無視されます。必須パラメータのいずれかが空の文字列の場合、エラー ロギングが発生し、API は一般的な StreamRequest を返します。プロパティは無視されません。

戻り値 ima.StreamRequest: 必要な VOD プロパティを含む ima.StreamRequest オブジェクト。

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

トップへ戻る

クラス ima.StreamType

フィールド

ライブ、 VOD

プレーヤーに再生を要求するストリームのタイプを定義します。プリロールと VOD はストリームの最初から再生される必要があります。

プロパティ

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

トップへ戻る

クラス ima.WrapperInfo

フィールド

adId、 adSystem、 creativeAdId、 creativeId、 dealId

メソッド

createWrapperInfo

ラッパーに関する情報が含まれています。

プロパティ

名前	型	説明
adId		広告の ID。不明な場合は空の文字列。
adSystem		広告システムの宣言名。不明な場合は空の文字列。
creativeAdId		クリエイティブの広告 ID。不明な場合は空の文字列。
creativeId		クリエイティブの ID。不明な場合は空の文字列。
dealId		取引 ID。不明な場合は空の文字列。

createWrapperInfo()

戻り値 ima.WrapperInfo:

トップへ戻る