Questa documentazione tratta il tracciamento nella versione 3.x dell’SDK.
Se implementi una versione precedente dell’SDK, puoi scaricare le Guide per sviluppatori qui: Scaricare gli SDK
Configurazione del tracciamento iniziale
Identifica quando l’utente attiva l’intenzione di riproduzione (l’utente fa clic su play e/o l’esecuzione automatica è attiva) e crea un’istanza MediaObject
.
Nome variabile | Tipo | Descrizione |
---|---|---|
name |
stringa | Stringa non vuota che indica il nome del file multimediale. |
id |
stringa | Stringa non vuota che indica un identificatore del file multimediale univoco. |
length |
numero | Numero positivo che indica la lunghezza del file multimediale in secondi. Usa 0 se la lunghezza è sconosciuta. |
streamType |
stringa | |
mediaType |
Tipo di file multimediale (audio o video). |
Costanti StreamType
:
Nome costante | Descrizione |
---|---|
VOD |
Tipo di flusso per Video on Demand. |
AOD |
Tipo di flusso per audio on-demand. |
Costanti MediaType
:
Nome costante | Descrizione |
---|---|
Audio |
Tipo di file multimediale per flussi Audio. |
Video |
Tipo di file multimediale per i flussi Video. |
var mediaObject = ADB.Media.createMediaObject(<MEDIA_NAME>,
<MEDIA_ID,
<MEDIA_LENGTH>,
<STREAM_TYPE>,
<MEDIA_TYPE>);
Allega metadati
Facoltativamente, allega metadati standard e/o personalizzati alla sessione di tracciamento tramite variabili di dati di contesto.
Metadati standard
L’aggiunta dei metadati standard è facoltativa.
Riferimento API per le chiavi di metadati multimediali - Chiavi di metadati standard - JavaScript
Consulta il set completo dei metadati disponibili qui: Parametri audio e video
Metadati personalizzati
Crea un oggetto variabile per le variabili personalizzate e compila i dati per questo elemento multimediale. Ad esempio:
/* 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";
Tracciare l’intenzione di inizio riproduzione
Per iniziare a tracciare una sessione multimediale, chiama trackSessionStart
sull’istanza Media Heartbeat:
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
tiene traccia delle intenzioni di riproduzione dell’utente, non dell’inizio della riproduzione. Questa API viene utilizzata per caricare dati/metadati e per stimare la metrica QoS relativa al tempo di avvio (durata tra trackSessionStart
e trackPlay
).
Se non utilizzi contextData, invia semplicemente un oggetto vuoto per l’argomento data
in trackSessionStart
.
Tracciare l’inizio effettivo della riproduzione
Identifica l’evento dal lettore multimediale per l’inizio della riproduzione, dove viene eseguito il rendering del primo fotogramma del file multimediale sullo schermo ed effettua una chiamata trackPlay
.
tracker.trackPlay();
Tracciare il completamento della riproduzione
Identifica l’evento dal lettore multimediale per il completamento della riproduzione in cui l’utente ha guardato il contenuto fino alla fine ed effettua una chiamata trackComplete
.
tracker.trackComplete();
Tracciare la fine della sessione
Identifica l’evento dal lettore multimediale per lo scaricamento/la chiusura della riproduzione in cui l’utente chiude l’elemento multimediale e/o l’elemento multimediale viene completato e scaricato ed effettua una chiamata trackSessionEnd
.
tracker.trackSessionEnd();
trackSessionEnd
indica la fine di una sessione di tracciamento. Se la sessione è stata guardata correttamente fino al completamento, dove l’utente ha guardato il contenuto fino alla fine, assicurati che trackComplete
venga chiamato prima di trackSessionEnd
. Dopo trackSessionEnd
, qualsiasi chiamata API track*
viene ignorata, tranne la chiamata trackSessionStart
per una nuova sessione di tracciamento video.
Tracciare tutti gli scenari di pausa possibili
Identifica l’evento dal lettore multimediale per la pausa ed effettua una chiamata trackPause
.
tracker.trackPause();
Scenari di pausa
Identifica uno scenario in cui il lettore multimediale si interrompe e verifica che trackPause
sia chiamato correttamente. I seguenti scenari richiedono tutti una chiamata trackPause()
dall’app:
Identifica l’evento dal lettore per la riproduzione e/o la ripresa dalla pausa ed effettua una chiamata trackPlay
:
tracker.trackPlay();
Potrebbe trattarsi della stessa origine evento utilizzata nel passaggio 4. Quando la riproduzione riprende, assicurati che ogni chiamata API trackPause()
sia associata alla seguente chiamata API trackPlay()
.