章节名称

本页介绍​ 章节名称 ​变量的数据收集。 有关相应的报表维度,请参阅章节名称

章节名称变量是易于用户识别的章节标题(例如,"Pilot Episode - Opening")。 在内容分为章节的每个media.chapterStart事件上设置它。

属性
上下文数据变量
a.media.chapter.friendlyName
XDM集合字段
xdm.mediaCollection.chapterDetails.friendlyName
Audience Manager特征
c_contextdata.a.media.chapter.friendlyName
必需
发送条件
章节开始,章节关闭

建议的实施类型

Web SDK

调用sendEvent时,在xdm.mediaCollection.chapterDetails中设置friendlyName

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.chapterStart",
    mediaCollection: {
      chapterDetails: {
        friendlyName: "Pilot Episode - Opening",
        index: 1,
        offset: 0,
        length: 240
      },
      sessionID: "{sid}",
      playhead: 0
    }
  }
});
iOS

将章节名称作为第一个(name)参数传递给createChapterObject

code language-swift
let chapterObject = Media.createChapterObjectWith(name: "Pilot Episode - Opening",
                                              position: 1,
                                                length: 240,
                                             startTime: 0)

tracker.trackEvent(event: MediaEvent.ChapterStart, info: chapterObject, metadata: nil)
Android

将章节名称作为第一个(name)参数传递给createChapterObject

code language-kotlin
val chapterObject = Media.createChapterObject("Pilot Episode - Opening",
                                              1L,
                                              240.0,
                                              0.0)

tracker.trackEvent(Media.Event.ChapterStart, chapterObject, null)
Roku

media.chapterStart调用sendMediaEvent时,在xdm.mediaCollection.chapterDetails中设置friendlyName

code language-brightscript
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.chapterStart",
        "mediaCollection": {
            "chapterDetails": {
                "friendlyName": "Pilot Episode - Opening",
                "index": 1,
                "offset": 0,
                "length": 240
            },
            "playhead": 0
        }
    }
})
Media Edge API

调用xdm.mediaCollection.chapterDetails中包含friendlyNamechapterStart终结点:

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.chapterStart",
      "mediaCollection": {
        "chapterDetails": {
          "friendlyName": "Pilot Episode - Opening",
          "index": 1,
          "offset": 0,
          "length": 240
        },
        "sessionID": "{sid}",
        "playhead": 0
      }
    }
  }]
}

旧版实施类型(仅限Analytics)

Media SDK JS 3.x

将章节名称作为第一个参数传递给ADB.Media.createChapterObject

code language-javascript
var chapterInfo = ADB.Media.createChapterObject(
  "Pilot Episode - Opening",  // name
  1,                          // position
  240,                        // length (seconds)
  0                           // start time (seconds)
);

tracker.trackEvent(ADB.Media.Event.ChapterStart, chapterInfo, contextData);
Chromecast

将章节名称作为第一个参数(name)传递给ADBMobile.media.createChapterObject

code language-javascript
var chapterInfo = ADBMobile.media.createChapterObject(
  "Pilot Episode - Opening",  // name
  1,                          // position
  240,                        // length
  0                           // startTime
);
ADBMobile.media.trackEvent(ADBMobile.media.Event.ChapterStart, chapterInfo, null);
媒体收集API

chapterStart POST请求的params对象中包括media.chapter.friendlyName

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "chapterStart",
  "params": {
    "media.chapter.friendlyName": "Pilot Episode - Opening"
  }
}

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

recommendation-more-help
media-analytics-help