Visão geral overview
As instruções a seguir fornecem orientação para a implementação usando SDKs 2.x.
O rastreamento de capítulos e segmentos está disponível para capítulos ou segmentos de mídia definidos de forma personalizada. Alguns usos comuns para o rastreamento de capítulos são definir segmentos personalizados com base no conteúdo de mídia (como entradas de beisebol) ou definir segmentos de conteúdo entre ad breaks. O rastreamento de capítulos não é necessário para implementações de heartbeat de mídia principais.
O rastreamento do capítulo inclui inícios de capítulo, conclusões de capítulo e capítulos ignorados. Você pode usar a API do reprodutor de mídia com lógica de segmentação personalizada para identificar eventos do player e para preencher as variáveis de capítulo obrigatórias e opcionais.
Eventos do player
No início do capítulo
- Criar a instância do objeto de anúncio para o capítulo,
chapterObject
- Preencha os metadados do capítulo,
chapterCustomMetadata
- Chame
trackEvent(MediaHeartbeat.Event.ChapterStart, chapterObject, chapterCustomMetadata);
Na conclusão do capítulo
- Chame
trackEvent(MediaHeartbeat.Event.ChapterComplete);
Ao ignorar o capítulo
- Chame
trackEvent(MediaHeartbeat.Event.ChapterSkip);
Implementar o rastreamento de capítulo implement-chapter-tracking
-
Identifique quando ocorre o evento de início do capítulo e crie a instância
ChapterObject
usando as informações do capítulo.Aqui está a referência para o rastreamento de capítulo
ChapterObject
:note note NOTE Essas variáveis somente são necessárias se você estiver planejando rastrear capítulos. table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center Nome da variável Descrição Obrigatório name
Nome do capítulo Sim position
Posição do capítulo Sim length
Extensão do capítulo Sim startTime
Hora de início do capítulo Sim -
Se você incluir metadados personalizados para o capítulo, crie as variáveis de dados de contexto para os metadados.
-
Para começar a rastrear a reprodução do capítulo, chame o evento
ChapterStart
na instânciaMediaHeartbeat
. -
Quando a reprodução atingir o limite final do capítulo, conforme definido pelo seu código personalizado, chame o evento
ChapterComplete
na instânciaMediaHeartbeat
. -
Se a reprodução do capítulo não tiver sido concluída porque o usuário optou por ignorar o capítulo (por exemplo, se o usuário sair do limite do capítulo), chame o evento
ChapterSkip
na instância MediaHeartbeat. -
Se houver capítulos adicionais, repita as etapas de 1 até 5.
O código de exemplo a seguir usa o SDK 2.x do JavaScript para um reprodutor de mídia HTML5. Você deve usar esse código com o código de reprodução de mídia principal.
/* Call on chapter start */
if (e.type == "chapter start") {
var chapterObject = MediaHeartbeat.createChapterObject("Inning 5",5,500,2500);
/* Set custom context data*/
var chapterCustomMetadata = {
segmentType:"Baseball Innings",
segmentName:"Inning 5",
segmentInfo:"Game Six"
}
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterStart,
chapterObject,
chapterCustomMetadata);
};
/* Call on chapter complete */
if (e.type == "chapter complete") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterComplete);
};
/* Call on chapter skip */
if (e.type == "chapter skip") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterSkip);
};