DocumentationAnalyticsGuide de Media Analytics

Aperçu overview

Last update: Tue Jan 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • User
  • Admin
  • Developer

Les instructions suivantes fournissent des conseils pour la mise en œuvre à l’aide des kits SDK 2.x.

IMPORTANT
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é.

Événements du lecteur player-events

Au démarrage de la coupure publicitaire

NOTE
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.

À chaque démarrage de ressource de publicité

  • Créez une instance d’objet publicitaire pour la ressource de publicité. Par exemple : adObject.
  • Renseignez les métadonnées de publicité, adCustomMetadata.
  • Appelez trackEvent pour le démarrage de publicité.

À chaque fin de publicité

  • Appelez trackEvent pour la fin de publicité.

Lorsqu’une publicité est ignorée

  • Appelez trackEvent pour le saut de publicité.

À la fin de la coupure publicitaire

  • Appelez trackEvent pour la fin de la coupure publicitaire.

Mise en œuvre du suivi des publicités implement-ad-tracking

Constantes de suivi des publicités

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é

Procédure de mise en œuvre

  1. 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 :

    table 0-row-3 1-row-3 2-row-3 3-row-3 3-align-center 7-align-center 11-align-center 15-align-center
    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

  2. Appelez trackEvent() avec AdBreakStart dans l’instance MediaHeartbeat pour commencer le suivi de coupure publicitaire.

  3. 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 :

    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center
    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

  4. 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.

    • Métadonnées de publicité standard - Pour les métadonnées de publicité standard, créez un dictionnaire de paires clé-valeur de métadonnées de publicité standard à l’aide des clés pour votre plate-forme.
    • 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.

  5. 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.

  6. Lorsque la lecture de la publicité atteint la fin de la publicité, appelez trackEvent() avec l’événement AdComplete.

  7. 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.

  8. S’il existe d’autres publicités dans le même AdBreak, répétez les étapes 3 à 7.

  9. Lorsque la coupure publicitaire est terminée, utilisez l’événement AdBreakComplete pour en effectuer le suivi.

IMPORTANT
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);
};
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb