Les instructions suivantes fournissent des conseils pour la mise en œuvre à l’aide des kits SDK 2.x.
Si vous mettez en œuvre une version 1.x du kit SDK, vous pouvez télécharger les Guides du développeur 1.x dans la rubrique Téléchargement des SDK.
La lecture de publicité inclut le suivi des coupures publicitaires, des démarrages de publicité, des fins de publicité et des publicités ignorées. Utilisez l’API du lecteur multimédia pour identifier les événements de lecteur clés et spécifier les variables de publicité obligatoires et facultatives. Consultez la liste complète des métadonnées ici : Paramètres de publicité.
Y compris preroll
Créez une instance d’objet adBreak
pour la coupure publicitaire. Par exemple : adBreakObject
.
Appelez trackEvent
pour le démarrage de la coupure publicitaire avec adBreakObject
.
adObject
.adCustomMetadata
.trackEvent
pour le démarrage de publicité.trackEvent
pour la fin de publicité.trackEvent
pour le saut de publicité.trackEvent
pour la fin de la coupure publicitaire.Nom de constante | Description |
---|---|
AdBreakStart |
Constante permettant d’effectuer le suivi de l’événement AdBreak Start |
AdBreakComplete |
Constante permettant d’effectuer le suivi de l’événement AdBreak Complete |
AdStart |
Constante permettant d’effectuer le suivi de l’événement Début de la publicité |
AdComplete |
Constante permettant d’effectuer le suivi de l’événement Fin de la publicité |
AdSkip |
Constante permettant d’effectuer le suivi de l’événement Saut de publicité |
Identifiez le moment où la limite de coupure publicitaire commence, y compris preroll, et créez un AdBreakObject
à l’aide des informations de coupure publicitaire.
Référence AdBreakObject
:
Nom de variable | Description | Obligatoire |
---|---|---|
name |
Nom de la coupure publicitaire tel que preroll, mid-roll et post-roll. | Oui |
position |
Position du numéro de la coupure publicitaire dans le contenu, en commençant par 1. | Oui |
startTime |
Valeur du curseur de lecture au début de la coupure publicitaire. | Oui |
Appelez trackEvent()
avec AdBreakStart
dans l’instance MediaHeartbeat
pour commencer le suivi de coupure publicitaire.
Déterminez le moment où la publicité commence, puis créez une instance AdObject
à l’aide des informations sur la publicité.
Référence AdObject
:
Nom de variable | Description | Obligatoire |
---|---|---|
name |
Nom convivial de la publicité. | Oui |
adId |
Identifiant unique de la publicité. | Oui |
position |
Position du numéro de la publicité dans la coupure publicitaire, en commençant par 1. | Oui |
length |
Longueur de la publicité | Oui |
Vous pouvez joindre des métadonnées standard et/ou de publicité à la session de suivi par le biais de variables de données contextuelles.
Appelez trackEvent()
avec l’événement AdStart
dans l’instance MediaHeartbeat
pour commencer le suivi de la lecture de publicité.
Incluez une référence à votre variable de métadonnées personnalisées (ou un objet vide) comme troisième paramètre dans l’appel d’événement.
Lorsque la lecture de la publicité atteint la fin de la publicité, appelez trackEvent()
avec l’événement AdComplete
.
Si la lecture de la publicité ne s’est pas terminée car l’utilisateur a choisi d’ignorer la publicité, effectuez le suivi de l’événement AdSkip
.
S’il existe d’autres publicités dans le même AdBreak
, répétez les étapes 3 à 7.
Lorsque la coupure publicitaire est terminée, utilisez l’événement AdBreakComplete
pour en effectuer le suivi.
Veillez à NE PAS augmenter le curseur de lecture du lecteur de contenu (l:event:playhead
) pendant la lecture de la publicité (s:asset:type=ad
). Si vous le faites, les mesures de Temps passé sur le contenu seront affectées.
L’exemple de code suivant utilise le kit SDK JavaScript 2.x pour un lecteur multimédia 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);
};