JavaScript 2.x を使用したコア再生の追跡

トラッキングの初期設定

いつユーザーが再生の意図をトリガーする（ユーザーが再生をクリックする、または自動再生がオンになる）かを識別し、MediaObject インスタンスを作成します。

createMediaObject API

StreamType定数：

MediaType定数：

var mediaObject =
  MediaHeartbeat.createMediaObject(<MEDIA_NAME>,
                                  <MEDIA_ID,
                                  <MEDIA_LENGTH>,
                                  MediaHeartbeat.StreamType.VOD,
                                  <MEDIA_TYPE>);

メタデータのアタッチ

オプションで、コンテキストデータ変数を使用して標準またはカスタムメタデータオブジェクトをトラッキングセッションにアタッチします。

• 標準メタデータ

  JavaScript での標準メタデータの実装

  NOTE

  メディアオブジェクトへの標準メタデータオブジェクトのアタッチはオプションです。

  • メディアメタデータキー API リファレンス - 標準メタデータキー - JavaScript

    利用可能なメタデータの包括的なセットについては、オーディオおよびビデオパラメーターを参照してください。

• カスタムメタデータ

  カスタム変数の変数オブジェクトを作成し、このメディアのデータを設定します。次に例を示します。

  /* Set custom context data */
  var customVideoMetadata = {
      isUserLoggedIn: "false",
      tvStation: "Sample TV station",
      programmer: "Sample programmer"
  };
  

意図を追跡して再生を開始

メディアセッションの追跡を開始するには、メディアハートビートインスタンスの trackSessionStart を呼び出します。

mediaHeartbeat.trackSessionStart(mediaObject, customVideoMetadata);

TIP

2 つ目の値は、手順 2 で作成した、カスタムのメディアメタデータオブジェクトの名前です。

IMPORTANT

trackSessionStart では、再生の開始ではなく、ユーザーの再生の意図を追跡します。この API は、データ／メタデータを読み込み、開始時間の QoS 指標（trackSessionStart と trackPlay の間の時間）を見積もるために使用します。

NOTE

カスタムメタデータを使用しない場合は、前述の iOS の例でコメントアウトされている行に示されているように、trackSessionStart の data 引数に空のオブジェクトを送信します。

実際の再生開始を追跡

再生開始（メディアの最初のフレームが画面に表示）に関するイベントをメディアプレーヤーから識別し、trackPlay を呼び出します。

mediaHeartbeat.trackPlay();

再生の完了を追跡

再生完了（ユーザーがコンテンツを最後まで視聴）に関するイベントをメディアプレーヤーから識別し、trackComplete を呼び出します。

mediaHeartbeat.trackComplete();

セッションの終了を追跡

再生のアンロード／終了（ユーザーがメディアを閉じる、またはメディアが完了してアンロードされる）に関するイベントをメディアプレーヤーから識別し、trackSessionEnd を呼び出します。

mediaHeartbeat.trackSessionEnd();

IMPORTANT

trackSessionEnd は、トラッキングセッションの終わりをマークします。セッションが最後まで適切に視聴された場合（ユーザーがコンテンツを最後まで視聴）は、trackComplete の前に trackSessionEnd を呼び出すようにしてください。trackSessionEnd の後は、他のすべての track* API 呼び出しは無視されます（新しいトラッキングセッション用の trackSessionStart を除く）。

考えられるすべての一時停止シナリオを追跡

一時停止に関するイベントをメディアプレーヤーから識別し、trackPause を呼び出します。

mediaHeartbeat.trackPause();

一時停止のシナリオ

メディアプレーヤーが一時停止するあらゆるシナリオを識別して、trackPause が適切に呼び出されるようにします。以下のシナリオでは、アプリケーションで trackPause() を呼び出す必要があります。

• アプリ内でユーザーが明示的に一時停止をクリックする。
• プレーヤー自体が一時停止状態になる。
• （モバイルアプリケーション）- ユーザーがアプリケーションをバックグラウンドに移行した場合でも、アプリケーションのセッションを開いたままにしておきたい。
• （モバイルアプリケーション）- 何らかのシステムの割り込みが生じ、アプリケーションがバックグラウンドに移行する。例：ユーザーに電話がかかってきた場合や、別のアプリケーションのポップアップが表示された場合でも、アプリケーションのセッションを終了せず、ユーザーが中断した場所からメディアを再開できるようにしたい。

一時停止からの再生および再開に関するイベントをプレーヤーから識別し、trackPlay を呼び出します。

mediaHeartbeat.trackPlay();

TIP

これは、手順 4 で使用したのと同じイベントソースである可能性があります。再生が再開される際に、各 trackPause() API 呼び出しが後続の trackPlay() API 呼び出しと対になっていることを確認します。