文件Analytics串流媒體收集指南

播放器狀態參數 player-state-parameters

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：

建立對象：

  • 使用者
  • 管理員
  • 開發人員

此主題提供 Adobe 透過解決方案變數收集的播放器狀態資料清單。

表格資料說明:

  • 實施： ​實施數值和需求的資訊

    • 索引鍵 - 在您的應用程式中手動設定，或由 Adobe Media SDK 自動設定的變數。
    • 必要 - 指出基本影片追蹤是否需要參數。
    • 類型 - 指明預計設定的變數類型 (字串或數字)。
    • 「伴隨傳送」- 指出資料傳送的時間:「媒體開始」 ​為媒體開始時傳送的分析呼叫、「廣告開始」 ​為廣告開始時傳送的分析呼叫等等；「關閉」 ​呼叫為媒體工作階段結束或廣告、章節等項目結束時，直接從心率伺服器傳送到分析伺服器的已編譯分析呼叫。網路封包呼叫中使用無法使用關閉呼叫。
    • 最小SDK 版本 - 指出您存取參數所需的 SDK 版本。
    • 樣本值 - 提供常見的變數使用方法範例。

  • 網路參數： ​顯示傳遞至 Adobe Analytics 或心率伺服器的數值。本欄顯示可於網路呼叫中看到，且由 Adobe Media SDK 產生的參數名稱。

  • 報表： ​關於如何檢視和分析影片資料的資訊。

    • 可用 - 指出資料是否已由報表預設提供 (是)，或是需要自行設定 (自訂)
    • 保留變數 - 指出資料在保留變數中是否被當作事件、eVar、prop 或分類擷取。
    • 報表名稱 - 適用於變數的 Adobe Aanlytics 報表名稱
    • 內容資料 - 傳遞至報表伺服器以及用於處理規則的 Adobe Aanlytics 內容資料名稱。
    • 資料摘要 - 可在 Clickstream 或 Live Stream 資料摘要中找到的變數欄名稱
    • Audience Manager - Adobe Audience Manager 中的特徵名稱
IMPORTANT
請勿變更下列任何變數的分類名稱，其說明以「分類」形式顯示於「報表/保留變數」下方。
為媒體追蹤啟用報表套裝時，系統會定義媒體分類。Adobe 有時會新增屬性，而發生這種情形時，客戶必須重新啟用其報表套裝才能存取新的媒體屬性。在更新程序期間，Adobe 會檢查變數名稱，藉此決定是否啟用分類。如果有任何變數名稱遺失，Adobe 會再次新增遺失的項目。

播放器狀態屬性 player-state-properties

播放器狀態追蹤功能可附加至音訊或影片資料流。標準化的播放器狀態追蹤量度會儲存為解決方案變數。標準狀態為：fullscreen、mute、closedCaptioning、pictureInPicture 和 inFocus。

全螢幕屬性

受全螢幕影響的資料流

實施
網路參數
報表
  • SDK 索引鍵
    自動設定
  • API 索引鍵
    不適用
  • 必要
    否
  • 類型
    數字
  • 伴隨傳送
    媒體關閉
  • 最小SDK 版本
    3.0
  • 樣本值
    TRUE
  • 說明
    ​受全螢幕影響的資料流數量。只有在播放工作階段期間發生至少一個全螢幕狀態時，此量度才會設為 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。
    重要
    若此事件已設定，則次數等於影片處於全螢幕狀態的次數。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則時間等於影片處於全螢幕狀態的時間長度。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則唯一可能的值為 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。
    重要
    若此事件已設定，則次數等於影片處於隱藏式字幕狀態的次數。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則時間等於影片處於隱藏式字幕狀態的時間。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則唯一可能的值為 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。
    重要
    若此事件已設定，則次數等於影片處於靜音狀態的次數。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則時間等於影片處於靜音狀態的時間。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則唯一可能的值為 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。
    重要
    若此事件已設定，則次數等於影片處於子母畫面狀態的次數。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則時間等於影片處於子母畫面狀態的時間。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則唯一可能的值為 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。
    重要
    若此事件已設定，則次數等於影片處於觀看中狀態的次數。若此事件未設定，則不會傳送值。
  • 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。
    重要
    若此事件已設定，則時間等於影片處於觀看中狀態的時間。若此事件未設定，則不會傳送值。
  • 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