Zeitlicher Ablauf 2: Verlassen der Sitzung durch Anwender
Erstellt für:
- Benutzende
- Admin
- Entwickler
VOD, Pre-Roll-Anzeige, Mid-Roll-Anzeigen, Anwender verlässt Inhalt schnell
Die folgenden Diagramme illustrieren die Zeitleiste der Abspielleiste und die zugehörige Zeitleiste der Aktionen eines Benutzers. Die Details für jede Aktion und die zugehörigen Anforderungen sind unten aufgeführt.
Aktionsdetails
Aktion 1: Sitzung starten
/api/v1/sessions
Dieser Aufruf signalisiert die Anwenderintention, ein Video abzuspielen. Er gibt eine Sitzungs-ID ({sid}
) an den Client zurück, die zur Identifikation aller nachfolgenden Tracking-Aufrufe innerhalb der Sitzung verwendet wird. Der Player-Status lautet noch nicht „Playing“ (Wiedergabe), sondern „Starting“ (Start). Erforderliche Sitzungsparameter müssen in der params
-Map des Anfrageinhalts angegeben werden. Am Backend generiert dieser Aufruf einen Adobe Analytics-Initiationsaufruf. Informationen zu Sitzungen finden Sie in der Dokumentation zur Mediensammlungs-API.
{
"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
}
}
Aktion 2: Start des Ping-Timers
Starten Sie den Ping-Timer Ihrer App. Das erste Ping-Ereignis sollte dann nach 1 Sekunde ausgelöst werden, wenn Pre-Roll-Anzeigen vorhanden sind, andernfalls nach 10 Sekunden.
Aktion 3: Start der Werbeunterbrechung
/api/v1/sessions/{sid}/events
Pre-Roll-Anzeigen müssen verfolgt werden. Anzeigen können nur innerhalb einer Werbeunterbrechung verfolgt werden.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adBreakStart",
"params": {
"media.ad.podFriendlyName": "ad_pod1",
"media.ad.podIndex": 0,
"media.ad.podSecond": 0
}
}
Aktion 4: Anzeigenstart
/api/v1/sessions/{sid}/events
Es startet eine 12-sekündige Anzeige.
{
"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"
},
}
Aktion 5: Anzeigen-Pings
/api/v1/sessions/{sid}/events
Senden Sie jede Sekunde ein Ping-Ereignis an das Backend. (Nachfolgende Anzeigen-Pings werden im Interesse der Kürze nicht angezeigt.)
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Aktion 6: Abschluss der Anzeige
/api/v1/sessions/{sid}/events
Die erste Pre-Roll-Anzeige ist vorüber.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adComplete"
}
Aktion 7: Abschluss der Werbeunterbrechung
/api/v1/sessions/{sid}/events
Die Werbeunterbrechung ist vorüber. Während der Anzeigenunterbrechung blieb der Player im Status „Abspielen“.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "adBreakComplete"
}
Aktion 8: Inhalt abspielen
/api/v1/sessions/{sid}/events
Ändern Sie den Status des Players zu „Playing“ (Wiedergabe) und beginnen Sie mit dem Tracking des Starts der Inhaltswiedergabe.
{
"playerTime": {
"playhead": 0,
"ts": "<timestamp>"
},
"eventType": "play",
"qoeData": {
"bitrate": 10000
}
}
Aktion 9: Ping
/api/v1/sessions/{sid}/events
Pingen Sie das Backend alle 10 Sekunden an.
{
"playerTime": {
"playhead": 8,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Aktion 10: Ping
/api/v1/sessions/{sid}/events
Pingen Sie das Backend alle 10 Sekunden an.
{
"playerTime": {
"playhead": 18,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Aktion 11: Fehler
/api/v1/sessions/{sid}/events
{
"playerTime": {
"playhead": 20,
"ts": "<timestamp>"
},
"eventType": "error"
}
Aktion 12: Inhalt abspielen
/api/v1/sessions/{sid}/events
{
"playerTime": {
"playhead": 18,
"ts": "<timestamp>"
},
"eventType":"play",
"qoeData": {
"bitrate": 10000
}
}
Aktion 13: Ping
/api/v1/sessions/{sid}/events
Pingen Sie das Backend alle 10 Sekunden an.
{
"playerTime": {
"playhead": 28,
"ts": "<timestamp>"
},
"eventType": "ping"
}
Aktion 14: Start der Werbeunterbrechung
/api/v1/sessions/{sid}/events
Mid-Roll-Anzeige mit einer Dauer von 8 Sekunden: Senden Sie adBreakStart
.
{
"playerTime": {
"playhead": 33,
"ts": "<timestamp>"
},
"eventType":"adBreakStart",
"params": {
"media.ad.podFriendlyName": "ad_pod2",
"media.ad.podIndex": 1,
"media.ad.podSecond": 33
}
}
Aktion 15: Anzeigenstart
/api/v1/sessions/{sid}/events
Verfolgen Sie die Mid-Roll-Anzeige.
{
"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"
},
}
Aktion 16: App schließen
/api/v1/sessions/{sid}/events
Senden Sie sessionEnd
an das VA-Backend, um anzugeben, dass die Sitzung sofort und ohne weitere Verarbeitung geschlossen werden soll.
{
"playerTime": {
"playhead": 33,
"ts": "<timestamp>"
},
"eventType": "sessionEnd"
}