JavaScript 2.x を使用したコア再生の追跡 track-core-playback-on-javascript
以下の手順は、2.x SDK に共通する実装のガイダンスです。
-
トラッキングの初期設定
いつユーザーが再生の意図をトリガーする(ユーザーが再生をクリックする、または自動再生がオンになる)かを識別し、
MediaObjectインスタンスを作成します。table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center 23-align-center 変数名 説明 必須 nameメディア名 ○ mediaidメディアの一意の ID ○ lengthメディアの長さ ○ streamTypeストリームタイプ(後述の StreamType 定数 を参照) ○ mediaTypeメディアタイプ(後述の MediaType 定数 を参照) ○ StreamType定数:table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 定数名 説明 VODビデオオンデマンドのストリームタイプ。 LIVELIVE コンテンツのストリームタイプ。 LINEARLINEAR コンテンツのストリームタイプ。 AODオーディオオンデマンドのストリームタイプ。 AUDIOBOOKオーディオブックのストリームタイプ。 PODCASTポッドキャストのストリームタイプ。 MediaType定数:table 0-row-2 1-row-2 2-row-2 定数名 説明 Audioオーディオストリームのメディアタイプ。 Videoビデオストリームのメディアタイプ。 code language-none var mediaObject = MediaHeartbeat.createMediaObject(<MEDIA_NAME>, <MEDIA_ID, <MEDIA_LENGTH>, MediaHeartbeat.StreamType.VOD, <MEDIA_TYPE>); -
メタデータのアタッチ
オプションで、コンテキストデータ変数を使用して標準またはカスタムメタデータオブジェクトをトラッキングセッションにアタッチします。
-
標準メタデータ
note note NOTE メディアオブジェクトへの標準メタデータオブジェクトのアタッチはオプションです。 -
メディアメタデータキー API リファレンス - 標準メタデータキー - JavaScript
利用可能なメタデータの包括的なセットについては、オーディオおよびビデオパラメーターを参照してください。
-
-
カスタムメタデータ
カスタム変数の変数オブジェクトを作成し、このメディアのデータを設定します。次に例を示します。
code language-js /* Set custom context data */ var customVideoMetadata = { isUserLoggedIn: "false", tvStation: "Sample TV station", programmer: "Sample programmer" };
-
-
意図を追跡して再生を開始
メディアセッションの追跡を開始するには、メディアハートビートインスタンスの
trackSessionStartを呼び出します。code language-js mediaHeartbeat.trackSessionStart(mediaObject, customVideoMetadata);note tip TIP 2 つ目の値は、手順 2 で作成した、カスタムのメディアメタデータオブジェクトの名前です。 note important IMPORTANT trackSessionStartでは、再生の開始ではなく、ユーザーの再生の意図を追跡します。この API は、データ/メタデータを読み込み、開始時間の QoS 指標(trackSessionStartとtrackPlayの間の時間)を見積もるために使用します。note note NOTE カスタムメタデータを使用しない場合は、前述の iOS の例でコメントアウトされている行に示されているように、 trackSessionStartのdata引数に空のオブジェクトを送信します。 -
実際の再生開始を追跡
再生開始(メディアの最初のフレームが画面に表示)に関するイベントをメディアプレーヤーから識別し、
trackPlayを呼び出します。code language-js mediaHeartbeat.trackPlay(); -
再生の完了を追跡
再生完了(ユーザーがコンテンツを最後まで視聴)に関するイベントをメディアプレーヤーから識別し、
trackCompleteを呼び出します。code language-js mediaHeartbeat.trackComplete(); -
セッションの終了を追跡
再生のアンロード/終了(ユーザーがメディアを閉じる、またはメディアが完了してアンロードされる)に関するイベントをメディアプレーヤーから識別し、
trackSessionEndを呼び出します。code language-js mediaHeartbeat.trackSessionEnd();note important IMPORTANT trackSessionEndは、トラッキングセッションの終わりをマークします。セッションが最後まで適切に視聴された場合(ユーザーがコンテンツを最後まで視聴)は、trackCompleteの前にtrackSessionEndを呼び出すようにしてください。trackSessionEndの後は、他のすべてのtrack*API 呼び出しは無視されます(新しいトラッキングセッション用のtrackSessionStartを除く)。 -
考えられるすべての一時停止シナリオを追跡
一時停止に関するイベントをメディアプレーヤーから識別し、
trackPauseを呼び出します。code language-js mediaHeartbeat.trackPause();一時停止のシナリオ
メディアプレーヤーが一時停止するあらゆるシナリオを識別して、
trackPauseが適切に呼び出されるようにします。以下のシナリオでは、アプリケーションでtrackPause()を呼び出す必要があります。- アプリ内でユーザーが明示的に一時停止をクリックする。
- プレーヤー自体が一時停止状態になる。
- (モバイルアプリケーション)- ユーザーがアプリケーションをバックグラウンドに移行した場合でも、アプリケーションのセッションを開いたままにしておきたい。
- (モバイルアプリケーション)- 何らかのシステムの割り込みが生じ、アプリケーションがバックグラウンドに移行する。例:ユーザーに電話がかかってきた場合や、別のアプリケーションのポップアップが表示された場合でも、アプリケーションのセッションを終了せず、ユーザーが中断した場所からメディアを再開できるようにしたい。
-
一時停止からの再生および再開に関するイベントをプレーヤーから識別し、
trackPlayを呼び出します。code language-js mediaHeartbeat.trackPlay();note tip TIP これは、手順 4 で使用したのと同じイベントソースである可能性があります。再生が再開される際に、各 trackPause()API 呼び出しが後続のtrackPlay()API 呼び出しと対になっていることを確認します。
- トラッキングのシナリオ:広告のない VOD 再生
- JavaScript SDK に含まれている、追跡の完全な例を示すサンプルプレーヤー。