DocumentaçãoAnalyticsGuia de serviços para mídia de streaming

Nome do capítulo

Última atualização: 29 de maio de 2026

Criado para:

  • Developer

Esta página aborda a coleta de dados da variável Nome do capítulo. Consulte Nome do capítulo para a dimensão de relatório correspondente.

style
shade-box

A variável de nome de capítulo é o título legível de um capítulo (por exemplo, "Pilot Episode - Opening"). Defina-o em cada evento media.chapterStart cujo conteúdo esteja dividido em capítulos.

Propriedade
Valor
Variável de dados de contexto
a.media.chapter.friendlyName
Campo da coleção XDM
xdm.mediaCollection.chapterDetails.friendlyName
Característica do Audience Manager
c_contextdata.a.media.chapter.friendlyName
Obrigatório
Não
Enviado com
Início do capítulo, fechamento do capítulo

Tipos de implementação recomendados

Web SDK

Definir friendlyName dentro de xdm.mediaCollection.chapterDetails ao chamar 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

Passar o nome do capítulo como o primeiro argumento (name) para 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

Passar o nome do capítulo como o primeiro argumento (name) para createChapterObject.

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

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

Definir friendlyName dentro de xdm.mediaCollection.chapterDetails ao chamar sendMediaEvent para 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 do Media Edge

Chame o ponto de extremidade chapterStart com friendlyName dentro de 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
      }
    }
  }]
}

Tipos de implementação herdada (somente Analytics)

Media SDK JS 3.x

Passar o nome do capítulo como o primeiro argumento para 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

Passar o nome do capítulo como o primeiro argumento (name) para 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 da coleção de mídia

Inclua media.chapter.friendlyName no objeto params de sua solicitação POST chapterStart:

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

Consulte a Referência de eventos da API Media Collection para obter a estrutura de solicitação completa.

recommendation-more-help
media-analytics-help