Effectuer le suivi des publicités à l’aide de JavaScript 3.x track-ads-on-javascript

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

IMPORTANT
Si vous mettez en œuvre une version précédente du kit SDK, vous pouvez télécharger les Guides du développeur dans la rubrique Téléchargement des SDK.

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
    Nom de variable Type Description
    name string Chaîne non vide désignant le nom de la coupure publicitaire (pre-roll, mid-roll et post-roll).
    position number Position du nombre au début de la coupure publicitaire commençant par 1.
    startTime number Valeur du curseur de lecture au début de la coupure publicitaire.

    Création d’objet de coupure publicitaire :

    code language-js
    var adBreakObject =
      ADB.Media.createAdBreakObject(<ADBREAK_NAME>,
                                       <POSITION>,
                                       <START_TIME>);
    
  2. Appelez trackEvent() avec AdBreakStart dans l’instance MediaHeartbeat pour commencer le suivi de la coupure publicitaire :

    code language-js
    tracker.trackEvent(ADB.Media.Event.AdBreakStart, adBreakObject);
    
  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
    Nom de variable Type Description
    name string Chaîne non vide désignant le nom de l’annonce publicitaire.
    adId string Chaîne non vide désignant l’identifiant de l’annonce publicitaire.
    position number Position du numéro de l’annonce publicitaire dans la coupure publicitaire, en commençant par 1.
    length number Numéro positif désignant la longueur de l’annonce publicitaire.

    Création d’objet publicitaire :

    code language-js
    var adObject =
      ADB.Media.createAdObject.createAdObject(<AD_NAME>,
                                    <AD_ID>,
                                    <POSITION>,
                                    <LENGTH>);
    
  4. (Facultatif) Joignez des métadonnées standard et/ou publicitaires à 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 :

      code language-js
      /* Set context data */
      // Standard metadata keys provided by adobe.
      adMetadata[ADB.Media.AdMetadataKeys]  ="Sample Advertiser";
      adMetadata[ADB.Media.AdMetadataKeys] = "Sample Campaign";
      
      // Custom metadata keys
      adMetadata["affiliate"] = "Sample affiliate";
      adMetadata["campaign"] = "Sample ad campaign";
      adMetadata["creative"] = "Sample creative";
      
  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 :

    code language-js
    _onAdStart = function() {
        tracker.trackEvent(ADB.Media.Event.AdStart, adObject, adMetadata);
    };
    
  6. Lorsque la lecture de la publicité atteint la fin de la publicité, appelez trackEvent() avec l’événement AdComplete :

    code language-js
    _onAdComplete = function() {
        tracker.trackEvent(ADB.Media.Event.AdComplete);
    };
    
  7. 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 :

    code language-js
    _onAdSkip = function() {
        tracker.trackEvent(ADB.Media.Event.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 :

    code language-js
    _onAdBreakComplete = function() {
        tracker.trackEvent(ADB.Media.Event.AdBreakComplete);
    };
    

Consultez le scénario de suivi Lecture VOD avec publicités preroll pour en savoir plus.

Suivi granulaire des publicités

L’intervalle de ping des annonces par défaut est 10 seconds.

Vous pouvez configurer le suivi granulaire des publicités pour activer le suivi des publicités 1 second.

IMPORTANT
Ces informations doivent être fournies lors du démarrage d'une session de tracking.

Syntaxe

ADB.Media.MediaObjectKey = {
   GranularAdTracking: "media.granularadtracking"
   }

Exemple

var mediaObject = ADB.Media.createMediaObject("media-name", "media-id", 60, ADB.Media.StreamType.VOD, ADB.Media.MediaType.Video);

// Enable granular ad tracking
mediaObject[ADB.Media.MediaObjectKey.GranularAdTracking] = true;

tracker.trackSessionStart(mediaObject);
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb