Google IMA DAI SDK API

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

クラス google.ima.dai.api.Ad

メソッド

動的広告挿入中の広告オブジェクトを表すクラス。このクラスは、ima.Ad プロパティのサブセットを公開します。

getAdId()


string を返します。

getAdPodInfo()


google.ima.dai.api.AdPodInfo を返します。

getAdSystem()


string を返します。

getAdvertiserName()


string を返します。

getApiFramework()


string を返します。

getCompanionAds()


Array.<google.ima.dai.api.CompanionAd> を返します。

getCreativeAdId()


string を返します。

getCreativeId()


string を返します。

getDealId()


string を返します。

getDescription()


string を返します。

getDuration()


number を返します。

getTitle()


string を返します。

getVastMediaHeight()


number を返します。

getVastMediaWidth()


number を返します。

getWrapperAdIds()


Array.<string> を返します。

getWrapperAdSystems()


Array.<string> を返します。

getWrapperCreativeIds()


Array.<string> を返します。

クラス google.ima.dai.api.AdPodInfo

メソッド

ダイナミック広告挿入時の広告連続表示情報オブジェクトを表すクラス。このクラスは、ima.AdPodInfo プロパティのサブセットを公開します。

getAdPosition()


number を返します。

getMaxDuration()


number を返します。

getPodIndex()


number を返します。

getTimeOffset()


number を返します。

getTotalAds()


number を返します。

クラス google.ima.dai.api.AdProgressData

フィールド

広告の進行状況データを指定するクラス。

プロパティ

名前 型 説明
adBreakDuration

adPosition

currentTime

duration

totalAds

クラス google.ima.dai.api.CompanionAd

メソッド

動的広告挿入時のコンパニオン広告オブジェクトを表すクラス。このクラスは、ima.CompanionAd プロパティのサブセットを公開します。

getAdSlotId()


string を返します。

getContent()


string を返します。

getContentType()


string を返します。

getHeight()


number を返します。

getWidth()


number を返します。

クラス google.ima.dai.api.CuePoint

フィールド

end、 played、 start

DAI VOD ストリームのミッドロール挿入点を表すキューポイントのプロパティを指定するクラス。

プロパティ

名前 型 説明
end

このキューポイントの終了時間。
played

このキューポイントが再生されたかどうか。
start

このキューポイントの開始時間。

クラス google.ima.dai.api.LiveStreamRequest

フィールド

ライブ配信リクエストのプロパティを指定するクラス。

コンストラクタ:
パラメータ 型 説明
opt_liveStreamRequest Object

オブジェクトにすでにストリーム リクエスト プロパティが割り当てられている。

プロパティ

名前 型 説明
assetKey

これは、再生するストリームを決定するために使用されます。ライブ配信リクエストのアセットキーは、DFP の管理画面で確認できる ID です。

クラス google.ima.dai.api.StreamData

フィールド

ストリームデータを指定するクラス。

プロパティ

名前 型 説明
adProgressData

現在再生中の広告のタイミングに関する情報。
cuepoints

オンデマンド ストリームの広告キューポイント。これらは、ストリーミングの進行に伴って変更される場合があります。これは、CUEPOINTS_CHANGED AdEvent のイベント リスナーでのみ入力されます。
errorMessage

streamId

subtitles

url

クラス google.ima.dai.api.StreamEvent

メソッド

このイベントタイプは、ストリームの状態が変化したときに、ストリーム マネージャーによって通知として発生します。

getAd()


google.ima.dai.api.Ad を返します。広告情報を含んだオブジェクトを返します。

getStreamData()


google.ima.dai.api.StreamData を返します。 ストリーム情報を含むオブジェクトを返します。

列挙型 google.ima.dai.api.StreamEvent.Type

フィールド

IMA SDK でサポートされているイベントタイプのリスト。

値

値 説明
AD_BREAK_ENDED

ミッドロール挿入点が終了すると呼び出されます。
AD_BREAK_STARTED

ミッドロール挿入点が開始されると呼び出されます。
AD_PROGRESS

広告の進行状況が更新されたときに呼び出されます。
CLICK

広告の再生中にクリック要素がクリックまたはタップされたときにディスパッチされます。
COMPLETE

広告が完了すると呼び出されます。
CUEPOINTS_CHANGED

キューポイントが変更されたときにオンデマンド ストリーム用にディスパッチされます。
ERROR

エラーが発生すると呼び出されます。
FIRST_QUARTILE

広告が最初の四分位に達したときに呼び出されます。
LOADED

ストリーム マニフェストが利用可能になると呼び出されます。
MIDPOINT

広告の中央に達すると呼び出されます。
STARTED

広告の開始時に呼び出されます。
STREAM_INITIALIZED

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

広告が 3 番目の四分位に達すると呼び出されます。

クラス google.ima.dai.api.StreamManager

メソッド

ダイナミック広告挿入ストリームを処理します。DAI バックエンドとのやり取りを管理し、トラッキング ピングを処理するほか、ストリーミング イベントと広告イベントをパブリッシャーに転送します。このマネージャーは、特定の広告のマネージャーではなく、ストリーム全体のマネージャーであるため、BaseAdsManager から継承しません。

コンストラクタ:
パラメータ 型 説明
videoElement HTMLVideoElement

実際の動画プレーヤー要素。

contentTimeForStreamTime(streamTime)

指定したストリーム時間の広告なしコンテンツ時間を返します。ライブ配信の指定された配信時間を返します。

number を返します。広告が削除された後の、指定されたストリーム時間に対応するコンテンツ時間です。

パラメータ 型 説明
streamTime number

挿入された広告を含む配信時間（秒単位）。

onTimedMetadata(metadata)

処理されたメタデータの辞書を渡します。辞書では、キー「TXXX」と、値としてユーザー定義メタデータ文字列を想定しています。プレーヤーが元のメタデータを提供している場合は、代わりに ima.dai.api.StreamManager.processMetadata を呼び出します。

パラメータ 型 説明
metadata Object

メタデータのディクショナリ。

previousCuePointForStreamTime(streamTime)

指定されたストリーム時間の前のキューポイントを返します。そのようなキューポイントが存在しない場合、null を返します。これは、スナップバックなどの機能を実装するために使用され、ユーザーがシークしたことをパブリッシャーが検出したときに呼び出され、ユーザーをミッドロール挿入点に戻します。

指定されたストリーム時間の前のキューポイントを返します。google.ima.dai.api.CuePoint

パラメータ 型 説明
streamTime number

シークされたストリーム時間。

processMetadata(type, data, timestamp)

ライブ配信のタイミング付きメタデータを処理します。動画プレーヤーがタイムスタンプとともに未解析のメタデータを提供する場合に使用します。それ以外の場合は、ima.dai.api.StreamManager.onTimedMetadata を呼び出します。

パラメータ 型 説明
type string

メタデータのタイプ。「ID3」にする必要があります。
data Uint8Array

未加工のタグデータ。ID3 の場合は、タグ全体である必要があります。
timestamp number

データの処理が必要な時刻。

requestStream(streamRequest)

指定されたストリーム パラメータを使用してストリームの読み込みをリクエストします。

パラメータ 型 説明
streamRequest google.ima.dai.api.StreamRequest

ストリーム メタデータを読み込むパラメータが含まれています。

setClickElement(clickElement)

広告のクリックスルー要素を設定します。この要素は、広告の再生中にクリックまたはタップ レシーバーとして使用され、現在のページから離脱する可能性があります。

パラメータ 型 説明
clickElement Element

広告のクリックスルーとして使用される要素。

streamTimeForContentTime(contentTime)

特定のコンテンツ時間の広告ありのストリーミング時間を返します。ライブ配信の指定されたコンテンツ時間を返します。

number を返します。広告が挿入された後の、指定されたコンテンツ時間に対応するストリーム時間です。

パラメータ 型 説明
contentTime number

広告なしのコンテンツの時間（秒単位）。

クラス google.ima.dai.api.StreamRequest

フィールド

ストリーム リクエストのプロパティを指定するクラス。

プロパティ

名前 型 説明
adTagParameters

ストリーム リクエストで、限定された一連の広告タグ パラメータをオーバーライドできます。詳しくは、 ストリームにターゲティング パラメータを指定するをご覧ください。ストリーム バリアントの優先度には、dai-ot パラメータと dai-ov パラメータを使用できます。詳細については、 ストリームのバリエーション パラメータをオーバーライドするをご覧ください。
apiKey

ストリーム リクエストの API キー。これは DFP 管理画面で設定され、コンテンツをロック解除するためにパブリッシャーに提供されます。コンテンツにアクセスしようとしているアプリを確認します。
streamActivityMonitorId

ストリーム アクティビティ モニターでストリームのデバッグに使用する ID。これは、パブリッシャーがストリーム アクティビティ モニター ツールでストリームログを簡単に見つけられるようにするために使用されます。

クラス google.ima.dai.api.VODStreamRequest

フィールド

VOD ストリーム リクエストのプロパティを指定するクラス。

コンストラクタ:
パラメータ 型 説明
opt_VODStreamRequest Object

オブジェクトにすでにストリーム リクエスト プロパティが割り当てられている。

プロパティ

名前 型 説明
contentSourceId

CMS から取得したパブリッシャー コンテンツの一意の識別子。オンデマンド ストリームに必須です。
videoId

動画コンテンツ ソースの ID。オンデマンド ストリームに必須です。

定数 google.ima.VERSION

SDK の完全なバージョンを含む文字列。