Visão geral overview
As instruções a seguir fornecem orientação para a implementação usando os SDKs 2.x.
A reprodução do anúncio inclui o rastreamento de ad breaks, anúncios iniciados, anúncios concluídos e anúncios ignorados. Use a API do reprodutor de mídia para identificar eventos importantes do reprodutor e preencher as variáveis de anúncio obrigatórias e opcionais. Consulte a lista abrangente de metadados aqui: Parâmetros de anúncios.
Eventos do player player-events
No início de pausa de anúncio
-
Crie uma instância de objeto
adBreakpara o ad break. Por exemplo,adBreakObject. -
Chame
trackEventpara iniciar o ad break comadBreakObject.
Em cada início de ativo de anúncio
- Crie a instância do objeto de anúncio para o ativo de anúncio. Por exemplo,
adObject. - Preencha os metadados do anúncio,
adCustomMetadata. - Chame
trackEventpara iniciar o anúncio.
Em cada conclusão de anúncio
- Chame
trackEventpara concluir o anúncio.
Ao ignorar o anúncio
- Chame
trackEventpara o anúncio ignorado.
Na conclusão do ad break
- Chame
trackEventpara concluir o ad break.
Implementar o rastreamento de anúncios implement-ad-tracking
Constantes de rastreamento do anúncio
AdBreakStartAdBreakCompleteAdStartAdCompleteAdSkipEtapas da implementação
-
Identifique o início do limite do ad break, incluindo o anúncio precedente, e crie um
AdBreakObjectusando as informações do ad break.AdBreakObjectreferência:table 0-row-3 1-row-3 2-row-3 3-row-3 3-align-center 7-align-center 11-align-center 15-align-center Nome da variável Descrição Obrigatório nameNome do ad break, como antes da exibição, durante a exibição e depois da exibição. Sim positionA posição do número do ad break no conteúdo, começando com 1. Sim startTimeValor do indicador de reprodução no início do ad break. Sim -
Chame
trackEvent()comAdBreakStartna instânciaMediaHeartbeatpara começar a rastrear o ad break. -
Identifique o início do anúncio e crie uma instância
AdObjectusando as informações do anúncio.AdObjectreferência: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 nameNome amigável do anúncio. Sim adIdIdentificador exclusivo do anúncio. Sim positionA posição do número do anúncio no ad break, começando com 1. Sim lengthComprimento do anúncio Sim -
Opcionalmente, anexe metadados padrão e/ou de anúncio à sessão de rastreamento por meio de variáveis de dados de contexto.
- Metadados de anúncio padrão - Para metadados de anúncio padrão, crie um dicionário de pares de valores-chave de metadados de anúncio padrão usando as chaves da sua plataforma.
- Metadados de anúncio personalizados - Para metadados personalizados, crie um objeto variável para as variáveis de dados personalizadas e preencha com os dados do anúncio atual.
-
Chame
trackEvent()com o eventoAdStartna instânciaMediaHeartbeatpara começar a rastrear a reprodução de anúncio.Inclua uma referência na variável de metadados personalizada (ou um objeto vazio) como o terceiro parâmetro na chamada de evento.
-
Quando a reprodução atingir o fim do anúncio, chame
trackEvent()com o eventoAdComplete. -
Se a reprodução do anúncio não tiver sido concluída porque o usuário optou por ignorar o anúncio, rastreie o evento
AdSkip. -
Se houver algum anúncio adicional em um mesmo
AdBreak, repita novamente as etapas 3 a 7. -
O ad break está concluído, use o evento
AdBreakCompletepara rastreá-lo.
l:event:playhead) durante a reprodução do anúncio (s:asset:type=ad). Se você fizer isso, as métricas de Tempo gasto do conteúdo serão afetadas negativamente.O código de exemplo a seguir usa o SDK 2.x do JavaScript para um reprodutor de mídia HTML5.
/* Call on ad break start */
if (e.type == "ad break start") {
var adBreakObject = MediaHeartbeat.createAdBreakObject("mid-roll", 2, 500);
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakStart, adBreakObject);
};
/* Call on ad start */
if (e.type == "ad start") {
var adObject = MediaHeartbeat.createAdObject("PepsiOne", "123456ab", 1, 30);
/* Set custom context data */
var adCustomMetadata = {
affiliate:"Sample affiliate",
campaign:"Sample ad campaign",
creative:"Sample creative"
}
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdStart, adObject, adCustomMetadata);
};
/* Call on ad complete */
if (e.type == "ad complete") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdComplete);
};
/* Call on ad skip */
if (e.type == "ad skip") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdSkip);
};
/* Call on ad break complete */
if (e.type == "ad break complete") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakComplete);
};