Suivi de la lecture principale à l’aide de JavaScript 3.x

Cette documentation aborde le suivi dans la version 3.x du SDK.

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

  1. Configuration initiale du suivi

    Déterminez le moment où l’utilisateur déclenche l’intention de lecture (l’utilisateur clique sur le bouton de lecture et/ou la lecture automatique est activée) et créez une instance MediaObject.

    API createMediaObject

    Nom de variable Type Description
    name chaîne Chaîne non vide désignant le nom du média.
    id chaîne Chaîne non vide désignant l’identifiant de média unique.
    length nombre Nombre positif désignant la longueur du média en secondes. Indiquez 0 si la longueur est inconnue.
    streamType chaîne
    mediaType Type de média (audio ou vidéo).

    StreamTypeConstantes :

    Nom de constante Description
    VOD Type de diffusion pour la vidéo à la demande.
    AOD Type de diffusion pour l’audio à la demande.

    MediaTypeConstantes :

    Nom de constante Description
    Audio Type de média pour les diffusions audio.
    Video Type de média pour les diffusions vidéo.
    var mediaObject = ADB.Media.createMediaObject(<MEDIA_NAME>,
                                      <MEDIA_ID,
                                      <MEDIA_LENGTH>,
                                      <STREAM_TYPE>,
                                      <MEDIA_TYPE>);
    
  2. Ajout de métadonnées

    Vous pouvez joindre des métadonnées standard et/ou personnalisées à la session de suivi par le biais de variables de données contextuelles.

    • Métadonnées standard

      REMARQUE

      Il est facultatif de joindre les métadonnées standard.

    • Métadonnées personnalisées

      Créez un objet de variable pour les variables personnalisées et renseignez les données de ce média. Par exemple :

      /* Set context data */
       var contextData = {};
      
       //Standard metadata
       contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode";
       contextData[ADB.Media.VideoMetadataKeys] = "Sample Show";
      
       //Custom metadata
       contextData["isUserLoggedIn"] = "false";
       contextData["tvStation"] = "Sample TV Station";
      
  3. Suivi de l’intention de démarrer la lecture

    Pour commencer le suivi d’une session multimédia, appelez trackSessionStart sur l’instance Media Heartbeat :

    var mediaObject = ADB.Media.createMediaObject("video-name",
                                                  "video-id",
                                                  60.0,
                                                  ADB.Media.StreamType.VOD,
                                                  ADB.Media.MediaType.Video);
    
    var contextData = {};
    
    //Standard metadata
    contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode";
    contextData[ADB.Media.VideoMetadataKeys] = "Sample Show";
    
    //Custom metadata
    contextData["isUserLoggedIn"] = "false";
    contextData["tvStation"] = "Sample TV Station";
    
    tracker.trackSessionStart(mediaObject, contextData);
    
    IMPORTANT

    trackSessionStart effectue le suivi de l’intention de lecture de l’utilisateur, et non du début de la lecture. Cette API est utilisée pour charger les données/métadonnées et estimer le temps jusqu’au démarrage de la mesure QoS (durée entre trackSessionStart et trackPlay).

    REMARQUE

    Si vous n’utilisez pas de données contextuelles, envoyez simplement un objet vide pour l’argument data dans trackSessionStart.

  4. Suivi du début réel de la lecture

    Identifiez l’événement du lecteur multimédia correspondant au début de la lecture, où la première image du média s’affiche à l’écran, et appelez trackPlay :

    tracker.trackPlay();
    
  5. Suivi de la fin de la lecture

    Identifiez l’événement du lecteur multimédia correspondant à la fin de la lecture, où l’utilisateur a visionné le contenu jusqu’à la fin, et appelez trackComplete :

    tracker.trackComplete();
    
  6. Suivi de la fin de la session

    Identifiez l’événement du lecteur multimédia correspondant au déchargement/à la fermeture de la lecture, où l’utilisateur ferme la vidéo et/ou le contenu média est terminé et déchargé, et appelez trackSessionEnd :

    tracker.trackSessionEnd();
    
    IMPORTANT

    trackSessionEnd marque la fin d’une session de suivi. Si la session a été visionnée jusqu’à la fin, où l’utilisateur a visionné le contenu jusqu’à la fin, assurez-vous que trackComplete est appelé avant trackSessionEnd. Tout autre appel à l’API track* est ignoré après trackSessionEnd, sauf trackSessionStart dans le cadre d’une nouvelle session de suivi.

  7. Suivi de tous les scénarios de mise en pause possibles

    Identifiez l’événement du lecteur multimédia pour le mettre en pause et appelez trackPause :

    tracker.trackPause();
    

    Scénarios de mise en pause

    Identifiez tous les scénarios dans lesquels le lecteur multimédia sera interrompu et assurez-vous que trackPause est correctement appelé. Les scénarios suivants exigent tous que votre application appelle trackPause() :

    • L’utilisateur appuie délibérément sur pause dans l’application.
    • Le lecteur se met en pause.
    • (Applications mobiles) : l’utilisateur place l’application en arrière-plan, mais vous souhaitez que l’application conserve la session ouverte.
    • (Applications mobiles) : tout type d’interruption système qui entraîne la mise en arrière-plan d’une application. Par exemple, l’utilisateur reçoit un appel ou une fenêtre contextuelle provenant d’une autre application apparaît, mais vous souhaitez que l’application conserve la session ouverte pour donner à l’utilisateur la possibilité de reprendre le média à partir du point d’interruption.
  8. Identifiez l’événement du lecteur correspondant à la lecture et/ou à la reprise après une interruption et appelez trackPlay :

    tracker.trackPlay();
    
    CONSEIL

    Il peut s’agir de la même source d’événement utilisée à l’étape 4. Assurez-vous que chaque appel de l’API trackPause() est suivi d’un appel de l’API trackPlay() à la reprise de la lecture.

  • Scénarios de suivi : lecture VOD sans publicité
  • Exemple de lecteur inclus avec le SDK JavaScript pour un exemple de suivi complet.

Sur cette page