DocumentationAnalyticsGuide des services des médias en streaming

Nom du chapitre

Dernière mise à jour : 29 mai 2026

Créé pour :

  • Developer

Cette page traite de la collecte de données pour la variable Nom du chapitre. Voir Nom du chapitre pour la dimension de reporting correspondante.

style
shade-box

La variable de nom du chapitre est le titre lisible d’un chapitre (par exemple, "Pilot Episode - Opening"). Définissez-le sur chaque événement media.chapterStart dont le contenu est divisé en chapitres.

Propriété
Valeur
Variable de données contextuelles
a.media.chapter.friendlyName
champ de collection XDM
xdm.mediaCollection.chapterDetails.friendlyName
Caractéristique
c_contextdata.a.media.chapter.friendlyName
Obligatoire
Non
Envoyé avec
Début du chapitre, fermeture du chapitre

Types d’implémentation recommandés

SDK Web

friendlyName à l’intérieur des xdm.mediaCollection.chapterDetails lors de l’appel de sendEvent :

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

Transmettez le nom du chapitre en tant que premier argument (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

Transmettez le nom du chapitre en tant que premier argument (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

friendlyName à l’intérieur des xdm.mediaCollection.chapterDetails lors de l’appel de sendMediaEvent pour media.chapterStart :

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

Appelez le point d’entrée chapterStart avec friendlyName à l’intérieur du xdm.mediaCollection.chapterDetails :

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

Types d’implémentation hérités (Analytics uniquement)

Media SDK JS 3.x

Transmettez le nom du chapitre comme premier argument à 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

Transmettez le nom du chapitre comme premier argument (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 Media Collection

Incluez media.chapter.friendlyName dans l’objet params de votre chapterStart requête POST :

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

Consultez la référence des événements de l’API Media Collection pour obtenir la structure complète des requêtes.

recommendation-more-help
media-analytics-help