Nachverfolgen der grundlegenden Wiedergabe mit JavaScript 3.x
Erstellt für:
- Benutzende
- Admin
- Entwickler
Diese Dokumentation behandelt das Tracking in der Version 3.x des SDK.
-
Tracking-Ersteinrichtung
Identifizieren Sie, wenn der Benutzer die Wiedergabe auslöst (Benutzer klickt auf „Abspielen“ und/oder die automatische Wiedergabe ist aktiviert), und erstellen Sie eine
MediaObject
-Instanz.VariablennameTypBeschreibungname
stringNicht leere Zeichenfolge, die den Mediennamen angibt.id
stringNicht leere Zeichenfolge, die die eindeutige Medienkennung angibt.length
numberPositive Zahl, die die Länge des Mediums in Sekunden angibt. Verwenden Sie 0, wenn die Länge unbekannt ist.streamType
stringmediaType
Medientyp (Audio oder Video).StreamType
-Konstanten:KonstantennameBeschreibungVOD
Streamtyp für Video on DemandAOD
Streamtyp für Audio on Demand.MediaType
-Konstanten:KonstantennameBeschreibungAudio
Medientyp für Audiostreams.Video
Medientyp für Videostreams.var mediaObject = ADB.Media.createMediaObject(<MEDIA_NAME>, <MEDIA_ID, <MEDIA_LENGTH>, <STREAM_TYPE>, <MEDIA_TYPE>);
-
Metadaten anhängen
Optional können standardmäßige bzw. benutzerdefinierte Metadaten über Kontextdatenvariablen an die Tracking-Sitzung angehängt werden.
-
Standard-Metadaten
NOTEDas Anhängen der Standardmetadaten ist optional.-
Medien-Metadatenschlüssel API-Referenz: Standard-Metadatenschlüssel - JavaScript
Hier sehen Sie den umfassenden Satz der verfügbaren Metadaten: Audio- und Videoparameter
-
-
Benutzerspezifische Metadaten
Erstellen Sie ein Variablenobjekt für die benutzerdefinierten Variablen und fügen Sie die Daten für dieses Medium ein. Beispiel:
/* Set context data */ var contextData = {}; //Standard metadata contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode"; contextData[ADB.Media.VideoMetadataKeys] = "Sample Show"; //Custom metadata contextData["isUserLoggedIn"] = "false"; contextData["tvStation"] = "Sample TV Station";
-
-
Absicht, die Wiedergabe zu starten, verfolgen
Rufen Sie
trackSessionStart
in der Media Heartbeat-Instanz auf, um eine Mediensitzung zu verfolgen:var mediaObject = ADB.Media.createMediaObject("video-name", "video-id", 60.0, ADB.Media.StreamType.VOD, ADB.Media.MediaType.Video); var contextData = {}; //Standard metadata contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode"; contextData[ADB.Media.VideoMetadataKeys] = "Sample Show"; //Custom metadata contextData["isUserLoggedIn"] = "false"; contextData["tvStation"] = "Sample TV Station"; tracker.trackSessionStart(mediaObject, contextData);
IMPORTANTtrackSessionStart
verfolgt die Absicht des Benutzers, die Wiedergabe zu starten, und nicht den Anfang der Wiedergabe. Mit dieser API können Sie die Daten/Metadaten laden und die QoS-Metrik zur Ladezeit (zeitlicher Abstand zwischentrackSessionStart
() undtrackPlay
) schätzen.NOTEWenn Sie keine contextData verwenden, senden Sie einfach ein leeres Objekt für dasdata
-Argument intrackSessionStart
. -
Tatsächlichen Wiedergabebeginn verfolgen
Identifizieren Sie das Ereignis für den Anfang der Wiedergabe im Medienplayer, sobald der erste Frame des Mediums auf dem Bildschirm angezeigt wird, und rufen Sie
trackPlay
auf:tracker.trackPlay();
-
Abspielkopfwert aktualisieren
Wenn sich der Abspielkopf des Mediums ändert, informieren Sie die SDK durch Aufruf der
mediaUpdatePlayhead
-API.
Bei Video-on-demand (VOD) wird der Wert in Sekunden ab Beginn des Medienelements angegeben.
Wenn der Player beim Live-Streaming keine Informationen zur Inhaltsdauer bereitstellt, kann der Wert als Anzahl der Sekunden seit Mitternacht (UTC) des Tages angegeben werden.tracker.updatePlayhead(position)
NOTEBeachten Sie beim Aufrufen dertracker.updatePlayhead
-API Folgendes:- Bei Verwendung von Fortschrittsmarken ist die Inhaltsdauer erforderlich und der Abspielkopf muss als Anzahl von Sekunden ab Beginn des Medienelements aktualisiert werden, beginnend mit 0.
- Bei Verwendung von Medien-SDKs müssen Sie die
tracker.updatePlayhead
-API mindestens einmal pro Sekunde aufrufen.
-
Ende der Wiedergabe verfolgen
Identifizieren Sie das Ereignis für den Abschluss der Wiedergabe im Medienplayer, wenn der Inhalt bis zum Ende angesehen wurde, und rufen Sie
trackComplete
auf:tracker.trackComplete();
-
Ende der Sitzung verfolgen
Identifizieren Sie das Ereignis für das Entladen/Schließen der Wiedergabe im Medienplayer, wenn der Benutzer das Medium schließt bzw. das Medium abgeschlossen ist und entladen wird, und rufen Sie
trackSessionEnd
auf:tracker.trackSessionEnd();
IMPORTANTtrackSessionEnd
markiert das Ende einer Tracking-Sitzung. Wenn die Sitzung erfolgreich bis zum Ende wiedergegeben wurde und der Anwender den Inhalt bis zum Schluss angesehen hat, müssen SietrackComplete
vortrackSessionEnd
aufrufen. Jeder anderetrack*
-API-Aufruf nachtrackSessionEnd
wird ignoriert, mit Ausnahme vontrackSessionStart
für eine neue Tracking-Sitzung. -
Alle möglichen Pausenszenarien verfolgen
Identifizieren Sie das Ereignis im Medienplayer für Anhalten und rufen Sie
trackPause
auf:tracker.trackPause();
Pausenszenarien
Identifizieren Sie alle Szenarios, in denen der Medienplayer angehalten wird, und stellen Sie sicher, dass
trackPause
korrekt aufgerufen wird. In allen folgenden Szenarios muss Ihre ApptrackPause()
() aufrufen:- Der Benutzer drückt in der App die Pausetaste.
- Die Wiedergabe wird vom Player selbst pausiert.
- (Mobile Apps) - Der Benutzer bewegt die App in den Hintergrund, aber Sie möchten, dass die Sitzung der App geöffnet bleibt.
- (Mobile Apps) - Eine beliebige Systemunterbrechung tritt ein, die dazu führt, dass eine App im Hintergrund ausgeführt wird. Beispielsweise erhält der Benutzer einen Anruf oder ein Pop-up aus einer anderen App, aber Sie möchten, dass die App-Sitzung fortgeführt wird, damit der Benutzer die Medien ab dem Zeitpunkt der Unterbrechung wieder fortsetzen kann.
-
Identifizieren Sie das Ereignis aus dem Player bei Wiedergabe und/oder Fortsetzen nach Pause und rufen Sie
trackPlay
auf:tracker.trackPlay();
TIPDiese Ereignisquelle kann mit der in Schritt 4 verwendeten identisch sein. Stellen Sie sicher, dass jedertrackPause()
API-Aufruf mit einem nachfolgendentrackPlay()
-API-Aufruf gepaart wird, wenn die Wiedergabe fortgesetzt wird.
- Tracking-Szenarien: VOD-Wiedergabe ohne Anzeigen
- JavaScript-SDK mit Beispiel-Player für ein vollständiges Tracking-Beispiel.