このドキュメントには、Adobe Media Analytics (3.x SDK) for Audio and Video 拡張機能(Media Analytics 拡張機能)のインストール、設定および実装に関する情報が含まれています。この拡張機能を使用してルールを作成し、サンプルやサンプルへのリンクを作成する場合に使用できるオプションについても説明します。
Media Analytics(MA)拡張機能は、コアe JavaScript Media SDK(Media 3.x SDK)を追加します。この拡張機能は、Adobe Experience Platform Launch サイトまたはプロジェクトに Media
トラッカーインスタンスを追加する機能を提供します。MA 拡張機能には、次の 2 つの拡張拡張機能が必要です。
この拡張機能は、Media 3.x SDK でデプロイされ、Media 2.x SDK との下位互換性はありません。ページで既に Media 2.x SDK を使用している場合は、この拡張機能の代わりに Adobe Media Analytics for Audio and Video 拡張機能を使用します。
Platform Launch プロジェクトに前述の 3 つの拡張機能をすべて含めたら、次の 2 つの方法のいずれかを実行できます。
Media
API を使用するMedia
トラッカーインスタンス上の API にマッピングする、プレーヤー固有の拡張機能を含めたりビルドしたりします。このインスタンスは、MA 拡張機能を通じて公開されます。インストール:MA拡張機能 をインストールするには、拡張機能のプロパティを開き、を選択し Extensions > Catalog、 Adobe Media Analytics (3.x SDK) for Audio and Video 拡張機能の上にマウスポインターを置いて、を選択し Installます。
設定:MA拡張 を設定するには、 Extensions タブを開き、拡張機能の上にマウスポインターを置いて、次を選択し Configureます。
オプション | 説明 |
---|---|
Collection API Server | Media Collection API Server を定義します(このサーバーを取得するには、アドビの担当者にお問い合わせください) |
Application Version | メディアプレーヤーアプリケーション/SDK のバージョン。 |
Player Name | 使用中のメディアプレーヤーの名前(例:「AVPlayer」、「HTML5 Player」、「My VideoPlayer」)。 |
Channel | チャネル名プロパティ |
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 拡張機能は、Configuration ページ内の「Export APIs to Window Object」設定を有効にして、Media API をグローバルウィンドウオブジェクトにエクスポートします。設定された変数名の下に API をエクスポートします。例えば、変数名を ADB
に設定している場合、window.ADB.Media
によって Media API にアクセスできます。
MA 拡張機能は、window["CONFIGURED_VARIABLE_NAME"]
が定義されておらず、既存の変数を上書きしない場合にのみ、API をエクスポートします。
Media API: window["CONFIGURED_VARIABLE_NAME"].Media
これにより、Media SDK のすべての API と定数が公開されます:https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript_3x/APIReference.html
Media トラッカーインスタンスを作成: window["CONFIGURED_VARIABLE_NAME"].Media.getInstance
戻り値:メディアセッションを追跡するための Media
トラッカーインスタンス。
var Media = window["CONFIGURED_VARIABLE_NAME"].Media;
var tracker = Media.getInstance();
Media トラッカーインスタンスを使用し、JS API ドキュメントに従ってメディアトラッキングを実装します。
サンプルプレイヤーは、MA サンプルプレイヤーで入手できます。サンプルプレイヤーは、Web アプリケーションから直接 Media Analytics をサポートするために、MA 拡張機能を使用する方法を紹介しています。
MA 拡張は、共有モジュールとして media
を他の拡張機能に公開します。(共有モジュールについて詳しくは、共有モジュールのドキュメント/を参照してください。)
共有モジュールは、他の拡張機能からのみアクセスできます。つまり、Web ページや JavaScript アプリケーションは共有モジュールにアクセスすることも、拡張機能以外の turbine
(後述のサンプルコードを参照)を使用することもできません。
Media API: media
共有モジュール
これにより、Media SDK のすべての API と定数が公開されます:https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript_3x/APIReference.html
次のように、Media トラッカーインスタンスを作成します。
戻り値:メディアセッションを追跡するための Media
トラッカーインスタンス。
var Media =
turbine.getSharedModule('adobe-media-analytics', 'media');
var tracker = Media.getInstance();
Media トラッカーインスタンスを使用し、JS API ドキュメントに従ってメディアトラッキングを実装します。
テスト:このリリースでは、拡張機能をテストするには、すべての独立した拡張機能にアクセスできる Adobe Experience Platform Launch に拡張機能をアップロードする必要があります。