このページでは、Analytics専用のJavaScript 3.x SDKについて説明します。 推奨される実装については、Edge Networkを使用したストリーミングメディアの実装を参照してください。
ADB.Media
静的メソッド
追跡用にMediaSDKを設定します。 このメソッドは、ページにトラッカーインスタンスを作成する前に1回呼び出す必要があります。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| 変数名 | タイプ | 説明 |
mediaConfig |
ADB.MediaConfig |
有効なメディア設定 |
appMeasurement |
オブジェクト | AppMeasurement インスタンス |
例
| code language-javascript |
|---|
|
再生セッションを追跡するメディアのインスタンスを作成します。 メディアを設定する前に呼び出された場合、nullを返します。
構文
| code language-javascript |
|---|
|
| table 0-row-4 1-row-4 1-align-left 2-align-left 3-align-center 4-align-left 6-align-left 7-align-left 8-align-center 9-align-left | |||
|---|---|---|---|
| 変数名 | タイプ | 必須 | 説明 |
trackerConfig |
トラッカー設定 | いいえ | トラッカー設定オブジェクト。 |
例
| code language-javascript |
|---|
|
トラッカーインスタンスごとにchannelまたはplayerNameを上書きするには、トラッカー設定オブジェクトで上書き値を渡します。
トラッカー設定の例
| code language-javascript |
|---|
|
メディア情報を含むオブジェクトを作成します。 無効なパラメーターが渡された場合は、空のオブジェクトを返します。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left 21-align-left 22-align-left 23-align-left | ||
|---|---|---|
| 変数名 | タイプ | 説明 |
name |
string | メディア名を示す空でない文字列 |
id |
string | 一意のメディア識別子を示す空でない文字列 |
length |
number | メディアの長さを秒単位で示す正の数。 長さが不明な場合は0を使用します。 |
streamType |
string | メディアストリームタイプを示すストリームタイプまたは空でない文字列。 |
mediaType |
メディアタイプ | メディアの種類(オーディオまたはビデオ) |
例
| code language-javascript |
|---|
|
アドブレーク情報を含むオブジェクトを作成します。 無効なパラメーターが渡された場合は、空のオブジェクトを返します。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left | ||
|---|---|---|
| 変数名 | タイプ | 説明 |
name |
string | アドブレーク名(プレロール、ミッドロール、ポストロール)を示す空でない文字列 |
position |
number | コンテンツ内の広告ブレークの位置(1から始まる) |
startTime |
number | 広告ブレーク開始時の再生ヘッド値 |
例
| code language-javascript |
|---|
|
広告情報を含むオブジェクトを作成します。 無効なパラメーターが渡された場合は、空のオブジェクトを返します。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left | ||
|---|---|---|
| 変数名 | タイプ | 説明 |
name |
string | 広告名を示す空でない文字列 |
id |
string | 広告IDを示す空でない文字列 |
position |
number | アドブレーク内の広告の位置(1から始まる) |
length |
number | 広告の長さを表す正の数 |
例
| code language-javascript |
|---|
|
章情報を含むオブジェクトを作成します。 無効なパラメーターが渡された場合は、空のオブジェクトを返します。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left | ||
|---|---|---|
| 変数名 | タイプ | 説明 |
name |
string | 章名を示す空でない文字列 |
position |
number | コンテンツ内の章の位置(1から始まる) |
length |
number | 章の長さを表す正の数 |
startTime |
number | チャプター開始時の再生ヘッド値 |
例
| code language-javascript |
|---|
|
状態情報を含むオブジェクトを作成します。 無効なパラメーターが渡された場合は、空のオブジェクトを返します。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left | ||
|---|---|---|
| 変数名 | タイプ | 説明 |
name |
string | プレーヤーの状態または空でない文字列(状態名を示す) |
例
| code language-javascript |
|---|
|
QoE情報を含むオブジェクトを作成します。 無効なパラメーターが渡された場合は、空のオブジェクトを返します。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left 17-align-left 18-align-left 19-align-left | ||
|---|---|---|
| 変数名 | タイプ | 説明 |
bitrate |
number | 現在のビットレートを示す正の数値(不明な場合は0) |
startupTime |
number | 起動時間を示す正の数値(不明な場合は0) |
fps |
number | 現在のfpsを示す正の数(不明な場合は0) |
droppedFrames |
number | ドロップされたフレームの数を示す正の数(不明な場合は0) |
例
| code language-javascript |
|---|
|
MediaSDK バージョンを返します。
構文
| code language-javascript |
|---|
|
例
| code language-javascript |
|---|
|
インスタンスメソッド
再生を開始する意図を追跡します。 これにより、メディアトラッカーインスタンスでトラッキングセッションが開始されます。 メディアの再開も参照してください。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 2-row-3 1-align-left 2-align-left 3-align-center 5-align-left 6-align-left 7-align-center 9-align-left 10-align-left 11-align-center | ||
|---|---|---|
| 変数名 | 説明 | 必須 |
mediaObject |
createMediaObject メソッドを使用して作成されたメディア情報。 |
はい |
contextData |
オプションのメディアコンテキストデータ: 標準メタデータキーの場合は、標準ビデオ定数または標準オーディオ定数を使用します。 | いいえ |
例
| code language-javascript |
|---|
|
前回の一時停止の後にメディアの再生または再開を追跡します。
構文
| code language-javascript |
|---|
|
例
| code language-javascript |
|---|
|
メディアの一時停止を追跡します。
構文
| code language-javascript |
|---|
|
例
| code language-javascript |
|---|
|
トラックメディアが完了しました。 このメソッドは、メディアが完全に表示された場合にのみ呼び出します。
構文
| code language-javascript |
|---|
|
例
| code language-javascript |
|---|
|
視聴セッションの終了を追跡します。 ユーザーが完了するメディアを表示しない場合でも、このメソッドを呼び出します。
構文
| code language-javascript |
|---|
|
例
| code language-javascript |
|---|
|
メディア再生のエラーを追跡します。
構文
| code language-javascript |
|---|
|
| table 0-row-3 1-row-3 1-align-left 2-align-left 3-align-center 5-align-left 6-align-left 7-align-center | ||
|---|---|---|
| 変数名 | 説明 | 必須 |
errorId |
エラー情報を含む空でない文字列 | はい |
例
| code language-javascript |
|---|
|
メディアイベントを追跡する方法。
| table 0-row-2 1-row-2 2-row-2 3-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left 10-align-left 11-align-left | |
|---|---|
| 変数名 | 説明 |
event |
メディアイベント |
info |
AdBreakStart イベントの場合、アドブレーク情報はcreateAdBreakObject メソッドを使用して作成されます。 AdStart イベントの場合、広告情報はcreateAdObject メソッドを使用して作成されます。 ChapterStart イベントの場合、章情報はcreateChapterObject メソッドを使用して作成されます。 StateStartおよびStateEnd イベントの場合、状態情報はcreateStateObject メソッドを使用して作成されます。 これは他のイベントでは必要ありません。 |
contextData |
AdStartおよびChapterStart イベントに対して、オプションのコンテキストデータを指定できます。 これは他のイベントでは必要ありません。 |
構文
| code language-javascript |
|---|
|
例
AdBreaksのトラッキング
| code language-javascript |
|---|
|
広告のトラッキング
| code language-javascript |
|---|
|
章のトラッキング
| code language-javascript |
|---|
|
状態のトラッキング
| code language-javascript |
|---|
|
再生イベントのトラッキング
| code language-javascript |
|---|
|
ビットレート変更のトラッキング
| code language-javascript |
|---|
|
現在のメディア再生ヘッドをメディアトラッカーに提供します。 正確なトラッキングを行うには、再生中に再生ヘッドが変更されるたびに、このメソッドを呼び出します。
構文
| code language-javascript |
|---|
|
| table 0-row-2 1-row-2 1-align-left 2-align-left 4-align-left 5-align-left | |
|---|---|
| 変数名 | 説明 |
time |
現在の再生ヘッド (秒単位)。 ビデオオンデマンド(VOD)の場合、値はメディア項目の先頭から秒単位で指定されます。 ライブストリーミングの場合、プレーヤーがコンテンツ時間に関する情報を提供しない場合、その日の午前0時UTCからの秒数として値を指定できます。 メモ:プログレスマーカーを使用する場合、コンテンツのデュレーションが必要です。また、再生ヘッドはメディアアイテムの先頭からの(0 から始まる)秒数で更新する必要があります。 |
例
| code language-javascript |
|---|
|
現在のQoE情報をメディアトラッカーに提供します。 正確なトラッキングを行うには、メディアプレーヤーが更新されたQoE情報を提供する際に、このメソッドを複数回呼び出します。
構文
| code language-javascript |
|---|
|
| table 0-row-2 1-row-2 1-align-left 2-align-left 4-align-left 5-align-left | |
|---|---|
| 変数名 | 説明 |
qoeObject |
createQoEObject メソッドを使用して作成された現在のQoE情報。 |
例
| code language-javascript |
|---|
|
トラッカーインスタンスを破棄します。
構文
| code language-javascript |
|---|
|
例
| code language-javascript |
|---|
|
定数
トラッカーインスタンスごとに設定できる設定キーを定義します。
| code language-javascript |
|---|
|
現在追跡されているメディアのタイプを定義します。
| code language-javascript |
|---|
|
現在追跡されているコンテンツのストリームタイプを定義します。
| code language-javascript |
|---|
|
ADB.Media.VideoMetadataKeys、ADB.Media.AudioMetadataKeysおよびADB.Media.AdMetadataKeysは、標準メタデータのコンテキストデータキー文字列を提供します。 キーとそれに対応するレポート変数の完全なリストについては、標準メタデータ変数リファレンス を参照してください。トラッキングイベントのタイプを定義します。
| code language-javascript |
|---|
|
プレーヤーの状態を追跡するための標準値を定義します。
| code language-javascript |
|---|
|
現在のトラッキングセッションが、以前に閉じられたセッションを再開していることを示す定数。 この情報は、トラッキングセッションを開始する際に提供する必要があります。
構文
| code language-javascript |
|---|
|
例
| code language-javascript |
|---|
|
ADB.MediaConfig
trackingServerchannelplayerNameappVersiondebugLoggingfalse)ssltrue)