Linha do tempo 2 - Usuário abandona a sessão
Criado para:
- Usuário
- Administrador
- Desenvolvedor
VOD, anúncios precedentes, anúncios intermediários, usuário abandona o conteúdo antecipadamente
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
/api/v1/sessions
Essa 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. No back-end, essa chamada gera uma chamada de inicialização do Adobe Analytics. Para obter informações sobre sessões, consulte a documentação da API da coleção de mídia.
{
"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
Inicie 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
/api/v1/sessions/{sid}/events
Os anúncios antes da exibição devem ser rastreados. Os 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
/api/v1/sessions/{sid}/events
Um anúncio de 12 segundos é iniciado.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adStart",
"params": {
"media.ad.podFriendlyName": "ad_pod1",
"media.ad.name": "Ad 1",
"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": "1",
"media.ad.creativeId": "42",
"media.ad.siteId": "XYZ",
"media.ad.creativeURL": "https://xyz-creative.com",
"media.ad.placementId": "sample-placement2"
},
}
Ação 5 - Pings de anúncios
/api/v1/sessions/{sid}/events
Envie um ping ao back-end a cada 1 segundo. (Pings de anúncios subsequentes não mostrados, por motivos de brevidade.)
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 6 - Anúncio concluído
/api/v1/sessions/{sid}/events
O primeiro anúncio precedente terminou.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Ação 7 - Ad break concluído
/api/v1/sessions/{sid}/events
O ad break está concluído. Durante todo o ad break, o player permaneceu no estado de "reprodução".
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adBreakComplete"
}
Ação 8 - Reproduzir conteúdo
/api/v1/sessions/{sid}/events
Altere o estado do player para “reproduzindo”; comece a rastrear o início da reprodução do conteúdo.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "play",
"qoeData": {
"bitrate": 10000
}
}
Ação 9 - Ping
/api/v1/sessions/{sid}/events
Envie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 8,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 10 - Ping
/api/v1/sessions/{sid}/events
Envie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 18,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 11 - Erro
/api/v1/sessions/{sid}/events
{
"playerTime": {
"playhead": 20,
"ts": "<timestamp>"
},
"eventType": "error"
}
Ação 12 - Reproduzir conteúdo
/api/v1/sessions/{sid}/events
{
"playerTime": {
"playhead": 18,
"ts": "<timestamp>"
},
"eventType":"play",
"qoeData": {
"bitrate": 10000
}
}
Ação 13 - Ping
/api/v1/sessions/{sid}/events
Envie um ping ao back-end a cada 10 segundos.
{
"playerTime": {
"playhead": 28,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Ação 14 - Início do ad break
/api/v1/sessions/{sid}/events
Anúncio intermediário de 8 segundos: envie adBreakStart
.
{
"playerTime": {
"playhead": 33,
"ts": "<timestamp>"
},
"eventType":"adBreakStart",
"params": {
"media.ad.podFriendlyName": "ad_pod2",
"media.ad.podIndex": 1,
"media.ad.podSecond": 33
}
}
Ação 15 - Início do anúncio
/api/v1/sessions/{sid}/events
Rastreie o anúncio intermediário.
{
"playerTime": { "playhead": 33, "ts": "<timestamp>"
},
"eventType": "adStart",
"params": {
"media.ad.podFriendlyName": "ad_pod1",
"media.ad.name": "Ad 1",
"media.ad.id": "002",
"media.ad.length": 8,
"media.ad.podPosition": 1,
"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 16 - Fechar aplicativo
/api/v1/sessions/{sid}/events
Envie sessionEnd
para o back-end do VA para indicar que a sessão deve ser encerrada imediatamente, sem processamento adicional.
{
"playerTime": {
"playhead": 33,
"ts": "<timestamp>"
},
"eventType": "sessionEnd"
}