Linha do tempo 1 - Visualização do conteúdo até o fim timeline-view-to-end-of-content
VOD, anúncios precedentes, pausa, buffer, visualização até o fim do conteúdo
Os diagramas a seguir ilustram a linha do tempo do indicador de reprodução e a linha do tempo correspondente das ações de um usuário. Os pormenores de cada ação e os pedidos que a acompanham são apresentados a seguir.
Detalhes da ação
Ação 1 - Iniciar sessão Action-1
/api/v1/sessionsEssa chamada sinaliza a intenção do usuário de reproduzir um vídeo.
Retorna uma ID de sessão ({sid}) ao cliente usada para identificar todas as chamadas de rastreamento subsequentes na sessão. O estado do player ainda não é “reproduzindo”, mas “iniciando”.
Os parâmetros obrigatórios da sessão devem ser incluídos no mapa params no corpo da solicitação. Para obter informações sobre sessões, consulte a documentação da API da coleção de mídia.
No back-end, essa chamada gera uma chamada de inicialização do Adobe Analytics.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType":"sessionStart, params" {
"media.playerName": "sample-html5-api-player",
"analytics.trackingServer": "[ _YOUR_TS_ ]",
"analytics.reportSuite": "[ _YOUR_RSID_ ]",
"analytics.visitorId": "[ _YOUR_VISITOR_ID_ ]",
"media.contentType": "VOD",
"media.length": 60.3333333333333,
"media.id": "VA API Sample Player",
"visitor.marketingCloudOrgId": "[YOUR_MCID]",
"media.name": "ClickMe",
"media.channel": "sample-channel",
"media.sdkVersion": "va-api-0.0.0",
"analytics.enableSSL": false
}
}
Ação 2 - Início do temporizador de ping Action-2
/api/v1/sessions/{sid}/eventsInicie o temporizador de ping do aplicativo. O primeiro evento de ping deve disparar 1 segundo se houver anúncios precedentes, 10 segundos se não houver.
Ação 3 - Início de quebra de anúncio Action-3
/api/v1/sessions/{sid}/eventsOs anúncios somente podem ser rastreados em um ad break.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType":"adBreakStart",
"params": {
"media.ad.podFriendlyName": "ad_pod1",
"media.ad.podIndex": 0,
"media.ad.podSecond": 0
}
}
Ação 4 - Início do anúncio Action-4
/api/v1/sessions/{sid}/eventsComece a rastrear o primeiro anúncio precedente, que tem 15 segundos de duração. Incluindo metadados personalizados com este adStart .
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType":"adStart",
"params": {
"media.ad.podFriendlyName": "ad_pod1",
"media.ad.name": "Ad 1",
"media.ad.id": "001",
"media.ad.length": 15,
"media.ad.podPosition": 1,
"media.ad.playerName": "Sample Player",
"media.ad.advertiser": "Ad Guys",
"media.ad.campaignId": "1",
"media.ad.creativeId": "42",
"media.ad.siteId": "XYZ",
"media.ad.creativeURL": "https://example.com",
"media.ad.placementId": "sample_placement"
},
"customMetadata": {
"myCustomData1": "CustomData1",
"myCustomData2": "CustomData2"
}
}
OBSERVAÇÃO: Entre os eventos AdBreakStart e AdStart, não deve haver nenhum evento de reprodução adicional.
Ação 5 - Pings de anúncios Action-5
Ação 5.1 - Ping de anúncio 1 Action-5-1
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 1 segundo enquanto estiver em um anúncio.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 5.2 - Ping de anúncio 2 Action-5-2
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 1 segundo enquanto estiver em um anúncio.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 5.3 - Ping de anúncio 3 Action-5-3
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 1 segundo enquanto estiver em um anúncio.
por razões de brevidade…
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 6 - Anúncio concluído Action-6
/api/v1/sessions/{sid}/eventsRastreie o final do primeiro anúncio precedente.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Ação 7 - Início do anúncio Action-7
/api/v1/sessions/{sid}/eventsRastreie o início do segundo anúncio precedente, que tem 7 segundos de duração.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adStart",
"params": {
"media.ad.podFriendlyName": "ad_pod1",
"media.ad.name": "Ad 2",
"media.ad.id": "002",
"media.ad.length": 7,
"media.ad.podPosition": 1,
"media.ad.playerName": "Sample Player",
"media.ad.advertiser": "Ad Guys",
"media.ad.campaignId": "2",
"media.ad.creativeId": "44",
"media.ad.siteId": "XYZ",
"media.ad.creativeURL": "https://example.com",
"media.ad.placementId": "sample_placement2"
},
}
Ação 8 - Pings de anúncios Action-8
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 1 segundo.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 9 - Anúncio concluído Action-9
/api/v1/sessions/{sid}/eventsRastreie o final do segundo anúncio precedente.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Ação 10 - Quebra de anúncio concluída Action-10
/api/v1/sessions/{sid}/eventsO ad break está concluído.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adBreakComplete"
}
Ação 11 - Reproduzir conteúdo Action-11
/api/v1/sessions/{sid}/eventsDepois do evento adBreakComplete, coloque o player no estado “reproduzindo” usando o evento play.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "play"
}
Ação 12 - Ping Action-12
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 8,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 13 - Início do buffer Action-13
/api/v1/sessions/{sid}/eventsRastreie a alteração do player para o estado de “buffering”.
{
"playerTime": {
"playhead": 11,
"ts": "<timestamp>"
}, "eventType": "bufferStart"
}
Ação 14 - Fim do buffer Action-14
/api/v1/sessions/{sid}/eventsO buffering termina após 3 segundos; coloque o reprodutor no estado "reproduzindo". Você deve enviar outro evento de rastreamento de reprodução a partir do buffering. A chamada play depois de um bufferStart infere uma chamada de "bufferEnd" ao back-end, assim, um evento bufferEnd não é necessário.
{
"playerTime": {
"playhead": 11,
"ts": "<timestamp>"
},
"eventType": "play"
}
Ação 15 - Ping Action-15
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 15,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Ação 16 - Início de quebra de anúncio Action-16
/api/v1/sessions/{sid}/eventsAnúncio intermediário de 8 segundos: envie adBreakStart .
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
},
"eventType": "adBreakStart",
"params": {
"media.ad.podFriendlyName": "ad_pod2",
"media.ad.podIndex": 1,
"media.ad.podSecond": 21
}
}
Ação 17 - Início do anúncio Action-17
/api/v1/sessions/{sid}/eventsRastreie o anúncio intermediário.
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
},
"eventType": "adStart",
"params": {
"media.ad.podFriendlyName": "ad_pod2",
"media.ad.name": "Ad 3",
"media.ad.id": "003",
"media.ad.length": 8,
"media.ad.podPosition": 2,
"media.ad.playerName": "Sample Player",
"media.ad.advertiser": "Ad Guys",
"media.ad.campaignId": "7",
"media.ad.creativeId": "40",
"media.ad.siteId": "XYZ",
"media.ad.creativeURL": "https://example.com",
"media.ad.placementId": "sample_placement2"
},
}
Ação 18 - Ping do anúncio Action-18
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Ação 19 - Anúncio concluído Action-19
/api/v1/sessions/{sid}/eventsO anúncio intermediário está concluído.
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Ação 20 - Quebra de anúncio concluída Action-20
/api/v1/sessions/{sid}/eventsO ad break está concluído.
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
},
"eventType": "adBreakComplete"
}
Ação 21 - Ping Action-21
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 27,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 22 - Pausar Action-22
/api/v1/sessions/{sid}/eventsA ação do usuário altera o estado de reprodução para “pausado”.
{
"playerTime": {
"playhead": 31,
"ts": "<timestamp>"
},
"eventType": "pauseStart"
}
Ação 23 - Ping Action-23
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 10 segundos. O player ainda está no estado "buffering"; o usuário fica preso nos 20 segundos de conteúdo. Procurando…
{
"playerTime": {
"playhead": 31,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Ação 24 - Reproduzir Action-24
/api/v1/sessions/{sid}/eventsMova o estado de reprodução para "reproduzindo". A chamada play depois de um pauseStart infere uma chamada de "retomada" ao back-end, assim, um evento resume não é necessário.
{
"playerTime": {
"playhead": 31,
"ts": "<timestamp>"
}, "eventType": "play"
}
Ação 25 - Ping Action-25
/api/v1/sessions/{sid}/eventsEnvie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 37,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Ação 26 - Sessão concluída Action-26
/api/v1/sessions/{sid}/eventsEnvie sessionComplete ao back-end para indicar que o usuário terminou de assistir todo o conteúdo.
{
"playerTime": {
"playhead": 45,
"ts": "<timestamp>"
}, "eventType": "sessionComplete"
}
seekStart ou seekComplete. Isso ocorre porque certos players geram um número muito grande desses eventos quando o usuário final está depurando, e várias centenas de usuários podem facilmente afunilar a largura de banda da rede de um serviço de backend. A Adobe oferece suporte explícito para eventos de busca, calculando a duração da pulsação com base no carimbo de data e hora do dispositivo, em vez da posição do indicador de reprodução.