Adobe Medium Analytics for Audio and Video擴充功能概觀
使用本文件來了解安裝、設定和實作 Adobe Media Analytics for Audio and Video 擴充功能 (Media Analytics 擴充功能) 的相關資訊其中包含使用此擴充功能來建立規則時可用的選項,以及範例和範例連結。
Media Analytics (MA) 擴充功能新增核心的 JavaScript Media SDK (Media 2.x SDK)。此擴充功能提供將MediaHeartbeat
追蹤器執行個體新增至標籤網站或專案的功能。 MA 擴充功能需要額外的擴充功能:
在標籤專案中納入上述的三個擴充功能後,您可以使用下列兩種方式之一繼續操作:
- 從您的網頁應用程式使用
MediaHeartbeat
API - 納入或建立播放器特定的擴充功能,此模組會將特定的媒體播放器事件對應到
MediaHeartbeat
追蹤器例項上的 API。此例項會透過 MA 擴充功能公開。
安裝並設定 MA 擴充功能
-
安裝 — 若要安裝MA擴充功能,請開啟您的擴充功能屬性,選取 擴充功能>目錄,將游標停留在 Adobe Medium Analytics for Audio and Video 擴充功能上,然後選取 安裝。
-
設定 — 若要設定MA擴充功能,請開啟擴充功能標籤,將游標暫留在擴充功能上,然後選取[設定] :
設定選項:
window
物件下 Media Analytics API 的變數提醒: MA 擴充功能需有 Analytics 和 Experience Cloud ID 擴充功能,才能正常運作。您也必須將這些擴充功能新增至擴充功能屬性並加以設定。
使用 MA 擴充功能
從網頁/JS 應用程式使用
MA擴充功能會啟用設定頁面中的「將API匯出至視窗物件」設定,以將MediaHeartbeat API匯出至全域視窗物件中。 這會以設定的變數名稱匯出 API。例如,如果變數名稱設定為 ADB
,則可使用 window.ADB.MediaHeartbeat
來存取 MediaHeartbeat。
window["CONFIGURED_VARIABLE_NAME"]
未定義時匯出 API,不會覆寫現有變數。-
建立 MediaHeartbeat 例項:
window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat.getInstance
參數: 有效的委派物件會顯示以下函數。
table 0-row-2 1-row-2 2-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left 方法 說明 getQoSObject()
傳回包含目前 QoS 資訊的 theMediaObject
例項。將在播放工作階段期間呼叫此方法多次。播放器實作必須一律傳回最新可用的 QoS 資料。getCurrentPlaybackTime()
傳回播放點的目前位置。對於 VOD 追蹤,該值是從媒體項目的開頭開始以秒為單位指定的。對於 LIVE/LIVE 追蹤,該值是從節目的開頭開始以秒為單位指定的。 傳回值: 一種 Promise,使用
MediaHeartbeat
例項解析,或拒絕並提供錯誤訊息。 -
存取 MediaHeartbeat 常數:
window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat
這會公開
MediaHeartbeat
類別中的所有常數和靜態方法。範例播放器可從這裡取得:MA 範例播放器。範例播放器可作為參考,以示範如何使用 MA 擴充功能直接從網路應用程式支援 Media Analytics。
-
建立 MediaHeartbeat 追蹤器例項,如下所示:
code language-javascript var MediaHeartbeat = window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat; var delegate = { getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this), getQoSObject: this._getQoSObject.bind(this), }; var config = { playerName: "Custom Player", ovp: "Custom OVP", channel: "Custom Channel" }; var self = this; MediaHeartbeat.getInstance(delegate, config).then(function(instance) { self._mediaHeartbeat = instance; // Do Tracking using the MediaHeartbeat instance. }).catch(function(err){ // Getting MediaHeartbeat instance failed. });
從其他擴充功能使用
MA 擴充功能會將 get-instance
模組和 media-heartbeat
共用模組公開至其他擴充功能(如需共用模組的其他資訊,請參閱共用模組文件)。
turbine
(請參閱下面的程式碼範例)。-
建立 MediaHeartbeat 例項:
get-instance
共用模組參數:
-
有效的委派物件會顯示以下函數:
table 0-row-2 1-row-2 2-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left 方法 說明 getQoSObject()
傳回包含目前 QoS 資訊的 MediaObject
例項。將在播放工作階段期間呼叫此方法多次。播放器實作必須一律傳回最新的可用 QoS 資料。getCurrentPlaybackTime()
傳回播放點的目前位置。對於 VOD 追蹤,該值是從媒體項目的開頭開始以秒為單位指定的。對於 LIVE/LIVE 追蹤,該值是從節目的開頭開始以秒為單位指定的。 -
選用的設定物件會顯示這些屬性:
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 屬性 說明 必填 Online Video Provider 線上視訊平台的名稱,透過該平台來分送內容。 否。如果存在,則會在擴充功能設定期間覆寫定義的值。 Player Name 使用的媒體播放器名稱 (例如:「AVPlayer」、「HTML5 播放器」、「我的自訂視訊播放器」) 否。如果存在,則會在擴充功能設定期間覆寫定義的值。 Channel 管道名稱屬性 否。如果存在,則會在擴充功能設定期間覆寫定義的值。
傳回值: 一種 Promise,使用
MediaHeartbeat
例項解析,或拒絕並提供錯誤訊息。 -
-
存取 MediaHeartbeat 常數:
media-heartbeat
共用模組此模組會公開此類別中所有的常數和靜態方法:https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript/MediaHeartbeat.html。
-
建立 MediaHeartbeat 追蹤器例項,如下所示:
code language-javascript var getMediaHeartbeatInstance = turbine.getSharedModule('adobe-video-analytics', 'get-instance'); var MediaHeartbeat = turbine.getSharedModule('adobe-video-analytics', 'media-heartbeat'); ... var delegate = { getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this), getQoSObject: this._getQoSObject.bind(this), } var config = { playerName: "Custom Player", ovp: "Custom OVP", channel: "Custom Channel" } ... var self = this; getMediaHeartbeatInstance(delegate, config).then(function(instance) { self._mediaHeartbeat = instance; ... // Do Tracking using the MediaHeartbeat instance. }).catch(function(err){ // Getting MediaHeartbeat instance failed. }); ...
-
使用 Media Heartbeat 例項,並按照 Media SDK JS 文件和 JS API 文件 中的說明來實作媒體追蹤功能。