Show Menu
TOPICS×

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

このドキュメントでは、バージョン 3.x の SDK でのトラッキングについて説明しています。If you are implementing any previous versions of the SDK, you can download the Developers Guides here: Download SDKs
  1. トラッキングの初期設定
    いつユーザーが再生の意図をトリガーする(ユーザーが再生をクリックする、または自動再生がオンになる)かを識別し、
    MediaObject
    インスタンスを作成します。
    変数名
    タイプ
    説明
    name
    string
    メディア名を示す空以外の文字列。
    id
    string
    一意のメディア識別子を示す空以外の文字列。
    length
    数値
    メディアの長さを秒単位で示す正の数です。 長さが不明な場合は0を使用します。
    streamType
    string
    # (streamType定数へのリンク)または空でない文字列。メディアストリームタイプを表します。
    mediaType
    # (MediaType定数へのリンク)
    メディアのタイプ(オーディオまたはビデオ)。
    StreamType
    定数:
    定数名
    説明  
    VOD
    ビデオオンデマンドのストリームタイプ。
    LIVE
    LIVE コンテンツのストリームタイプ。
    LINEAR
    LINEAR コンテンツのストリームタイプ。
    AOD
    オーディオオンデマンドのストリームタイプ。
    AUDIOBOOK
    オーディオブックのストリームタイプ。
    PODCAST
    ポッドキャストのストリームタイプ。
    MediaType
    定数:
    定数名
    説明
    Audio
    オーディオストリームのメディアタイプ。
    Video
    ビデオストリームのメディアタイプ。
    var mediaObject = ADB.Media.createMediaObject(<MEDIA_NAME>, <MEDIA_ID, <MEDIA_LENGTH>, <STREAM_TYPE>, <MEDIA_TYPE>);
  2. メタデータのアタッチ
    オプションで、コンテキストデータ変数を使用して、標準メタデータやカスタムメタデータをトラッキングセッションにアタッチできます。
    • 標準メタデータ
      標準メタデータの添付は任意です。
    • カスタムメタデータ
      カスタム変数の変数オブジェクトを作成し、このメディアのデータを設定します。例:
      /* Set context data */ var contextData = {}; //Standard metadata contextData[ADB.Media.VideoMetadataKeys.EPISODE] = "Sample Episode"; contextData[ADB.Media.VideoMetadataKeys.SHOW] = "Sample Show"; //Custom metadata contextData["isUserLoggedIn"] = "false"; contextData["tvStation"] = "Sample TV Station";
  3. 意図を追跡して再生を開始
    メディアセッションの追跡を開始するには、メディアハートビートインスタンスの
    trackSessionStart
    を呼び出します。
    var mediaObject = ADB.Media.createMediaObject("video-name", "video-id", 60.0, ADB.Media.StreamType.VOD, ADB.Media.MediaType.Video); var contextData = {}; //Standard metadata contextData[ADB.Media.VideoMetadataKeys.EPISODE] = "Sample Episode"; contextData[ADB.Media.VideoMetadataKeys.SHOW] = "Sample Show"; //Custom metadata contextData["isUserLoggedIn"] = "false"; contextData["tvStation"] = "Sample TV Station"; tracker.trackSessionStart(mediaObject, contextData);
    trackSessionStart
    では、再生の開始ではなく、ユーザーの再生の意図を追跡します。この API は、データ/メタデータを読み込み、開始時間の QoS 指標(
    trackSessionStart
    trackPlay
    の間の時間)を見積もるために使用します。
    If you are not using contextData, simply send an empty object for the
    data
    argument in
    trackSessionStart
    .
  4. 実際の再生開始を追跡
    再生開始(メディアの最初のフレームが画面に表示)に関するイベントをメディアプレーヤーから識別し、
    trackPlay
    を呼び出します。
    tracker.trackPlay();
  5. 再生の完了を追跡
    再生完了(ユーザーがコンテンツを最後まで視聴)に関するイベントをメディアプレーヤーから識別し、
    trackComplete
    を呼び出します。
    tracker.trackComplete();
  6. セッションの終了を追跡
    再生のアンロード/終了(ユーザーがメディアを閉じる、またはメディアが完了してアンロードされる)に関するイベントをメディアプレーヤーから識別し、
    trackSessionEnd
    を呼び出します。
    tracker.trackSessionEnd();
    trackSessionEnd
    は、トラッキングセッションの終わりをマークします。セッションが最後まで適切に視聴された場合(ユーザーがコンテンツを最後まで視聴)は、
    trackComplete
    の前に
    trackSessionEnd
    を呼び出すようにしてください。
    trackSessionEnd
    の後は、他のすべての
    track*
    API 呼び出しは無視されます(新しいトラッキングセッション用の
    trackSessionStart
    を除く)。
  7. 考えられるすべての一時停止シナリオを追跡
    一時停止に関するイベントをメディアプレーヤーから識別し、
    trackPause
    を呼び出します。
    tracker.trackPause();
    一時停止のシナリオ
    メディアプレーヤーが一時停止するあらゆるシナリオを識別して、
    trackPause
    が適切に呼び出されるようにします。以下のシナリオでは、アプリケーションで
    trackPause()
    を呼び出す必要があります。
    • アプリ内でユーザーが明示的に一時停止をクリックする。
    • プレーヤー自体が一時停止状態になる。
    • モバイルアプリケーション
      )- ユーザーがアプリケーションをバックグラウンドに移行した場合でも、アプリケーションのセッションを開いたままにしておきたい。
    • モバイルアプリケーション
      )- 何らかのシステムの割り込みが生じ、アプリケーションがバックグラウンドに移行する。例:ユーザーに電話がかかってきた場合や、別のアプリケーションのポップアップが表示された場合でも、アプリケーションのセッションを終了せず、ユーザーが中断した場所からメディアを再開できるようにしたい。
  8. 一時停止からの再生および再開に関するイベントをプレーヤーから識別し、
    trackPlay
    を呼び出します。
    tracker.trackPlay();
    これは、手順 4 で使用したのと同じイベントソースである可能性があります。再生が再開される際に、各
    trackPause()
    API 呼び出しが後続の
    trackPlay()
    API 呼び出しと対になっていることを確認します。
  • トラッキングのシナリオ: 広告のない VOD 再生
  • JavaScript SDK に含まれている、追跡の完全な例を示すサンプルプレーヤー。