JavaScript 3.x のセットアップ

前提条件

  • 有効な設定パラメーターを取得 これらのパラメーターは、Analytics アカウントの設定後、アドビの担当者から取得できます。

  • メディアアプリケーションで、AppMeasurement と JavaScript 向け Experience Cloud Identity Service を実装します
    詳しくは、JavaScript を使用した Analytics の実装 および Experience Cloud ID サービスの実装を参照してください。

  • メディアプレーヤーで以下の機能を設定します。

    • プレーヤーイベントをサブスクライブするための API - メディア SDK では、プレーヤーでイベントが発生する際に、シンプルな API のセットを呼び出す必要があります。
    • プレーヤー情報を提供する API - 現在再生中のメディア、広告、チャプターに関する情報が含まれます。
  1. ダウンロードしたライブラリをプロジェクトに追加します。利便性のために、クラスへのローカル参照を作成します。

    1. ダウンロードした MediaSDK-js-v3*.zip ファイルを展開します。

    2. libs ディレクトリに MediaSDK.js ファイルが存在することを確認します。

    3. MediaSDK.js ファイルをホストします。

      このコア JavaScript ファイルは、サイトのすべてのページから参照可能な Web サーバーでホストする必要があります。次の手順で、これらのファイルへのパス情報が必要になります。

    4. サイトのすべてのページから MediaSDK.js を参照します。

      各ページの <head> タグまたは <body> タグに以下のコードを追加して、JavaScript 用の MediaSDK を含めます。次に例を示します。

      <script type="text/javascript" src="https://INSERT-DOMAIN-AND-PATH-TO-CODE-HERE/MediaSDK.js"></script>
      
    5. ライブラリが正常に読み込まれたことをすばやく確認するには、Window オブジェクトで ADB.Media が書き出されていることを確認します。

      メモ

      JavaScript SDK は、AMD および CommonJS モジュールの仕様に準拠しており、互換性のあるモジュールローダーと共に MediaSDK.js を使用することもできます。

  2. AppMeasurement のインスタンスを作成し、visitor を設定します。

    メディア SDK の設定には、visitor が設定された AppMeasurement のインスタンスが必要です。

     var appMeasurement = new AppMeasurement(“<rsid>”);
     appMeasurement.visitor = visitor;
     appMeasurement.trackingServer = “<visitor_namespace>.sc.omtrdc.net”;
    
  3. メディア SDK の設定

    メディア SDK は、Web ページごとに 1 回設定する必要があります。設定は、作成されるすべてのトラッカーインスタンスに適用されます。

    重要

    Media SDK(3.x)は、メディアコレクション API を使用して、2.x SDK で使用されている HB エンドポイントとは異なるメディアを追跡します。詳細については、アドビの担当者にお問い合わせください。

    MediaConfig 初期化のサンプル:

     // Create MediaConfig object (same as above)
     var mediaConfig = new ADB.MediaConfig();
     mediaConfig.trackingServer = Configuration.MEDIA_COLLECTION_ENDPOINT;
     mediaConfig.playerName = Configuration.PLAYER_NAME;
     mediaConfig.channel = Configuration.CHANNEL;
     mediaConfig.appVersion = Configuration.APP_VERSION;
     mediaConfig.debugLogging = false;
     mediaConfig.ssl = true;
    
     ADB.Media.configure(mediaConfig, appMeasurement);
    
  4. MediaTracker インスタンスを作成します。

    メディア SDK の設定後、getInstance API を使用して、メディアコンテンツを追跡するためのトラッカーインスタンスを作成できます。

    var tracker = ADB.Media.getInstance();
    
    重要

    tracker インスタンスがアクセス可能であることと、メディアセッションの終わりまで解放されないことを確認します。このインスタンスは、そのセッションで、その後のイベントをすべて追跡するために使用されます。

JavaScript 2.x から 3.x への移行

2.x から 3.x への移行について詳しくは、 2.x から 3.x への移行を参照してください。

このページ