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.
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 pre-roll, mid-roll et post-roll. | Oui |
position |
Position du nombre au début de la coupure publicitaire commençant par 1. | Oui |
startTime |
Valeur du curseur de lecture au début de la coupure publicitaire. | Oui |
Création d’objet de coupure publicitaire :
var adBreakObject =
MediaHeartbeat.createAdBreakObject(<ADBREAK_NAME>,
<POSITION>,
<START_TIME>);
Appelez trackEvent()
avec AdBreakStart
dans l’instance MediaHeartbeat
pour commencer le suivi de la coupure publicitaire :
mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakStart, adBreakObject);
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 |
Création d’objet publicitaire :
var adObject =
MediaHeartbeat.createAdObject(<AD_NAME>,
<AD_ID>,
<POSITION>,
<LENGTH>);
Vous pouvez joindre des métadonnées standard et/ou de publicité à la session de suivi multimédia par le biais de variables de données contextuelles.
Mise en œuvre de métadonnées de publicité standard sur JavaScript
Métadonnées de publicité personnalisées - Pour les métadonnées personnalisées, créez un objet de variable pour les variables de données personnalisées et renseignez les données de la publicité actuelle :
/* Set custom context data */
var adCustomMetadata = {
affiliate: "Sample affiliate",
campaign: "Sample ad campaign",
creative: "Sample creative"
};
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 :
_onAdStart = function() {
this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdStart,
adObject,
adCustomMetadata);
};
Lorsque la lecture de la publicité atteint la fin de la publicité, appelez trackEvent()
avec l’événement AdComplete
:
_onAdComplete = function() {
this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdComplete);
};
Si la lecture de la publicité ne s’est pas terminée car l’utilisateur a choisi d’ignorer la publicité, suivez l’événement AdSkip
:
_onAdSkip = function() {
this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.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 :
_onAdBreakComplete = function() {
this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakComplete);
};
Consultez le scénario de suivi Lecture VOD avec publicités preroll pour en savoir plus.