このドキュメントでは、バージョン 2.x の SDK でのトラッキングについて説明しています。
1.x バージョンの SDK を実装する場合は、1.x の開発ガイドをこちら(SDK のダウンロード)からダウンロードできます。
トラッキングの初期設定
いつユーザーが再生の意図をトリガーする(ユーザーが再生をクリックする、または自動再生がオンになる)かを識別し、MediaObject
インスタンスを作成します。
MediaObject
API リファレンス:
mediaObject = ADBMobile.media.createMediaObject(<name>, <id>, <duration>, <streamType>, <mediaType>);
StreamType
定数:
MediaType
定数:
ビデオメタデータのアタッチ
オプションで、コンテキストデータ変数を使用して標準またはカスタムのビデオメタデータオブジェクトをビデオトラッキングセッションにアタッチします。
標準のビデオメタデータ
メディアオブジェクトへの標準のビデオメタデータオブジェクトのアタッチはオプションです。
カスタムメタデータ
カスタム変数の変数オブジェクトを作成し、このビデオのデータを設定します。次に例を示します。
/* Set custom context data */
var customVideoMetadata = {
isUserLoggedIn: "false",
tvStation: "Sample TV station",
programmer: "Sample programmer"
};
意図を追跡して再生を開始
メディアセッションの追跡を開始するには、media
オブジェクトの trackSessionStart を呼び出します。
ADBMobile.media.trackSessionStart(mediaObject, customVideoMetadata);
trackSessionStart
では、再生の開始ではなく、ユーザーの再生の意図を追跡します。この API は、ビデオのデータ/メタデータを読み込み、開始時間の QoS 指標(trackSessionStart
と trackPlay
の間の時間)を見積もるために使用します。
2 つ目の値は、手順 2 で作成した、カスタムのビデオメタデータオブジェクトの名前です。カスタムのビデオメタデータを使用しない場合は、前述の iOS の例でコメントアウトされている行に示されているように、trackSessionStart
の data
引数に空のオブジェクトを送信します。
実際の再生開始を追跡
ビデオの再生開始(ビデオの最初のフレームが画面に表示)に関するイベントをビデオプレーヤーから識別し、trackPlay を呼び出します。
ADBMobile.media.trackPlay();
再生ヘッド値を更新
再生ヘッドが変更されたときは、mediaUpdatePlayhead
の位置の値を複数回更新します。
ビデオオンデマンド(VOD)の場合、値はメディアアイテムの開始時からの秒数で指定されます。
ライブストリーミングでは、プレーヤーがコンテンツのデュレーションに関する情報を提供しない場合、その日の午前0時(UTC)からの秒数を指定できます。
メモ:プログレスマーカーを使用する場合、コンテンツのデュレーションが必要です。また、再生ヘッドはメディアアイテムの開始時からの(0 から始まる)秒数で更新する必要があります。
ADBMobile().mediaUpdatePlayhead(position)
再生の完了を追跡
ビデオの再生完了(ユーザーがコンテンツを最後まで視聴)に関するイベントをビデオプレーヤーから識別し、trackComplete を呼び出します。
ADBMobile.media.trackComplete();
セッションの終了を追跡
ビデオ再生のアンロード/終了(ユーザーがビデオを閉じる、またはビデオの再生が完了してアンロードされる)に関するイベントをビデオプレーヤーから識別し、trackSessionEnd を呼び出します。
ADBMobile.media.trackSessionEnd();
trackSessionEnd
は、ビデオトラッキングセッションの終わりをマークします。セッションが最後まで適切に視聴された場合(ユーザーがコンテンツを最後まで視聴)は、trackComplete
の前に trackSessionEnd
を呼び出すようにしてください。trackSessionEnd
の後は、他のすべての track*
API 呼び出しは無視されます(新しいビデオトラッキングセッション用の trackSessionStart
を除く)。
考えられるすべての一時停止シナリオを追跡
ビデオの一時停止に関するイベントをビデオプレーヤーから識別し、trackPause を呼び出します。
ADBMobile.media.trackPause();
一時停止のシナリオ
ビデオプレーヤーが一時停止するあらゆるシナリオを識別して、trackPause
が適切に呼び出されるようにします。以下のシナリオでは、アプリで trackPause()
() を呼び出す必要があります。
一時停止からのビデオ再生およびビデオ再開に関するイベントをプレーヤーから識別し、trackPlay を呼び出します。
ADBMobile.media.trackPlay();
これは、手順 4 で使用したのと同じイベントソースである可能性があります。ビデオ再生が再開される際に、各 trackPause()
API 呼び出しが後続の trackPlay()
API 呼び出しと対になっていることを確認します。