媒体下载标志

本页介绍​ Media downloaded flag ​变量的数据收集。 查看相应报表维度的下载的媒体

媒体已下载标记指示会话是先前下载的离线内容的播放,而不是来自Internet的实时流的播放。 在初始化跟踪器(Mobile SDK)时设置它,或将其包含在sessionStart有效负载(Edge/媒体收集API)中。 使用此标记可在报告中将离线播放与流式处理会话分开。

属性
上下文数据变量
a.media.downloaded
XDM集合字段
xdm.mediaCollection.sessionDetails.isDownloaded
Audience Manager特征
c_contextdata.a.media.downloaded
必需
发送条件
会话开始,会话关闭

建议的实施类型

Web SDK

调用sendEvent时,在xdm.mediaCollection.sessionDetails内将isDownloaded设置为true

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        name: "video-123",
        length: 128,
        contentType: "vod",
        playerName: "HTML5 Player",
        channel: "Sports",
        streamType: "video",
        isDownloaded: true
      },
      playhead: 0
    }
  }
});
iOS

使用MediaConstants.TrackerConfig.DOWNLOADED_CONTENT创建跟踪器时,在跟踪器配置中设置下载内容标志。

code language-swift
var config: [String: Any] = [:]
config[MediaConstants.TrackerConfig.PLAYER_NAME] = "HTML5 Player"
config[MediaConstants.TrackerConfig.CHANNEL] = "Sports"
config[MediaConstants.TrackerConfig.DOWNLOADED_CONTENT] = true

Media.createTrackerWith(config: config) { tracker in
    self.tracker = tracker
}
Android

使用MediaConstants.TrackerConfig.DOWNLOADED_CONTENT创建跟踪器时,在跟踪器配置中设置下载内容标志。

code language-kotlin
val config = HashMap<String, Any>()
config[MediaConstants.TrackerConfig.PLAYER_NAME] = "HTML5 Player"
config[MediaConstants.TrackerConfig.CHANNEL] = "Sports"
config[MediaConstants.TrackerConfig.DOWNLOADED_CONTENT] = true

val tracker = Media.createTracker(config)
Roku

调用createMediaSession时,在xdm.mediaCollection.sessionDetails内将isDownloaded设置为true

code language-brightscript
m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "name": "video-123",
                "length": 128,
                "contentType": "vod",
                "playerName": "Roku Player",
                "channel": "Sports",
                "streamType": "video",
                "isDownloaded": true
            },
            "playhead": 0
        }
    }
})
Media Edge API

在设备返回联机状态后调用已下载终结点,在mediaDownloadedEvents内批量处理完整的脱机会话。 Adobe自动将isDownloaded设置为true并分配会话ID;请勿在有效负载中包含任一会话ID。

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.downloaded",
      "mediaDownloadedEvents": [
        {
          "mediaEventTimestamp": "YYYY-09-26T15:52:24+00:00",
          "mediaEventType": "media.sessionStart",
          "mediaCollection": {
            "sessionDetails": {
              "name": "video-123",
              "length": 128,
              "contentType": "vod",
              "playerName": "HTML5 Player",
              "channel": "Sports"
            },
            "playhead": 0
          }
        },
        {
          "mediaEventTimestamp": "YYYY-09-26T15:54:32+00:00",
          "mediaEventType": "media.sessionComplete",
          "mediaCollection": {
            "playhead": 128
          }
        }
      ]
    }
  }]
}

旧版实施类型(仅限Analytics)

Media SDK JS 3.x

在创建跟踪器之前在ADB.MediaConfig上设置downloadedContent

code language-javascript
var mediaConfig = new ADB.MediaConfig();
mediaConfig.trackingServer = "your.tracking.server";
mediaConfig.playerName = "HTML5 Player";
mediaConfig.channel = "Sports";
mediaConfig.downloadedContent = true;

var tracker = ADB.Media.getInstance(mediaConfig);
Chromecast

在调用trackSessionStart之前,在媒体信息对象上设置MediaDownloaded

code language-javascript
var mediaInfo = ADBMobile.media.createMediaObject("My Video", "video-123", 128,
  ADBMobile.media.StreamType.VOD, ADBMobile.media.MediaType.Video);
mediaInfo[ADBMobile.media.MediaObjectKey.MediaDownloaded] = true;
ADBMobile.media.trackSessionStart(mediaInfo, null);
媒体收集API

sessionStart POST请求的params对象中包括media.downloaded

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.downloaded": true
  }
}

有关完整请求结构,请参阅媒体收集API会话引用

recommendation-more-help
media-analytics-help