Adobe Experience Platform Web SDK を使用したEdgeへの web データの送信
バージョン 2.20.0 以降は、Adobe Experience Platform Web SDK の streamingMedia
コンポーネントを使用すると、web サイト上のメディアセッションに関連するデータを収集できます。 収集されたデータには、メディアプレイバック、一時停止、完了およびその他の関連イベントに関する情報を含めることができます。
データを収集したら、Adobe Experience PlatformやAdobe Analyticsに送信し、レポートを生成できます。 この機能は、web サイトでのメディア消費行動を追跡および把握するための包括的なソリューションを提供します。
Media JS SDK を使用している顧客の場合、Web SDK は、Media JS SDK から Web SDK に移行するための移行パスを提供します。一方、メディアイベントの処理など、既存の Media JS 機能のサポートも含まれます。
前提条件 prerequisites
Web SDK の streamingMedia
コンポーネントを使用するには、次の前提条件を満たす必要があります。
- ストリーミングメディアデータをEdgeに送信する前に、まず Experience Platform Edgeでのストリーミングメディアコレクションアドオンのインストールの手順を実行します。
- Adobe Experience PlatformやAdobe Analyticsにアクセスできることを確認します。
- Web SDK バージョン 2.20.0 以降を使用する必要があります。 最新バージョンのインストール方法については、Web SDK インストールの概要を参照してください。
- 使用しているデータストリームの「Media Analytics」オプションを有効にします。
- データストリームで使用するスキーマに、メディアコレクションのスキーマフィールドが含まれていることを確認してください。
- タグ拡張機能または JavaScript ライブラリを使用して、このページで示すように Web SDK 設定でストリーミングメディア機能を設定します。
ストリーミングメディアコレクションアドオンの実装を Media JS から Web SDK に移行するには、このページで説明する手順に従います。
手順 1:Experience PlatformWeb SDK のインストール
Web プロパティに Web SDK をインストールする方法については、 専用ドキュメントを参照してください。
手順 2:Web SDK streamingMedia
コンポーネントの設定
例
以下のスニペットは、Media JS でメディアコレクションを設定する方法を示しています。
var mediaConfig = new ADB.MediaConfig();
mediaConfig.trackingServer = "company.hb-api.omtrdc.net";
mediaConfig.playerName = "player_name";
mediaConfig.channel = "sample_channel";
mediaConfig.appVersion = "app_version";
mediaConfig.debugLogging = true;
mediaConfig.ssl = true;
ADB.Media.configure(mediaConfig, appMeasurement);
代わりに、次に示すように、Web SDK で streamingMedia
コンポーネントを設定する必要があります。
alloy("configure", {
streamingMedia: {
channel: "sample_channel",
playerName: "player_name",
appVersion: "app_version",
mainPingInterval: 10,
adPingInterval: 10
}
});
設定方法について詳しくは、Web SDK streamingMedia
コンポーネント ドキュメントを参照してください。
手順 3:Media JS SDK から移行する際に、Media トラッカーインスタンスを取得する
Media JS SDK を使用している顧客の場合、Web SDK は、Media JS SDK から Web SDK に移行するための移行パスを提供します。一方、メディアイベントの処理など、既存の Media JS 機能のサポートも含まれます。
Web SDK には、Media Analytics トラッカーを取得するコマンドが含まれています。 このコマンドを使用してオブジェクトインスタンスを作成し、Media JS ライブラリで提供される API と同じ API を使用してメディアイベントを追跡できます。
サポートされるメソッドについて詳しくは、getMediaAnalyticsTracker
のドキュメントを参照してください。
以下のスニペットは、Media JS でメディアトラッカーインスタンスを取得する方法を示しています。
var tracker = ADB.Media.getInstance();
代わりに、Web SDK で getMediaAnalyticsTracker
コマンドを使用して、同じ結果を得ることができます(下図を参照)。
// aquire Media Analytics APIs
const Media = await window.alloy("getMediaAnalyticsTracker", {});
// create a media tracker instance
const trackerInstance = Media.getInstance();
すべてのヘルパーメソッドは、Media
オブジェクトで使用できます。 トラッカーメソッドは、以下に示すように、トラッカーインスタンスで使用できます。
const mediaInfo = Media.createMediaObject(
"video name",
"player video",
60,
Media.StreamType.VOD,
Media.MediaType.Video
);
const contextData = {
isUserLoggedIn: "false",
tvStation: "Sample TV station",
programmer: "Sample programmer",
assetID: "/uri-reference"
};
// Set standard Video Metadata
contextData[Media.VideoMetadataKeys.Episode] = "Sample Episode";
contextData[Media.VideoMetadataKeys.Show] = "Sample Show";
trackerInstance.trackSessionStart(mediaInfo, contextData);