Mit den folgenden Anweisungen können Sie die Implementierung der 2.x-SDKs vornehmen.
Wenn Sie Version 1.x des SDK implementieren möchten, können Sie sich 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 | Beschreibung | erforderlich |
---|---|---|
name |
Medienname | Ja |
mediaid |
Eindeutige Medienkennung | Ja |
length |
Medienlänge | Ja |
streamType |
Streamtyp (siehe StreamType-Konstanten unten) | Ja |
mediaType |
Medientyp (siehe MediaType-Konstanten unten) | Ja |
StreamType
-Konstanten:
Konstantenname | Beschreibung |
---|---|
VOD |
Streamtyp für Video on Demand |
LIVE |
Streamtyp für Live-Inhalt |
LINEAR |
Streamtyp für Linear-Inhalt |
AOD |
Streamtyp für Audio on Demand. |
AUDIOBOOK |
Streamtyp für Hörbuch. |
PODCAST |
Streamtyp für Podcast. |
MediaType
-Konstanten:
Konstantenname | Beschreibung |
---|---|
Audio |
Medientyp für Audiostreams. |
Video |
Medientyp für Videostreams. |
var mediaObject =
MediaHeartbeat.createMediaObject(<MEDIA_NAME>,
<MEDIA_ID,
<MEDIA_LENGTH>,
MediaHeartbeat.StreamType.VOD,
<MEDIA_TYPE>);
Metadaten anhängen
Optional können Standard- bzw. benutzerdefinierte Metadatenobjekte über Kontextdatenvariablen an die Tracking-Sitzung angehängt werden.
Standard-Metadaten
Standard-Metadaten in JavaScript implementieren
Das Anhängen des Standard-Metadatenobjekts an das Medienobjekt 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 custom context data */
var customVideoMetadata = {
isUserLoggedIn: "false",
tvStation: "Sample TV station",
programmer: "Sample programmer"
};
Absicht, die Wiedergabe zu starten, verfolgen
Rufen Sie trackSessionStart
in der Media Heartbeat-Instanz auf, um eine Mediensitzung zu verfolgen:
mediaHeartbeat.trackSessionStart(mediaObject, customVideoMetadata);
Der zweite Wert ist der Name des benutzerdefinierten Medienmetadatenobjekts, den Sie in Schritt 2 erstellt haben.
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 benutzerdefinierten Metadaten verwenden, senden Sie einfach ein leeres Objekt für das data
-Argument in trackSessionStart
, wie in der Kommentarzeile im obigen iOS-Beispiel gezeigt.
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:
mediaHeartbeat.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:
mediaHeartbeat.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:
mediaHeartbeat.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:
mediaHeartbeat.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:
mediaHeartbeat.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.