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 の UI で確認できる識別子です。

クラス 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 を返します: ストリーム情報を含む return オブジェクト。

列挙型 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

広告の 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 キー。この機能は DFP 管理画面で設定され、パブリッシャーに提供されてコンテンツのロックを解除します。コンテンツにアクセスしようとしているアプリケーションを検証します。
streamActivityMonitorId

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

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

フィールド

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

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

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

プロパティ

名前 型 説明
contentSourceId

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

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

定数 google.ima.VERSION

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