Extensión de Adobe Media Analytics for Audio and Video

Utilice esta documentación para obtener información sobre la instalación, configuración y implementación de la extensión de audio y vídeo de Adobe Media Analytics (extensión Media Analytics). Se incluyen las opciones disponibles al utilizar esta extensión para generar una regla, así como ejemplos y vínculos a muestras.

La extensión Media Analytics (MA) agrega el SDK principal de JavaScript Media SDK (SDK Media 2.x). This extension provides the functionality for adding the MediaHeartbeat tracker instance to an Adobe Experience Platform Launch site or project. La extensión de MA requiere dos extensiones adicionales:

IMPORTANTE

El seguimiento de audio requiere Analytics Extension v1.6 o superior.

Después de incluir las tres extensiones mencionadas anteriormente en el proyecto de inicio de plataforma, puede proceder de una de las dos maneras siguientes:

  • Use las API de MediaHeartbeat desde la aplicación web
  • Incluya o cree una extensión específica del reproductor que asigne eventos específicos del reproductor de medios a las API en la instancia de seguimiento de MediaHeartbeat. Esta instancia se expone a través de la extensión de MA.

Instale y configure la extensión de MA

  • Install: Para instalar la extensión MA, abra la propiedad de extensión, haga clic en Extensions > Catalog y coloque el puntero sobre Adobe Media Analytics for Audio and Video

    y seleccione Install.

  • Configure: Para configurar la extensión MA, abra la pestaña Extensions, pase el ratón sobre la extensión y, a continuación, haga clic en Configure:

Configuración de la extensión MA

Opciones de Configuration:

Opción Descripción
Tracking Server Define el servidor para rastrear latidos de medios (no es el mismo servidor que su Tracking Server de Analytics)
Application Version La versión del SDK/aplicación del reproductor de medios
Player Name Nombre del reproductor de medios en uso, por ejemplo, "AVPlayer", "HTML5 Player", "Mi reproductor personalizado"
Channel Propiedad del nombre del canal
Online Video Provider Nombre de la plataforma de vídeo en línea desde la que se distribuye el contenido
Debug Logging Habilitar o deshabilitar el registro
Enable SSL Habilitar o deshabilitar el envío de pings a través de HTTPS
Export APIs to Window Object Habilitar o deshabilitar la exportación de las API de Media Analytics al ámbito global
Variable Name Una variable que utiliza para exportar las API de Media Analytics en el objeto window

Recordatorio: La extensión de MA requiere las extensiones de Analytics y de Experience Cloud ID. También debe agregar estas extensiones a la propiedad de extensión y configurarlas.

Uso de la extensión MA

Uso de una página web/aplicación JS

La extensión MA exporta las API de MediaHeartbeat en el objeto window global activando la configuración "Export APIs to Window Object" en la página Configuration. Exporta las API bajo el nombre de la variable configurada. Por ejemplo, si el Variable Name está configurado para ser ADB, se puede acceder a MediaHeartbeat a través de window.ADB.MediaHeartbeat.

IMPORTANTE

La extensión de MA exporta las API solo cuando window["CONFIGURED_VARIABLE_NAME"] no está definido y tampoco anula las variantes existentes.

  1. Crear instancia de MediaHeartbeat: window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat.getInstance

    Parámetros: Un objeto delegado válido que expone estas funciones:

    Método Descripción
    getQoSObject() Devuelve la instancia theMediaObject que contiene la información actual de QoS. Se llamará varias veces a este método durante una sesión de reproducción. La implementación del reproductor debe devolver siempre los datos de QoS más recientes que haya disponibles.
    getCurrentPlaybackTime() Devuelve la posición actual del cabezal de reproducción. Para el seguimiento de vídeos VOD, el valor se especifica segundos después del comienzo del contenido multimedia. Para el seguimiento LIVE/LIVE, el valor se especifica en segundos desde el comienzo del programa.

    Valor devuelto: Promesa que se resuelve con una instancia de MediaHeartbeat o rechaza con un mensaje de error.

  2. Acceso a las constantes de MediaHeartbeat: window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat

    Esto expone todas las constantes y métodos estáticos de la clase MediaHeartbeat.

    Puede obtener el reproductor de muestra aquí: Reproductor de muestra MA. El reproductor de muestra actúa como referencia para exhibir cómo utilizar la extensión MA para admitir Media Analytics directamente desde una aplicación web.

  3. Cree la instancia de seguimiento de MediaHeartbeat como se indica a continuación:

    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.
    });
    

Uso de otras extensiones

La extensión MA expone los módulos compartidos de get-instance y media-heartbeat a otras extensiones. (Para obtener más información sobre los módulos compartidos, consulte Shared Modules documentation.)

IMPORTANTE

Solo se puede acceder a los módulos compartidos desde otras extensiones. Es decir, una aplicación web/JS no puede acceder a los módulos compartidos ni utilizar turbine (consulte la muestra de código que aparece a continuación) fuera de una extensión.

  1. Crear instancia de MediaHeartbeat: Módulo compartido de get-instance

    Parámetros:

    • Un objeto delegado válido que expone estas funciones:

      Método Descripción
      getQoSObject() Devuelve la instancia de MediaObject que contiene la información actual de QoS. Se llamará varias veces a este método durante una sesión de reproducción. La implementación del reproductor debe devolver siempre los datos de QoS más recientes que haya disponibles.
      getCurrentPlaybackTime() Devuelve la posición actual del cabezal de reproducción. Para el seguimiento de vídeos VOD, el valor se especifica segundos después del comienzo del contenido multimedia. Para el seguimiento LIVE/LIVE, el valor se especifica en segundos desde el comienzo del programa.
    • Un objeto de configuración opcional que expone estas propiedades:

      Propiedad Descripción Requerido
      Online Video Provider Nombre de la plataforma de vídeo en línea desde la que se distribuye el contenido. No. Si está presente, anula el valor definido durante la configuración de la extensión.
      Nombre del reproductor Nombre del reproductor de medios en uso, por ejemplo, "AVPlayer", "HTML5 Player", "Mi reproductor personalizado" No. Si está presente, anula el valor definido durante la configuración de la extensión.
      Canal Propiedad del nombre del canal No. Si está presente, anula el valor definido durante la configuración de la extensión.

    Valor devuelto: Promesa que se resuelve con una instancia de MediaHeartbeat o rechaza con un mensaje de error.

  2. Acceso a constantes de MediaHeartbeat: Módulo compartido de media-heartbeat

    Este módulo expone todas las constantes y los métodos estáticos de esta clase: https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript/MediaHeartbeat.html.

  3. Cree la instancia de seguimiento de MediaHeartbeat como se indica a continuación:

    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. Con la instancia de Media Heartbeat, siga la Documentación de Media SDK JS y la documentación de las API JS para implementar el seguimiento de medios.

Nota

Prueba: En esta versión, para probar la extensión debe cargarla en Adobe Experience Platform Launch, donde tiene acceso a todas las extensiones dependientes.

En esta página