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

重要

以下の手順は、SDK 3.x を使用した実装についてのガイダンスです。If you are implementing any previous versions of the SDK, you can download the Developers Guides here: Download SDKs.

広告トラッキングの定数

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

実装手順

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

    AdBreakObject リファレンス:

    変数名 タイプ 説明
    name string adbreak名(プリロール、ミッドロールおよびポストロール)を示す空以外の文字列。
    position 数値 広告ブレークの位置番号(1 から始まる)
    startTime 数値 広告ブレーク開始時の再生ヘッド値

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

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

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

    AdObject リファレンス:

    変数名 タイプ 説明
    name string 広告名を示す空以外の文字列。
    adId string 広告識別子を示す空以外の文字列。
    position 数値 広告ブレーク内の広告の位置(1から始まる)。
    length 数値 広告の長さを示す正の数。

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

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

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

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

      /* Set context data */
      // Standard metadata keys provided by adobe.
      adMetadata[ADB.Media.AdMetadataKeys]  ="Sample Advertiser";
      adMetadata[ADB.Media.AdMetadataKeys] = "Sample Campaign";
      
      // Custom metadata keys
      adMetadata["affiliate"] = "Sample affiliate";
      adMetadata["campaign"] = "Sample ad campaign";
      adMetadata["creative"] = "Sample creative";
      
  5. MediaHeartbeat インスタンスの AdStart イベントで trackEvent() を呼び出し、広告再生の追跡を開始します。

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

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

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

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

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

    _onAdBreakComplete = function() {
        tracker.trackEvent(ADB.Media.Event.AdBreakComplete);
    };
    

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

このページ