Position du chapitre

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

La variable de position du chapitre est l’index du chapitre à l’intérieur du contenu, en commençant par 1 (standard) ou 0 (selon votre convention). Utilisez un index stable par chapitre afin que le même chapitre soit reporté entre les sessions.

Propriété
Valeur
Variable de données contextuelles
a.media.chapter.position
champ de collection XDM
xdm.mediaCollection.chapterDetails.index
Caractéristique
c_contextdata.a.media.chapter.position
Obligatoire
Non (Mobile SDK) ; Oui (Edge, API Media Collection)
Envoyé avec
Début du chapitre, fermeture du chapitre

Types d’implémentation recommandés

SDK Web

index à 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 la position du chapitre comme deuxième argument à 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 la position du chapitre comme deuxième argument à createChapterObject.

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

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

index à 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 index à l’intérieur du xdm.mediaCollection.chapterDetails :

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.chapterStart",
      "mediaCollection": {
        "chapterDetails": {
          "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 la position du chapitre comme deuxième argument à ADB.Media.createChapterObject :

code language-javascript
var chapterInfo = ADB.Media.createChapterObject(
  "Pilot Episode - Opening",
  1,
  240,
  0
);

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

Transmettez la position du chapitre comme deuxième argument à 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.index dans l’objet params de votre chapterStart requête POST :

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "chapterStart",
  "params": {
    "media.chapter.index": 1
  }
}

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