Diese Dokumentation behandelt das Tracking in der Version 3.x des SDK.
Wenn Sie vorherige Versionen des SDK implementieren möchten, können Sie hier die Entwicklerhandbücher herunterladen: SDKs herunterladen
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.
Variablenname | Typ | Beschreibung |
---|---|---|
name |
string | Nicht leere Zeichenfolge, die den Mediennamen angibt. |
id |
string | Nicht leere Zeichenfolge, die die eindeutige Medienkennung angibt. |
length |
number | Positive Zahl, die die Länge des Mediums in Sekunden angibt. Verwenden Sie 0, wenn die Länge unbekannt ist. |
streamType |
string | |
mediaType |
Medientyp (Audio oder Video). |
StreamType
-Konstanten:
Konstantenname | Beschreibung |
---|---|
VOD |
Streamtyp für Video on Demand |
AOD |
Streamtyp für Audio on Demand. |
MediaType
-Konstanten:
Konstantenname | Beschreibung |
---|---|
Audio |
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
Das 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);
trackSessionStart
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 zwischen trackSessionStart
() und trackPlay
) schätzen.
Wenn Sie keine contextData verwenden, senden Sie einfach ein leeres Objekt für das data
-Argument in trackSessionStart
.
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();
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();
trackSessionEnd
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 Sie trackComplete
vor trackSessionEnd
aufrufen. Jeder andere track*
-API-Aufruf nach trackSessionEnd
wird ignoriert, mit Ausnahme von trackSessionStart
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 App trackPause()
() aufrufen:
Identifizieren Sie das Ereignis aus dem Player bei Wiedergabe und/oder Fortsetzen nach Pause und rufen Sie trackPlay
auf:
tracker.trackPlay();
Diese Ereignisquelle kann mit der in Schritt 4 verwendeten identisch sein. Stellen Sie sicher, dass jeder trackPause()
API-Aufruf mit einem nachfolgenden trackPlay()
-API-Aufruf gepaart wird, wenn die Wiedergabe fortgesetzt wird.