Chronologie 1 : Regarder jusqu’à la fin du contenu timeline-view-to-end-of-content
VOD, publicités preroll, mise en pause, mise en mémoire tampon, affichage du contenu jusqu’à la fin
Les diagrammes suivants illustrent la chronologie du curseur de lecture et la chronologie correspondante des actions d’un utilisateur. Les détails de chaque action et des demandes qui l’accompagnent sont présentés ci-dessous.
Détails de l’action
Action 1 - Démarrage de la session Action-1
/api/v1/sessionsCet appel signale l’intention de l’utilisateur de lire une vidéo.
Il renvoie un ID de session ({sid}) au client, utilisé pour identifier tous les appels de suivi suivants dans la session. L’état du lecteur n’est pas encore « en cours de lecture », mais à la place, « en cours de démarrage ».
Les paramètres de session obligatoires doivent être inclus dans la carte params du corps de la requête. Pour plus d’informations sur les sessions, consultez la documentation de l’API Media Collection.
Sur le serveur principal, cet appel génère un appel de lancement d’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
}
}
Action 2 - Démarrage du minuteur de ping Action-2
/api/v1/sessions/{sid}/eventsDémarrez le minuteur de ping de votre application. Le premier événement ping doit alors se déclencher après 1 seconde en cas de publicités preroll ou après 10 secondes dans le cas contraire.
Action 3 - Début de la coupure publicitaire Action-3
/api/v1/sessions/{sid}/eventsLes annonces publicitaires ne peuvent être suivies que dans une coupure publicitaire.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType":"adBreakStart",
"params": {
"media.ad.podFriendlyName": "ad_pod1",
"media.ad.podIndex": 0,
"media.ad.podSecond": 0
}
}
Action 4 - Démarrage de la publicité Action-4
/api/v1/sessions/{sid}/eventsDémarrez le suivi de la première publicité preroll, qui dure 15 secondes. Incluez des métadonnées personnalisées avec ce 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"
}
}
REMARQUE : entre les événements AdBreakStart et AdStart, aucun événement de lecture supplémentaire ne devrait se produire.
Action 5 - Pings de publicité Action-5
Action 5.1 - Ping de publicité 1 Action-5-1
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les secondes pendant dans une annonce publicitaire.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Action 5.2 - Ping de publicité 2 Action-5-2
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les secondes pendant dans une annonce publicitaire.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Action 5.3 - Ping de publicité 3 Action-5-3
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les secondes pendant dans une annonce publicitaire.
par souci de concision…
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Action 6 - Fin de la publicité Action-6
/api/v1/sessions/{sid}/eventsEffectuez le suivi de la fin de la première publicité preroll.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Action 7 - Démarrage de la publicité Action-7
/api/v1/sessions/{sid}/eventsEffectuez le suivi du début de la seconde publicité preroll, qui dure 7 secondes.
{
"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"
},
}
Action 8 - Pings de publicité Action-8
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les secondes.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Action 9 - Fin de la publicité Action-9
/api/v1/sessions/{sid}/eventsEffectuez le suivi de la fin de la seconde publicité preroll.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Action 10 - Fin de la coupure publicitaire Action-10
/api/v1/sessions/{sid}/eventsLa coupure publicitaire est terminée.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adBreakComplete"
}
Action 11 - Lecture du contenu Action-11
/api/v1/sessions/{sid}/eventsAprès l’événement adBreakComplete, placez le lecteur à l’état « en cours de lecture » à l’aide de l’événement play.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "play"
}
Action 12 - Ping Action-12
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les 10 secondes.
{
"playerTime": {
"playhead": 8,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Action 13 - Début de la mémoire tampon Action-13
/api/v1/sessions/{sid}/eventsSuivez le déplacement du lecteur à l’état « mise en mémoire tampon ».
{
"playerTime": {
"playhead": 11,
"ts": "<timestamp>"
}, "eventType": "bufferStart"
}
Action 14 - Fin de la mémoire tampon Action-14
/api/v1/sessions/{sid}/eventsLa mise en mémoire tampon se terminant au bout de 3 secondes, replacez le lecteur à l’état « lecture ». Vous devez envoyer un autre événement de suivi de lecture provenant de la mise en mémoire tampon. L’appelplay après un bufferStart impliquant un appel « bufferEnd » au serveur principal, un événement bufferEnd n’est pas nécessaire.
{
"playerTime": {
"playhead": 11,
"ts": "<timestamp>"
},
"eventType": "play"
}
Action 15 - Ping Action-15
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les 10 secondes.
{
"playerTime": {
"playhead": 15,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Action 16 - Début de la coupure publicitaire Action-16
/api/v1/sessions/{sid}/eventsAnnonce publicitaire mid-roll d’une durée de 8 secondes : envoyez adBreakStart
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
},
"eventType": "adBreakStart",
"params": {
"media.ad.podFriendlyName": "ad_pod2",
"media.ad.podIndex": 1,
"media.ad.podSecond": 21
}
}
Action 17 - Démarrage de la publicité Action-17
/api/v1/sessions/{sid}/eventsSuivez l’annonce publicitaire mid-roll.
{
"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"
},
}
Action 18 - Ping de publicité Action-18
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les 10 secondes.
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Action 19 - Fin de la publicité Action-19
/api/v1/sessions/{sid}/eventsLa publicité mid-roll est terminée.
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Action 20 - Fin de la coupure publicitaire Action-20
/api/v1/sessions/{sid}/eventsLa coupure publicitaire est terminée.
{
"playerTime": {
"playhead": 21,
"ts": "<timestamp>"
},
"eventType": "adBreakComplete"
}
Action 21 - Ping Action-21
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les 10 secondes.
{
"playerTime": {
"playhead": 27,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Action 22 - Pause Action-22
/api/v1/sessions/{sid}/eventsL’action de l’utilisateur déplace l’état du lecteur sur « pause ».
{
"playerTime": {
"playhead": 31,
"ts": "<timestamp>"
},
"eventType": "pauseStart"
}
Action 23 - Ping Action-23
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les 10 secondes. Le lecteur est toujours à l’état « mémoire tampon » ; l’utilisateur est bloqué à 20 secondes de contenu. Suractivité…
{
"playerTime": {
"playhead": 31,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Action 24 - Lecture Action-24
/api/v1/sessions/{sid}/eventsDéplacez l’état de lecture sur « lecture ». L’appel play après un événement pauseStart impliquant un appel « resume » au serveur principal, un événement resume n’est pas nécessaire.
{
"playerTime": {
"playhead": 31,
"ts": "<timestamp>"
}, "eventType": "play"
}
Action 25 - Ping Action-25
/api/v1/sessions/{sid}/eventsEnvoyez un ping au serveur principal toutes les 10 secondes.
{
"playerTime": {
"playhead": 37,
"ts": "<timestamp>"
}, "eventType": "ping"
}
Action 26 - Fin de la session Action-26
/api/v1/sessions/{sid}/eventsEnvoyez sessionComplete au serveur principal pour indiquer que l’utilisateur a fini de regarder le contenu entier.
{
"playerTime": {
"playhead": 45,
"ts": "<timestamp>"
}, "eventType": "sessionComplete"
}
seekStart ou seekComplete dans l’API Media Collection. C’est parce que certains lecteurs génèrent un très grand nombre de ces événements lorsque l’utilisateur final est en train de balayer, et que plusieurs centaines d’utilisateurs pourraient facilement étrangler la bande passante réseau d’un service principal. Adobe évite un support explicite aux événements de recherche en calculant la durée des pulsations en fonction de l’horodatage de l’appareil, plutôt que de la position de la tête de lecture.