createMediaSession
createMediaSession
コマンドは、Web SDK streamingMedia
コンポーネントの一部です。 このコンポーネントを使用すると、web サイト上のメディアセッションに関連するデータを収集できます。 このコンポーネントの設定方法については、streamingMedia
ドキュメントを参照してください。
収集されたデータには、メディアプレイバック、一時停止、完了およびその他の関連イベントに関する情報を含めることができます。 収集したら、このデータを ストリーミングメディア用 Adobe Analytics に送信して、指標を集計できます。 この機能は、web サイトでのメディア消費行動を追跡および把握するための包括的なソリューションを提供します。
Web SDK でメディアセッションを作成するには、次の 2 つの方法があります。
- 自動トラッキングされるメディアセッションにより、Web SDK で ストリーミングメディア用 Adobe Analyticsへのメディア ping イベントのディスパッチを管理できす。 これらの ping の頻度は、streamingMedia コンポーネントの設定によって決まります。
- 手動でトラッキングされるメディアセッションを使用すると、ストリーミングメディア用 Adobe Analyticsへのセッション 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。メディアセッションを表す一意の識別子です。
getPlayerDetails
関数
○
プレーヤーの詳細を返す関数。 このコールバック関数は、指定された
playerId
の各メディアイベントの前に、Web SDK によって呼び出されます。xdm.eventType
オブジェクト
×
メディアイベントタイプ。 指定しない場合、自動的に
media.sessionStart
に設定されます。xdm.mediaCollection.sessionDetails
オブジェクト
○
セッションの詳細オブジェクト。
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
オブジェクト
○
セッションの詳細オブジェクト。
sessionDetails
オブジェクトには、セッションの詳細プロパティを含める必要があります。 詳しくは、 メディアコレクションのスキーマドキュメントを参照してください。xdm.mediaCollection.playhead
整数
○
現在の再生ヘッド。
xdm.mediaCollection.qoeDataDetails
オブジェクト
×
エクスペリエンスデータの品質の詳細。 詳しくは、 メディアコレクションのスキーマドキュメントを参照してください。
recommendation-more-help
ad108910-6329-42f1-aa1d-5920a2b13636