プレーヤーステートパラメーター player-state-parameters

このトピックでは、ソリューション変数を介してアドビが収集するプレーヤーステートデータのリストを紹介します。

表のデータの説明は次のとおりです。

  • 実装: ​実装に関する値と要件の詳細。

    • キー - 変数。アプリで手動で設定するか、Adobe Media SDK によって自動的に設定されます。
    • 必須  - 基本的なビデオトラッキングでパラメーターが必須かどうかを表します。
    • - 設定する変数の型(文字列または数値)を表します。
    • 送信タイミング - データが送信されるタイミング。メディア開始 ​の場合はメディアの開始時に分析の呼び出しが送信され、広告開始 ​の場合は広告の開始時に分析の呼び出しが送信されます。終了 ​の場合は、メディアセッションや広告、チャプターなどの終了時に、コンパイル済みの分析の呼び出しがハートビートサーバーから分析サーバーに直接送信されます。終了の呼び出しは、ネットワークパケットの呼び出しでは利用できません。
    • 最小のSDK のバージョン - パラメーターにアクセスするのに必要な SDK のバージョン。
    • 値の例  - 変数の一般的な利用方法の例。
  • ネットワークパラメーター: Adobe Analytics またはハートビートサーバーに渡される値。この列には、Adobe Media SDK によって生成されるネットワーク呼び出しに含まれるパラメーターの名前が示されています。

  • レポート: ​ビデオデータの確認方法と分析方法に関する詳細。

    • 利用可能 - デフォルトでもデータをレポートで確認できる場合は​ 、カスタム設定が必要な場合は​ カスタム
    • 予約変数  - 予約変数で取得されるデータの形式(イベント、eVar、prop または分類)。
    • レポート名  - Adobe Aanlytics の変数のレポート名。
    • コンテキストデータ  - レポートサーバーに渡され、処理ルールで使用される Adobe Analytics のコンテキストデータの名前。
    • データフィード  - クリックストリームまたはライブストリームデータフィード内の変数の列の名前。
    • Audience Manager  - Adobe Audience Manager 内の特性名。
IMPORTANT
以下にリストされている変数で、レポート/予約変数に「分類」と説明されている変数の分類名を変更しないでください。
メディア分類は、レポートスイートでメディアトラッキングが有効にされる際に定義されます。アドビは新しいプロパティを追加することがありますが、その場合、新しいメディアプロパティにアクセスするには、レポートスイートを再有効化する必要があります。更新処理の際に、アドビは、変数の名前をチェックすることで、分類が有効にされているかどうかを判別します。見つからない変数名がある場合、アドビは、分類を再追加します。

プレーヤーステートプロパティ player-state-properties

プレーヤーステートトラッキング機能は、オーディオまたはビデオストリームにアタッチできます。標準化されたプレーヤーステートトラッキング指標は、ソリューション変数として保存されます。標準の状態は、fullscreen、mute、closedCaptioning、pictureInPicture、inFocus です。

フルスクリーンプロパティ

全画面表示の影響を受けたストリーム

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​フルスクリーンの影響を受けたストリームの数。この指標は、再生セッション中にフルスクリーンステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定すると、値は TRUE のみになります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.fullscreen.set
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​フルスクリーンの影響を受けたストリーム
  • コンテキストデータ:
    a.media.states.fullscreen.set
  • データフィード
    videostatefullscreen
  • Audience Manager:
    c_contextdata.a.media.states.fullscreen.set
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateSet
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.isSet

フルスクリーンの回数

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​フルスクリーンが表示された回数。この指標は、再生セッション中にフルスクリーンステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要:
    ​このイベントを設定した場合、カウントは、ビデオがフルスクリーンステートだった回数と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.fullscreen.count
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​フルスクリーンの回数
  • コンテキストデータ:
    a.media.states.fullscreen.count
  • データフィード
    videostatefullscreencount
  • Audience Manager:
    c_contextdata.media.states.fullscreen.count
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateCount
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.count

全画面表示時間合計

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​フルスクリーンが表示された時間の長さ。この指標は、再生セッション中にフルスクリーンステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要:
    ​このイベントを設定した場合、時間はビデオがフルスクリーンステートだった期間と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.fullscreen.time
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​フルスクリーンの時間合計
  • コンテキストデータ:
    a.media.states.fullscreen.time
  • データフィード
    videostatefullscreentime
  • Audience Manager:
    c_contextdata.media.states.fullscreen.time
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateTime
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.time

クローズドキャプションのプロパティ

クローズドキャプションの影響を受けたストリーム

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​クローズドキャプションの影響を受けたストリームの数。この指標は、再生セッション中にクローズドキャプションステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定すると、値は TRUE のみになります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.closedcaptioning.set
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​クローズドキャプションの影響を受けたストリーム
  • コンテキストデータ:
    a.media.states.closedcaptioning.set
  • データフィード
    videostateclosedcaptioning
  • Audience Manager:
    c_contextdata.a.media.states.
    closedcaptioning.set
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateSet
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.isSet

クローズドキャプションの回数

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​クローズドキャプションが表示された回数。この指標は、再生セッション中にクローズドキャプションステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    ​このイベントを設定した場合、カウントは、ビデオがクローズドキャプションステートだった回数と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.closedcaptioning.count
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​クローズドキャプションの回数
  • コンテキストデータ:
    a.media.states.closedcaptioning.count
  • データフィード
    videostateclosedcaptioningcount
  • Audience Manager:
    c_contextdata.media.states.
    closedcaptioning.count
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateCount
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.count

クローズドキャプション時間合計

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​クローズドキャプションが表示された時間の長さ。この指標は、再生セッション中にフルスクリーンステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要:
    ​このイベントを設定した場合、時間は、ビデオがクローズドキャプションステートであった期間と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.closedcaptioning.time
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​クローズドキャプションの時間合計
  • コンテキストデータ:
    a.media.states.closedcaptioning.time
  • データフィード
    videostateclosedcaptioningtime
  • Audience Manager:
    c_contextdata.media.states.
    closedcaptioning.time
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateTime
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.time

ミュートのプロパティ

ミュートの影響を受けたストリーム

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明:
    ​ミュートの影響を受けたストリームの数。この指標は、再生セッション中にミュートステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定すると、値は TRUE のみになります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.mute.set
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​ミュートの影響を受けたストリーム
  • コンテキストデータ:
    a.media.states.mute.set
  • データフィード
    videostatemute
  • Audience Manager:
    c_contextdata.a.media.states.mute.set
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    mute.playerStateSet
  • < レポート XDM フィールドのパス:
    mediaReporting.playerStateData.isSet

ミュートの回数

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​ミュートが表示された回数。この指標は、再生セッション中にミュートステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要:
    ​このイベントを設定した場合、カウントは、ビデオがミュートステートだった回数と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.mute.count
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​ミュートの回数
  • コンテキストデータ:
    a.media.states.mute.count
  • データフィード
    videostatemutecount
  • Audience Manager:
    c_contextdata.media.states.mute.count
  • XDM フィールドパス
    :media.mediaTimed.primaryAssetViewDetails.mute.playerStateCount
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.count

ミュート時間合計

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​ミュートが表示された時間の長さ。この指標は、再生セッション中にミュートステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要:
    ​このイベントを設定した場合、時間はビデオがミュートステートにあった期間と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.mute.time
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​ミュートの合計期間
  • コンテキストデータ:
    a.media.states.mute.time
  • データフィード
    videostatemutetime
  • Audience Manager:
    c_contextdata.media.states.mute.time
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    mute.playerStateTime
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.time

ピクチャーインピクチャーのプロパティ

ピクチャーインピクチャーの影響を受けたストリーム

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明:
    ​ピクチャーインピクチャーの影響を受けたストリームの数。この指標は、再生セッション中にピクチャーインピクチャー設定ステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定すると、値は TRUE のみになります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.pictureinpicture.set
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​ピクチャーインピクチャーの影響を受けたストリーム
  • コンテキストデータ:
    a.media.states.pictureinpicture.set
  • データフィード
    videostatepictureinpicture
  • Audience Manager:
    c_contextdata.a.media.states.
    pictureinpicture.set
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateSet
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.isSet

ピクチャーインピクチャーの回数

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​ピクチャーインピクチャーが表示された回数。この指標は、再生セッション中にピクチャーインピクチャー設定ステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定した場合、カウントは、ビデオがピクチャインピクチャステートだった回数と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.pictureinpicture.count
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​ピクチャーインピクチャーの回数
  • コンテキストデータ:
    a.media.states.pictureinpicture.count
  • データフィード
    videostatepictureinpicturecount
  • Audience Manager:
    c_contextdata.media.states.
    pictureinpicture.count
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateCount
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.count

ピクチャーインピクチャーの時間合計

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​ピクチャーインピクチャーが表示された時間の長さ。この指標は、再生セッション中にピクチャーインピクチャー設定ステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定した場合、時間は、ビデオがピクチャインピクチャステートにあった期間と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.pictureinpicture.time
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​ピクチャーインピクチャーの時間合計
  • コンテキストデータ:
    a.media.states.pictureinpicture.time
  • データフィード
    videostatepictureinpicturetime
  • Audience Manager:
    c_contextdata.media.states.
    pictureinpicture.time
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateTime
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.time

フォーカス設定のプロパティ

フォーカス設定の影響を受けたストリーム

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明:
    ​フォーカス設定の影響を受けたストリームの数。この指標は、再生セッション中にフォーカス設定ステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定すると、値は TRUE のみになります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.infocus.set
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​フォーカス設定の影響を受けたストリーム
  • コンテキストデータ:
    a.media.states.infocus.set
  • データフィード
    videostateinfocus
  • Audience Manager:
    c_contextdata.a.media.states.infocus.set
  • XDM フィールドパス
    :media.mediaTimed.primaryAssetViewDetails.inFocus.playerStateSet
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.isSet

フォーカス設定回数

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​フォーカス設定が表示された回数。この指標は、再生セッション中にフォーカス設定ステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    ​このイベントを設定した場合、カウントは、ビデオがフォーカス設定ステートだった回数と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.infocus.count
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​フォーカス設定の回数
  • コンテキストデータ:
    a.media.states.infocus.count
  • データフィード
    videostateinfocuscount
  • Audience Manager:
    c_contextdata.media.states.infocus.count
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    inFocus.playerStateCount
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.count

フォーカス設定時間合計

実装
ネットワークパラメーター
レポート
  • SDK キー
    ​自動設定
  • API キー
    ​なし
  • 必須
    ​いいえ

  • ​数値
  • 送信タイミング
    ​メディアの終了
  • 最小のSDK のバージョン
    3.0
  • 値の例
     TRUE
  • 説明
    ​フォーカス設定が表示された時間の長さ。この指標は、再生セッション中にフォーカス設定ステートが 1 回以上発生した場合にのみ、1 に設定されます。
    重要
    このイベントを設定した場合、時間はビデオがフォーカス設定ステートにあった期間と等しくなります。このイベントを設定しない場合は、値が送信されません。
  • Adobe Analytics:
    a.media.states.infocus.time
  • ハートビート
    ​該当なし
  • 利用可能:
    ​可
  • 予約変数:
    ​イベント
  • レポート名
    ​フォーカス設定の時間合計
  • コンテキストデータ:
    a.media.states.infocus.time
  • データフィード
    videostateinfocustime
  • Audience Manager:
    c_contextdata.media.states.infocus.time
  • XDM フィールドのパス
    :media.mediaTimed.primaryAssetViewDetails.
    inFocus.playerStateTime
  • レポート XDM フィールドのパス:
    mediaReporting.playerStateData.time

関連する API related_apis_section

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb