章名

このページでは、章名​変数のデータ収集について説明します。 対応するレポートディメンションについては、章名を参照してください。

章名変数は、人間が読み取れる章のタイトルです(例:"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.chapterStartsendMediaEventを呼び出す場合、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);
Media Collection API

chapterStart POST リクエストのparams オブジェクトにmedia.chapter.friendlyNameを含めます:

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

完全なリクエスト構造については、Media Collection API イベントのリファレンス ​を参照してください。

recommendation-more-help
media-analytics-help