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

フィールド

DAI VOD ストリームの広告ブレークを表すキューポイントのプロパティを指定するクラスです。

プロパティ

名前 型 説明
end

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

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

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

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

フィールド

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

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

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

プロパティ

名前 型 説明
assetKey

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

クラス 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

広告が第 1 四分位に達したときに発生します。
LOADED

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

広告が中間点に達したときに呼び出されます。
STARTED

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

ストリームの初期化時に呼び出されます。
THIRD_QUARTILE

広告が 75% に達したときに呼び出されます。

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

メソッド

ダイナミック広告挿入のストリームを処理します。DAI バックエンドとの通信の管理、トラッキング ping の処理、パブリッシャーへのストリームや広告イベントの転送を行います。このマネージャーは特定の広告のマネージャーではないため、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 キー。この ID は Chronicle の管理 UI で設定され、コンテンツのロックを解除するためにパブリッシャーに提供されます。コンテンツにアクセスしようとしているアプリケーションを検証します。
streamActivityMonitorId

ストリーム アクティビティ モニターでストリームをデバッグする際に使用される ID。 これは、パブリッシャーがストリーム アクティビティのモニタリング ツールでストリームログを見つける便利な方法を提供する場合に使用されます。

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

フィールド

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

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

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

プロパティ

名前 型 説明
contentSourceId

CMS によるパブリッシャー コンテンツの一意の識別子。オンデマンド ストリームでは必須です。
videoId

動画コンテンツ ソースの識別子。オンデマンド ストリームでは必須です。

定数 google.ima.VERSION

SDK のフル バージョンを含む文字列。