Présentation de l’extension Adobe Media Analytics for Audio and Video

REMARQUE

Adobe Experience Platform Launch est en train d’être rebaptisé en tant que suite de technologies de collecte de données dans Experience Platform. Ces modifications seront appliquées à l’ensemble de la documentation du produit au cours des prochaines semaines. Reportez-vous au document suivant pour une référence consolidée des modifications terminologiques.

Pour plus d’informations sur l’installation, la configuration et la mise en œuvre de l’extension Adobe Media Analytics for Audio and Video (extension Media Analytics), utilisez cette documentation. Les options disponibles lors de l’utilisation de cette extension pour créer une règle, ainsi que des exemples et des liens vers des exemples, sont inclus.

L’extension Media Analytics (MA) ajoute le SDK principal JavaScript Media (SDK Media 2.x). Cette extension permet d’ajouter l’instance MediaHeartbeat de suivi à un site ou à un projet Adobe Experience Platform Launch. L’extension MA requiert deux extensions supplémentaires :

IMPORTANT

Le suivi audio requiert l’extension Analytics version 1.6 ou ultérieure.

Après avoir inclus les trois extensions mentionnées ci-dessus dans votre projet Platform Launch, vous pouvez procéder de deux façons :

  • Utiliser les API MediaHeartbeat de votre application web
  • Inclure ou créer une extension spécifique au lecteur qui associe des événements de lecteur multimédia spécifiques aux API sur l’instance de suivi MediaHeartbeat. Cette instance est exposée via l’extension MA.

Installation et configuration de l’extension MA

  • Installer - Pour installer l’extension MA, ouvrez la propriété d’extension, sélectionnez Extensions > Catalogue, survolez l’extension Adobe Medium Analytics for Audio and Video avec la souris et sélectionnez Installer.

  • Configurer - Pour configurer l’extension MA, ouvrez l’onglet Extensionstab, survolez l’extension avec la souris, puis cliquez sur Configurer :

Configuration de l’extension MA

Options de configuration :

Option Description
Tracking Server Définit le serveur pour le suivi des pulsations multimédia (il ne s’agit pas du même serveur que votre serveur de suivi Analytics)
Application Version La version de l’application/du SDK du lecteur multimédia
Nom du lecteur Le nom du lecteur multimédia en cours d’utilisation (par exemple, « AVPlayer », « Lecteur HTML5 », « Mon lecteur personnalisé »)
Canal Propriété du nom de canal
Online Video Provider Nom de la plateforme vidéo en ligne sur laquelle le contenu est distribué
Debug Logging Activation ou désactivation de la journalisation
Enable SSL Activation ou désactivation de l’envoi de pings via HTTPS
Export APIs to Window Object Activer ou désactiver l’exportation des API Media Analytics vers la portée globale
Variable Name Une variable utilisée pour exporter les API de Media Analytics sous l’objet window

Rappel : l’extension MA requiert les extensions Analytics et Experience Cloud ID. Vous devez également ajouter ces extensions à la propriété de votre extension et les configurer.

Utilisation de l’extension MA

Utilisation depuis une page web/application JavaScript

L’extension MA exporte les API MediaHeartbeat dans l’objet global window en activant le paramètre "Export APIs to Window Object" sur la page Configuration . Il exporte les API sous le nom de variable configuré. Par exemple, si le nom de variable est configuré pour être ADB, vous pouvez alors accéder à MediaHeartbeat via window.ADB.MediaHeartbeat.

IMPORTANT

L’extension MA exporte les API uniquement lorsque window["CONFIGURED_VARIABLE_NAME"] n’est pas défini et ne remplace pas les variables existantes.

  1. Créer une instance MediaHeartbeat : window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat.getInstance

    Paramètres : un objet délégué valide exposant ces fonctions.

    Méthode Description
    getQoSObject() Retourne l’instance theMediaObject contenant les informations actuelles sur la qualité de service QoS. Cette méthode est appelée à plusieurs reprises au cours d’une session de lecture. La mise en œuvre du lecteur doit toujours retourner les plus récentes données QoS disponibles.
    getCurrentPlaybackTime() Renvoie la position actuelle du curseur de lecture. Pour le suivi VOD, la valeur est indiquée en secondes à partir du début de l’élément média. Pour le suivi LIVE/LIVE, la valeur est indiquée en secondes à partir du début du programme.

    Valeur renvoyée : une promesse qui est résolue avec une instance MediaHeartbeat ou rejetée avec un message d’erreur.

  2. Accéder aux constantes MediaHeartbeat : window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat

    Cette opération expose toutes les constantes et les méthodes statiques de la classe MediaHeartbeat.

    Vous pouvez obtenir l’exemple de lecteur ici : MA Sample Player. Le lecteur d’exemple fait office de référence pour expliquer comment utiliser l’extension MA pour prendre en charge directement Media Analytics à partir d’une application web.

  3. Créez l’instance de suivi MediaHeartbeat comme suit :

    var MediaHeartbeat = window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat;
    
    var delegate = {
        getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this),
        getQoSObject: this._getQoSObject.bind(this),
    };
    
    var config = {
        playerName: "Custom Player",
        ovp: "Custom OVP",
        channel: "Custom Channel"
    };
    
    var self = this;
    MediaHeartbeat.getInstance(delegate, config).then(function(instance) {
        self._mediaHeartbeat = instance;
        // Do Tracking using the MediaHeartbeat instance.
    }).catch(function(err){
        // Getting MediaHeartbeat instance failed.
    });
    

Utilisation à partir d’autres extensions

L’extension MA expose les modules partagés get-instance et media-heartbeat à d’autres extensions. (Pour plus d’informations sur les modules partagés, voir la documentation sur les modules partagés.)

IMPORTANT

Les modules partagés ne sont accessibles que depuis d’autres extensions. En d’autres termes, une page web ou une application JavaScript ne peuvent pas accéder aux modules partagés ni utiliser turbine (voir l’exemple de code ci-dessous) en dehors d’une extension.

  1. Créer une instance MediaHeartbeat get-instance : module partagé

    Paramètres :

    • Un objet délégué valide exposant ces fonctions :

      Méthode Description
      getQoSObject() Retourne l’instance MediaObject contenant les informations actuelles sur la qualité de service QoS. Cette méthode est appelée à plusieurs reprises au cours d’une session de lecture. La mise en œuvre du lecteur doit toujours retourner les plus récentes données QoS disponibles.
      getCurrentPlaybackTime() Renvoie la position actuelle du curseur de lecture. Pour le suivi VOD, la valeur est indiquée en secondes à partir du début de l’élément média. Pour le suivi LIVE/LIVE, la valeur est indiquée en secondes à partir du début du programme.
    • Un objet de configuration facultatif exposant ces propriétés :

      Propriété Description Obligatoire
      Fournisseur de vidéos en ligne Nom de la plateforme vidéo en ligne sur laquelle le contenu est distribué. Non. Le cas échéant, remplace la valeur définie pendant la configuration de l’extension.
      Nom du lecteur Le nom du lecteur multimédia en cours d’utilisation (par exemple, « AVPlayer », « Lecteur HTML5 », « Mon lecteur personnalisé ») Non. Le cas échéant, remplace la valeur définie pendant la configuration de l’extension.
      Canal Propriété du nom de canal Non. Le cas échéant, remplace la valeur définie pendant la configuration de l’extension.

    Valeur renvoyée : une promesse qui est résolue avec une instance MediaHeartbeat ou rejetée avec un message d’erreur.

  2. Accéder aux constantes MediaHeartbeat media-heartbeat : module partagé

    Ce module expose toutes les constantes et les méthodes statiques de cette classe : https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript/MediaHeartbeat.html.

  3. Créez l’instance de suivi MediaHeartbeat comme suit :

    var getMediaHeartbeatInstance =
      turbine.getSharedModule('adobe-video-analytics', 'get-instance');
    
    var MediaHeartbeat =
      turbine.getSharedModule('adobe-video-analytics', 'media-heartbeat');
      ...
    
    var delegate = {
        getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this),
        getQoSObject: this._getQoSObject.bind(this),
    }
    
    var config = {
        playerName: "Custom Player",
        ovp: "Custom OVP",
        channel: "Custom Channel"
    }
    ...
    
    var self = this;
    getMediaHeartbeatInstance(delegate, config).then(function(instance) {
        self._mediaHeartbeat = instance;
        ...
        // Do Tracking using the MediaHeartbeat instance.
    }).catch(function(err){
        // Getting MediaHeartbeat instance failed.
    });
    
    ...
    
  4. À l’aide de l’instance Pulsations multimédia, consultez la documentation JS du SDK multimédia et la documentation de l’API JS pour mettre en œuvre le suivi multimédia.

REMARQUE

Tests : pour tester votre extension dans cette version, vous devez télécharger votre extension sur Adobe Experience Platform Launch, où vous avez accès à toutes les extensions dépendantes.

Sur cette page