createMediaSession

createMediaSession コマンドは、Web SDK streamingMedia コンポーネントの一部です。 このコンポーネントを使用して、web サイトのメディアセッションに関連するデータを収集できます。 このコンポーネントの設定方法については、streamingMedia ​ ドキュメント ​を参照してください。

収集されたデータには、メディアの再生、一時停止、完了、その他の関連イベントに関する情報が含まれます。 収集したら、このデータを​ ストリーミングメディア用Adobe Analyticsに送信して、指標を集計できます。 この機能は、web サイトでのメディア消費行動を追跡および把握するための包括的なソリューションを提供します。

Web SDKでメディアセッションを作成するには、次の2つの方法があります。

  • 自動追跡メディアセッション​により、Web SDKでAdobe Analytics for Streaming MediaへのMedia ping イベントのディスパッチを管理できます。 これらのpingの頻度は、streamingMedia コンポーネントの設定設定によって決まります。
  • 手動で追跡されたメディアセッション​を使用すると、Adobe Analytics for Streaming Mediaへのセッション ping イベントのディスパッチをより詳細に制御できます。 さらに、メディアセッション用にsessionIDを保存することもできます。

自動的に追跡されるメディアセッションの作成 automatic

メディアセッションのトラッキングを自動的に開始するには、次のオプションでcreateMediaSession メソッドを呼び出します。

    alloy("createMediaSession", {
        playerId: "movie-test",
        getPlayerDetails: () => {
            return {
                playhead: document.getElementById("movie-test").currentTime,
                qoeDataDetails: {
                    bitrate: 1000,
                    startupTime: 1000,
                    fps: 30,
                    droppedFrames: 10
                }
            };
        },
        xdm: {
            eventType: "media.sessionStart",
            mediaCollection: {
                sessionDetails: {
                    ...
                }
            }
        }
    });
プロパティ
タイプ
必須
説明
playerId
文字列
プレーヤーID。メディアセッションを表す一意のID。
getPlayerDetails
関数
プレーヤーの詳細を返す関数。 このコールバック関数は、指定されたplayerIdのすべてのメディアイベントの前にWeb SDKによって呼び出されます。
xdm.eventType
オブジェクト
×
メディアイベントタイプ。 指定しない場合、このフィールドは自動的にmedia.sessionStartに設定されます。
xdm.mediaCollection.sessionDetails
オブジェクト
セッションの詳細プロパティが含まれます。 詳しくは、​ メディア収集スキーマ ​を参照してください。

手動で追跡されたメディアセッションの作成 manual

メディアセッションのトラッキングを手動で開始するには、次のオプションでcreateMediaSession メソッドを呼び出します。

const sessionPromise = alloy("createMediaSession", {
    xdm: {
        eventType: "media.sessionStart",
        mediaCollection: {
            playhead: 0,
            sessionDetails: {
                ...
            },
            qoeDataDetails: {
                bitrate: 1000,
                startupTime: 1000,
                fps: 30,
                droppedFrames: 10
            }
        }
    }
});
プロパティ
タイプ
必須
説明
xdm.eventType
オブジェクト
×
メディアイベントタイプ。 指定しない場合は、自動的にmedia.sessionStartに設定されます。
xdm.mediaCollection.sessionDetails
オブジェクト
セッションの詳細プロパティが含まれます。 詳しくは、​ メディア収集スキーマ ​を参照してください。
xdm.mediaCollection.playhead
整数
現在の再生ヘッド。
xdm.mediaCollection.qoeDataDetails
オブジェクト
×
Quality of Experience データの詳細: 詳しくは、​ メディア収集スキーマ ​のドキュメントを参照してください。

Web SDK タグ拡張機能を使用したメディアセッションの作成

このコマンドと同等のWeb SDK タグ拡張機能は、‘Send media event’ アクション内のSession start イベントタイプです。

recommendation-more-help
experience-platform-help-collection