Adobe Media Analytics (3.x SDK) for Audio and Video 拡張機能の概要

メモ

Adobe Experience Platform Launchは、Adobe Experience Platformのデータ収集テクノロジーのスイートとしてリブランドされました。 その結果、製品ドキュメント全体でいくつかの用語の変更がロールアウトされました。 用語の変更点の一覧については、次のドキュメントを参照してください。

このドキュメントには、Adobe Media Analytics (3.x SDK) for Audio and Video 拡張機能(Media Analytics 拡張機能)のインストール、設定および実装に関する情報が含まれています。この拡張機能を使用してルールを作成し、サンプルやサンプルへのリンクを作成する場合に使用できるオプションについても説明します。

Media Analytics(MA)拡張機能は、コアe JavaScript Media SDK(Media 3.x SDK)を追加します。この拡張機能は、タグが有効なサイトまたはプロジェクトにMediaトラッカーインスタンスを追加する機能を提供します。 MA 拡張機能には、次の 2 つの拡張拡張機能が必要です。

重要

この拡張機能は、Media 3.x SDK でデプロイされ、Media 2.x SDK との下位互換性はありません。ページで既に Media 2.x SDK を使用している場合は、この拡張機能の代わりに Adobe Media Analytics for Audio and Video 拡張機能を使用します。

タグを有効にしたプロジェクトに上記の3つの拡張機能をすべて含めたら、次の2つの方法のいずれかを実行できます。

  • Web アプリケーションから Media API を使用する
  • 特定のメディアプレイヤーイベントを Media トラッカーインスタンス上の API にマッピングする、プレーヤー固有の拡張機能を含めたりビルドしたりします。このインスタンスは、MA 拡張機能を通じて公開されます。

MA 拡張機能のインストールと設定

  • インストール: MA 拡張機能をインストールするには、拡張機能プロパティを開き、エクステンション/カタログ​を選択し、 オーディオおよびビデオ向け Adobe Media Analytics(3.x SDK)​拡張機能にカーソルを置いて「インストール」を選択します。

  • 設定: MA 拡張機能を設定するには、「拡張機能」タブを開き、拡張機能にカーソルを置いて「設定」をクリックします。

MA 拡張機能の設定

設定オプション:

オプション 説明
Collection API Server Media Collection API Server を定義します(このサーバーを取得するには、アドビの担当者にお問い合わせください)
Application Version メディアプレーヤーアプリケーション/SDK のバージョン。
Player Name 使用中のメディアプレーヤーの名前(例:「AVPlayer」、「HTML5 Player」、「My VideoPlayer」)。
チャネル チャネル名プロパティ
Debug Logging ログを有効または無効にします
Enable SSL HTTPS 経由の ping 送信を有効または無効にします
Export APIs to Window Object グローバルスコープへの Media Analytics API の書き出しを有効または無効にします
Variable Name window オブジェクトの下の Media Analytics API を書き出すために使用する変数

リマインダー: MA 拡張機能には、 Analytics および Experience Cloud ID 拡張機能が必要です。また、拡張機能プロパティにこれらの拡張機能を追加して設定する必要があります。

MA 拡張機能の使用

webpage/JS-app からの使用

MA 拡張機能は、設定ページ内の「Window オブジェクトに API を書き出し」設定を有効にして、メディア API をグローバルウィンドウオブジェクトに書き出します。設定された変数名の下に API をエクスポートします。例えば、変数名を ADB に設定している場合、window.ADB.Media によって Media API にアクセスできます。

重要

MA 拡張機能は、window["CONFIGURED_VARIABLE_NAME"] が定義されておらず、既存の変数を上書きしない場合にのみ、API をエクスポートします。

  1. Media API: window["CONFIGURED_VARIABLE_NAME"].Media

    これにより、Media SDK のすべての API と定数が公開されます:https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript_3x/APIReference.html

  2. Media トラッカーインスタンスを作成: window["CONFIGURED_VARIABLE_NAME"].Media.getInstance

    戻り値:​メディアセッションを追跡するための Media トラッカーインスタンス。

    var Media = window["CONFIGURED_VARIABLE_NAME"].Media;
    
    var tracker = Media.getInstance();
    
  3. Media トラッカーインスタンスを使用し、JS API ドキュメントに従ってメディアトラッキングを実装します。

サンプルプレイヤーは、MA サンプルプレイヤーで入手できます。サンプルプレイヤーは、Web アプリケーションから直接 Media Analytics をサポートするために、MA 拡張機能を使用する方法を紹介しています。

他の拡張機能からの使用

MA拡張は、mediaを共有モジュールとして他の拡張機能に公開します。 (共有モジュールについて詳しくは、共有モジュールのドキュメント/を参照してください。)

重要

共有モジュールは、他の拡張機能からのみアクセスできます。つまり、Web ページや JavaScript アプリケーションは共有モジュールにアクセスすることも、拡張機能以外の turbine(後述のサンプルコードを参照)を使用することもできません。

  1. Media API: media 共有モジュール

    これにより、Media SDK のすべての API と定数が公開されます:https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript_3x/APIReference.html

  2. 次のように、Media トラッカーインスタンスを作成します。

    戻り値:​メディアセッションを追跡するための Media トラッカーインスタンス。

    var Media =
      turbine.getSharedModule('adobe-media-analytics', 'media');
    
    var tracker = Media.getInstance();
    
  3. Media トラッカーインスタンスを使用し、JS API ドキュメントに従ってメディアトラッキングを実装します。

メモ

テスト:​このリリースでは、拡張機能をテストするには、すべての独立した拡張機能にアクセスできる  Platform  に拡張機能をアップロードする必要があります。

このページ