使用Adobe Experience Platform Web SDK将Web数据发送到Edge
从版本2.20.0开始,Adobe Experience Platform Web SDK的streamingMedia
组件允许您收集与网站上的媒体会话相关的数据。 收集的数据可以包括有关媒体回放、暂停、完成和其他相关事件的信息。
收集数据后,您可以将其发送到Adobe Experience Platform和/或Adobe Analytics以生成报表。 此功能为跟踪和了解您网站上的媒体消费行为提供了全面的解决方案。
对于使用Media JS SDK的客户,Web SDK提供了从Media JS SDK迁移到Web SDK的迁移路径,同时包括对现有Media JS功能(如处理媒体事件)的支持。
先决条件 prerequisites
要使用Web SDK的streamingMedia
组件,您必须满足以下先决条件:
- 在将流媒体数据发送到Edge之前,请先完成使用Experience PlatformEdge安装流媒体收集加载项中的步骤。
- 确保您有权访问Adobe Experience Platform和/或Adobe Analytics。
- 您必须使用Web SDK版本2.20.0或更高版本。 请参阅Web SDK安装概述,了解如何安装最新版本。
- 为您正在使用的数据流启用 Media Analytics 选项。
- 确保数据流使用的架构包括媒体收集架构字段。
- 通过标记扩展或通过JavaScript库在Web SDK配置中配置流媒体功能,如本页所示。
按照本页中描述的步骤,将您的流媒体收集加载项实施从Media JS迁移到Web SDK。
步骤1:安装Experience PlatformWeb SDK
请参阅专用文档,了解如何在Web属性上安装Web SDK。
步骤2:配置Web SDK streamingMedia
组件。
示例
以下代码片段显示了如何在Media JS中配置媒体收集。
var mediaConfig = new ADB.MediaConfig();
mediaConfig.trackingServer = "company.hb-api.omtrdc.net";
mediaConfig.playerName = "player_name";
mediaConfig.channel = "sample_channel";
mediaConfig.appVersion = "app_version";
mediaConfig.debugLogging = true;
mediaConfig.ssl = true;
ADB.Media.configure(mediaConfig, appMeasurement);
相反,您必须按照以下示例在Web SDK中配置streamingMedia
组件。
alloy("configure", {
streamingMedia: {
channel: "sample_channel",
playerName: "player_name",
appVersion: "app_version",
mainPingInterval: 10,
adPingInterval: 10
}
});
有关如何配置Web SDK streamingMedia
组件的完整详细信息,请参阅文档。
步骤3:从Media JS SDK迁移时获取媒体跟踪器实例
对于使用Media JS SDK的客户,Web SDK提供了从Media JS SDK迁移到Web SDK的迁移路径,同时包括对现有Media JS功能(如处理媒体事件)的支持。
Web SDK包含用于检索Media Analytics跟踪器的命令。 您可以使用此命令创建对象实例,然后使用与媒体JS库提供的API相同的API跟踪媒体事件。
有关受支持方法的完整详细信息,请参阅getMediaAnalyticsTracker
文档。
以下代码片段显示了如何在Media JS中检索媒体跟踪器实例。
var tracker = ADB.Media.getInstance();
请改用Web SDK中的getMediaAnalyticsTracker
命令以获得相同的结果,如下所示。
// aquire Media Analytics APIs
const Media = await window.alloy("getMediaAnalyticsTracker", {});
// create a media tracker instance
const trackerInstance = Media.getInstance();
所有帮助程序方法将在Media
对象上可用。 跟踪器方法在tracker实例上可用,如下所示。
const mediaInfo = Media.createMediaObject(
"video name",
"player video",
60,
Media.StreamType.VOD,
Media.MediaType.Video
);
const contextData = {
isUserLoggedIn: "false",
tvStation: "Sample TV station",
programmer: "Sample programmer",
assetID: "/uri-reference"
};
// Set standard Video Metadata
contextData[Media.VideoMetadataKeys.Episode] = "Sample Episode";
contextData[Media.VideoMetadataKeys.Show] = "Sample Show";
trackerInstance.trackSessionStart(mediaInfo, contextData);