Le istruzioni seguenti forniscono indicazioni per l’implementazione tramite gli SDK 2.x.
Se implementi una versione 1.x dell’SDK, puoi scaricare le guide per sviluppatori 1.x qui: Scaricare gli SDK.
La riproduzione degli annunci include il tracciamento delle interruzioni, gli avvii, i completamenti e i salti degli annunci. Utilizza l’API del lettore multimediale per identificare gli eventi chiave del lettore e popolare le variabili di annuncio obbligatorie e facoltative. Vedi l’elenco completo dei metadati qui: Parametri annuncio.
Inclusione del pre-roll
Crea un’istanza dell’oggetto adBreak
per l’interruzione dell’annuncio. Ad esempio, adBreakObject
.
Esegui la chiamata trackEvent
per l’avvio dell’annuncio con adBreakObject
.
adObject
.adCustomMetadata
.trackEvent
per l’avvio dell’annuncio.trackEvent
per l’annuncio completato.trackEvent
per il salto dell’annuncio.trackEvent
per l’interruzione annuncio completata.Nome costante | Descrizione |
---|---|
AdBreakStart |
Costante per il tracciamento dell’evento di avvio AdBreak |
AdBreakComplete |
Costante per il tracciamento dell’evento AdBreak Complete |
AdStart |
Costante per il tracciamento dell’evento Ad Start |
AdComplete |
Costante per il tracciamento dell’evento Ad Complete |
AdSkip |
Costante per il tracciamento dell’evento Ad Skip |
Identifica quando inizia il limite dell’interruzione dell’annuncio, incluso il pre-roll, e crea un AdBreakObject
utilizzando le informazioni sull’interruzione dell’annuncio.
Specifihe di AdBreakObject
:
Nome variabile | Descrizione | Obbligatorio |
---|---|---|
name |
Nome dell’interruzione dell’annuncio come pre-roll, mid-roll e post-roll. | Sì |
position |
La posizione numerica dell’interruzione pubblicitaria all’interno del contenuto, a partire da 1. | Sì |
startTime |
Valore della testina di riproduzione all’inizio dell’interruzione pubblicitaria. | Sì |
Esegui la chiamata trackEvent()
con AdBreakStart
nell’istanza MediaHeartbeat
per iniziare a tracciare l’interruzione dell’annuncio.
Identifica quando inizia l’annuncio e crea un’istanza AdObject
utilizzando le informazioni sull’annuncio.
Specifihe di AdObject
:
Nome variabile | Descrizione | Obbligatorio |
---|---|---|
name |
Nome descrittivo dell’annuncio. | Sì |
adId |
Identificatore univoco per l’annuncio. | Sì |
position |
La posizione numerica dell’annuncio all’interno dell’interruzione pubblicitaria, a partire da 1. | Sì |
length |
Lunghezza annuncio | Sì |
Facoltativamente, allega metadati standard e/o di annunci alla sessione di tracciamento tramite variabili di dati di contesto.
Esegui la chiamata trackEvent()
con l’evento AdStart
nell’istanza MediaHeartbeat
per iniziare a tracciare la riproduzione dell’annuncio.
Includi un riferimento alla variabile di metadati personalizzata (o a un oggetto vuoto) come terzo parametro nella chiamata dell’evento.
Quando la riproduzione dell’annuncio ne raggiunge la fine, esegui la chiamata trackEvent()
con l’evento AdComplete
.
Se la riproduzione dell’annuncio non è stata completata perché l’utente ha scelto di saltarlo, traccia l’evento AdSkip
.
Se ci sono annunci aggiuntivi all’interno dello stesso AdBreak
, ripeti di nuovo i passaggi da 3 a 7.
Al termine dell’interruzione pubblicitaria, utilizza l’evento AdBreakComplete
per tracciarla.
Assicurati di NON incrementare la testina di riproduzione del lettore di contenuti (l:event:playhead
) durante la riproduzione dell’annuncio (s:asset:type=ad
). Tale incremento influenzerebbe negativamente le metriche Tempo trascorso sul contenuto.
Il codice di esempio seguente utilizza l’SDK JavaScript 2.x per un lettore multimediale HTML5.
/* Call on ad break start */
if (e.type == "ad break start") {
var adBreakObject = MediaHeartbeat.createAdBreakObject("mid-roll", 2, 500);
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakStart, adBreakObject);
};
/* Call on ad start */
if (e.type == "ad start") {
var adObject = MediaHeartbeat.createAdObject("PepsiOne", "123456ab", 1, 30);
/* Set custom context data */
var adCustomMetadata = {
affiliate:"Sample affiliate",
campaign:"Sample ad campaign",
creative:"Sample creative"
}
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdStart, adObject, adCustomMetadata);
};
/* Call on ad complete */
if (e.type == "ad complete") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdComplete);
};
/* Call on ad skip */
if (e.type == "ad skip") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdSkip);
};
/* Call on ad break complete */
if (e.type == "ad break complete") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakComplete);
};