広告イベントと広告オブジェクト
概要
NS 動画コントリブ広告は、 videojs/videojs-contrib-ads GitHub リポジトリにあり、動画広告ライブラリと動画広告統合に必要な共通機能を提供し、特定の広告統合のために記述する必要があるコードを減らします。
これらのイベントとオブジェクトは、Brightcoveが提供する FreeWheel および IMA3 プラグインに実装されています。これらの同じイベントとオブジェクトは、以下を除き、SSAI プラグインに実装されます。
player.ads.podインタフェースplayer.ads.providerオブジェクト
広告イベント
各広告プロバイダーは、一意のイベントセットを放出できます。通常、これらのイベントは、指標の目的で広告再生の状態を追跡し、カスタム UI を作成するために使用されます。統一性を促進し、カスタム UI およびアナリティクスプロバイダーが広告プロバイダーに依存しないよう、以下のイベントを実装することをお勧めします。
| イベント | 次の場合に送出されます。 |
|---|---|
ads-request |
広告データがリクエストされました |
ads-load |
広告データは、広告リクエストの後に利用できます |
ads-pod-started |
リニア広告ポッドが開始されました |
ads-pod-ended |
リニア広告ポッドが完了しました |
ads-allpods-completed |
リニア広告はすべて完成しました |
ads-ad-started |
広告が再生開始 |
ads-ad-ended |
広告が再生を完了する |
ads-first-quartile |
広告再生ヘッドが最初の四分位数を超える |
ads-midpoint |
広告再生ヘッドが中間点を横切る |
ads-third-quartile |
広告再生ヘッドが第3四分位を横切る |
ads-pause |
広告は一時停止されています |
ads-play |
広告が再開される |
ads-volumechange |
広告ボリュームが変更されました |
ads-click |
広告がクリックされました |
これらのイベントは、プレーヤーオブジェクトからリッスンできます。以下は、ads-ad-startedオブジェクトをリッスンするコードと、イベントハンドラに渡されたオブジェクトの外観のスクリーンショットです。
videojs.getPlayer('myPlayerID').on('loadedmetadata',function(){
var myPlayer = this;
...
myPlayer.on('ads-ad-started',function( evt ){
console.log('ads-ad-started event passed to event handler', evt);
});
広告オブジェクト
ご覧のように、イベントハンドラに渡されるイベントオブジェクトはそれほど有益ではありません。このため、より多くの広告情報を収集できるオブジェクトが 2 つあります。それらは player.ads.adと player.ads.podです。
下のスクリーンショットから、 player.ads.adオブジェクトに広告に関する情報が含まれておりtype、duration広告の、とりわけ。
player.ads.podオブジェクトには player.ads.ad と同様の情報が含まれており、ポッド内の広告の数が加算されます。次の最初のスクリーンショットは 1 つの広告ポッドを示していますが、2 番目のスクリーンショットは 3 つの広告を含むポッドを示しています。
グーグルの adsManager
GoogleのGoogle.ima.adsManagerインターフェースから利用できるメソッドとプロパティがあります。情報を取得するインターフェイスのプロパティ/メソッドを使用できます。destroy などのアクションを実行するメソッドを使用することはお勧めしませんsetAutoPlayAdBreaks 。stop 。たとえば、使用できる 1 つのメソッドを以下に示します。
AdsManager.getRemainingTime
タイプ: google.ima.AdsManager.getRemainingTime
使用法: myPlayer.ima3.adsManager.getRemainingTime()
このメソッドを呼び出すと、現在の広告の残り時間が返されます。広告が利用できない場合、または再生が終了した場合は-1 を返します。詳細については、メソッドに関するGoogleのドキュメントを参照してください。