JavaScript 2.xを使用した広告の追跡

重要

以下の手順は、SDK 2.x を使用した実装についてのガイダンスです。1.x バージョンの SDK を実装する場合は、1.x の開発ガイドをこちら(SDK のダウンロード)からダウンロードできます。

広告トラッキングの定数

定数名 説明
AdBreakStart 追跡する AdBreak Start イベントの定数
AdBreakComplete 追跡する AdBreak Complete イベントの定数
AdStart 追跡する Ad Start イベントの定数
AdComplete 追跡する Ad Complete イベントの定数
AdSkip 追跡する Ad Skip イベントの定数

実装手順

  1. プリロールを含め、いつ広告ブレークの境界が開始するかを識別し、広告ブレーク情報を使用して AdBreakObject を作成します。

    AdBreakObject リファレンス:

    変数名 説明 必須
    name プリロール、ミッドロール、ポストロールなど、広告ブレークの名前
    position 広告ブレークの位置番号(1 から始まる)
    startTime 広告ブレーク開始時の再生ヘッド値

    広告ブレークオブジェクトの作成:

    var adBreakObject =  
      MediaHeartbeat.createAdBreakObject(<ADBREAK_NAME>,  
                                         <POSITION>,  
                                         <START_TIME>);
    
  2. MediaHeartbeat インスタンスの AdBreakStarttrackEvent() を呼び出し、広告ブレークの追跡を開始します。

    mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakStart, adBreakObject);
    
  3. いつ広告が開始するかを識別し、広告情報を使用して AdObject インスタンスを作成します。

    AdObject リファレンス:

    変数名 説明 必須
    name 広告のわかりやすい名前.
    adId 広告の一意の識別子。
    position 広告ブレーク内の広告の位置番号(1 から始まる)。
    length 広告の長さ

    広告オブジェクトの作成:

    var adObject =  
      MediaHeartbeat.createAdObject(<AD_NAME>,  
                                    <AD_ID>,  
                                    <POSITION>,  
                                    <LENGTH>);
    
  4. オプションで、コンテキストデータ変数を使用して標準または広告メタデータをメディアトラッキングセッションにアタッチします。

    • JavaScript での標準広告メタデータの実装

    • カスタムの広告メタデータ - カスタムのメタデータの場合は、カスタムデータ変数の変数オブジェクトを作成し、現在の広告のデータを設定します。

      /* Set custom context data */
      var adCustomMetadata = {
          affiliate: "Sample affiliate",
          campaign: "Sample ad campaign",
          creative: "Sample creative"
      };
      
  5. MediaHeartbeat インスタンスの AdStart イベントで trackEvent() を呼び出し、広告再生の追跡を開始します。

    カスタムメタデータ変数(または空のオブジェクト)への参照を、イベント呼び出しの 3 番目のパラメーターとして含めます。

    _onAdStart = function() {
        this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdStart,  
                                        adObject,  
                                        adCustomMetadata);
    };
    
  6. 広告の再生が広告の終わりに到達したら、AdComplete イベントで trackEvent() を呼び出します。

    _onAdComplete = function() {
        this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdComplete);
    };
    
  7. ユーザーが広告のスキップを選択したので広告再生が完了しなかった場合は、AdSkip イベントを追跡します。

    _onAdSkip = function() {
        this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdSkip);
    };
    
  8. 同じ AdBreak にその他の広告がある場合、手順 3 ~ 7 を繰り返します。

  9. 広告ブレークが完了したら、AdBreakComplete イベントを使用して追跡します。

    _onAdBreakComplete = function() {
        this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakComplete);
    };
    

詳しくは、追跡シナリオのプリロール広告のある VOD 再生を参照してください。

このページ