soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Características: Data Collection API v2

    En este tema, obtendrá una visión general de la analítica Data Collection API v2, que le permite agregar eventos a su Video Cloud Datos analíticos en situaciones en las que Brightcove no puede rastrear los eventos directamente.

    Introducción

    Los datos analíticos son enviados automáticamente por la Brightcove Players, incluidos los proporcionados por el nativo Player SDK Si usted es no utilizando un Brightcove Player A laliver Video Cloud videos, necesita instrumentar el player está utilizando para enviar los datos al recopilador de datos.

    Data Collection API v2 es el estándar actual. La versión v1 está en desuso. Si tiene una implementación v1, vea el Cambios desde v1 sección a continuación.

    Además de esta descripción general y Referencia de la API, también mira esto implementación de muestra.

    La analítica Data Collection API es el punto final para eventos de análisis en tiempo real. Los datos de eventos se envían a Brightcove a través de una serie de parámetros enviados a través de solicitudes HTTP, como:

      http://metrics.brightcove.com/v2/tracker?event=video_view&domain=videocloud&account=123&video=789
      
      

    Estos parámetros describen una hecho sobre el estado del sistema cuando ocurrió un evento. El ejemplo anterior describe el hecho de que video_view evento ocurrido para video 789 para cuenta 123 (o: un usuario comenzó a mirar la cuenta 123video de 789. Ver indicadas a continuación para una descripción de los eventos analíticos actuales seguidos).

    DIMENSIONES

    Las dimensiones son hechos cualitativos sobre el estado del sistema cuando ocurre un evento. Por ejemplo, si la solicitud es:

      http://metrics.brightcove.com/tracker
      ?event=video_view&session=581136_2018-07-03T18:34:46.214Z
      &domain=videocloud&account=123
      &video=789
      
      

    La identificación del video ( 789) e ID de cuenta ( 123), y cualquier información de dispositivo y ubicación obtenida de la solicitud en sí misma son todas dimensiones relacionadas con el video_view evento. El sistema Analytics registrará que un video_view evento ocurrido cuando se realizó esta solicitud, con estas dimensiones.

    Parámetros de evento y dominio

    El event parámetro describe qué evento ha ocurrido. los domain parámetro proporciona un espacio de nombres para eventos. los event, domain y session son parámetros necesarios (el valor de domain es siempre videocloud).

    Parámetros adicionales

    Se deben incluir ciertos parámetros con los eventos para que el sistema de Analytics pueda analizarlos con éxito

    Tipos de respuesta

    La respuesta a una solicitud API de recopilación de datos analíticos incluye un código de respuesta HTTP y un mensaje legible por humanos.

    Código de estado HTTP Detalles Ejemplo
    200 La solicitud fue recibida con éxito por el recopilador y se ha conservado. (devuelve una imagen GIF transparente de 1x1 píxeles)
    400 A la solicitud enviada por el cliente le falta un parámetro requerido: domain, account or event. (Este estado no se devolverá si faltan parámetros específicos del dominio). "Invalid 'event' parameter"
    50x Este es un código de error que indica un problema en el lado del servidor. Su evento puede o no haber sido registrado exitosamente por el sistema de análisis. "Server-side failure, please retry."

    Datos mínimos

    Como mínimo, debe enviar un session id y video_view evento para cada video reproducido durante una sesión. los video_view debería enviado después cualquier anuncio pre-roll completo.

    session

    Este es el identificador de la sesión. los session es esencialmente una vista de una página o vista de aplicación que tiene un player en ella, mientras eso dure. El valor debe ser constante durante la sesión y enviado para todos los eventos. Debe estar lo más cerca posible de un identificador único global (GUID). Si hay colisiones, las dos sesiones se pueden descartar como no válidas si no se pueden desenredar.

    Hay varios esquemas para crear GUIDs en JavaScript. Un ejemplo esta en este repositorio de GitHub. Tenga en cuenta que Brightcove no admite scripts de terceros.

    Datos mínimos para el rendimiento (tasa de reproducción y Engagepuntuación de ment)

    Eventos

    • video_impression
    • video_view
    • video_engagement

    Atributos (todos los eventos)

    • account
    • video

    Atributos adicionales (video_engagement Solo evento)

    VOD
    • range
    • video_duration
    Live
    • video_seconds_viewed

    Encabezados HTTP

    • User-Agent - Requerido para informes de dispositivos

    Las Mejores Prácticas

    Para asegurarse de que está enviando los datos correctos al recopilador, debe probar el script de recopilación de datos antes de implementarlo en general. Nosotros recomendamos:

    1. Cree el script de recopilación de datos para su player.
    2. Pruebe en un ambiente controlado por al menos un día.
    3. Verifique los datos analíticos a través del Módulo Analytics o el Analytics API para asegurarse de que lo que se recogió coincide con sus expectativas.

    Envío de la solicitud, evitando problemas con CORS

    Datos basura

    En general, los datos enviados al recopilador serán registrados como verdad por el sistema de análisis. Si un evento contiene información incorrecta o incorrecta, el sistema de Analytics interpretará los datos incorrectamente.

    Por ejemplo, si accidentalmente envía la marca de tiempo como la identificación del video, sus datos analíticos estarán sesgados de manera que afecten al resumen general.

    URI Encoding

    Cualquier cadena que envíe a la Data Collection API que pueden contener espacios o caracteres especiales debe estar codificado por URI para que la solicitud tenga éxito. Si está enviando la solicitud a través de JavaScript, puede utilizar el encodeURI() método para codificar la cadena de solicitud. Por ejemplo:

      urlStr += "&video=" + currentVideo.id + "&video_name=" + encodeURI(currentVideo.video_name);
      
      

    Eventos

    Los eventos enumerados a continuación son procesados ​​por el sistema de análisis.

    player_load
    Intención / Significado

    A player la sesión ha sido iniciada por un usuario final. Esto marca el comienzo de la sesión de análisis y debe enviarse antes que cualquier otro evento.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=player_load
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %2Furl%3Fsa%3D-t%26rct%3Dj%26q%3D%26esrc%3Ds%26source
      %253A-%252F%252Fsupport.brightcove.com%252F%26ei%3D
      OdxWZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    error
    Intención / Significado

    Enviado cuando se encuentran errores fatales que interrumpen la experiencia de reproducción.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=error
      &error_code=MEDIA_ERR_SRC_NOT_SUPPORTED
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com
      %26usgWZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    catalog_request
    Intención / Significado

    Enviado cuando una solicitud a la Video Cloud Playback API está hecho.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=catalog_request
      &session=581136_2018-07-03T18:34:46.214Z
      &catalog_url=https%3A%2F%2Fedge.api.brightcove.com%2Fplayback
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com
      WZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud&account=1749339200
      &time=1377191644796
    catalog_response
    Intención / Significado

    Enviado cuando una respuesta a un previo catalog_request Esta recibido.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=catalog_response
      &session=581136_2018-07-03T18:34:46.
      &catalog_url=https%3A%2F%2Fedge.api.brightcove.com%2Fp2F23823423800
      &response_time_ms=243
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      53A-%252F%252Fsupport.brightcove.com%252F%2Tzn-oCgCQ
      AFQjCNJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    play_request
    Intención / Significado

    Se envía cuando la reproducción es iniciada por el usuario que hace clic expresamente en el botón de reproducción o automáticamente cuando la plataforma activa la reproducción en un escenario de reproducción automática. Tenga en cuenta que varios play_request Los eventos se pueden enviar durante una sola sesión de visualización si el espectador hace una pausa y reanuda el video.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=play_request
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com%252F%2
      dJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    ad_mode_begin
    Intención / Significado

    Enviado cuando la plataforma de reproducción entrega el control a un agente publicitario.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=ad_mode_begin
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com%252
      %26usg%3DAFQjCNEtLod%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    ad_mode_complete
    Intención / Significado

    Enviado cuando la plataforma de reproducción entrega el control a un agente publicitario.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=ad_mode_complete
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com%252F%2
      WZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    video_impression
    Intención / Significado

    Los metadatos de un video agregado a player ha terminado de cargar y el player está listo para activar el evento de visualización, ya sea mediante reproducción automática o interacción del usuario.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=video_impression
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A%2F%2Fwww.current-times.com%2F
      &time=1377191644801
      &source=http%3A%2F%2Fwww.google.com
      %252-F%26ei%3DoEYWUtCgEIXq9ATznoCgCQ
      %26usg%3DAFQjCNEtLod-Odx6bvm%3Dbv.5115-6542%2Cd.dmg
      &video=2621468623001
      &video_name=Democratic-Rivals%20Target%20Bill
      &domain=videocloud
      &account=1749339200
    video_view
    Intención / Significado

    Se ha comenzado a reproducir un video (ya sea de reproducción automática después de la carga o debido a la interacción del usuario). Tenga en cuenta que solo uno video_view El evento se graba durante una sesión de visualización incluso si el espectador se detiene y reinicia o reproduce el video.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=video_view
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A%2F%2Fwww.current-times.com%2F
      &video=2621468623001
      &video_name=Debate-2
      &video_duration=189
      &time=1377191666432
      &source=http%3A%2F%2Fwww.google.com%2Furl%
      %252F%26ei%3DoEYWUtCgEIXq9ATznoCgCQ%26us-g
      %3DAFQjCNEtv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
    video_engagement
    Intención / Significado

    Un usuario vio un rango de segundos de la línea de tiempo de un video. Este evento es un latido para el video de seguimiento engagey probablemente se enviará muchas veces durante la reproducción, según la interacción del usuario y la duración del video. los Brightcove player La instrumentación envía este evento cada 10 segundos, si la reproducción no se interrumpe. El sistema Analytics descarta los eventos que describen rangos durante 20 segundos.

    Ejemplo
    http://metrics.brightcove.com/tracker
      ?event=video_engagement
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A%2F%2Fwww.current-times.com%2F
      &video=2621468623001
      &video_name=Debate-2
      &video_duration=189
      &time=1377191676589
      &range=0..9
      &source=http%3A%2F%2Fwww.google.com
      %2Furl%3Fsa%3Dt-%26rct%3Dj%26q%3D%26esrc%3Ds
      %26source%3Dweb%26cd%3D1%26ved%3D0CDYQFjAA
      %26url%3Dhttp%253A%252F%252Fwww.current-times.com
      %252F%26ei%3DoEYWUtC-gEIXq9ATznoCgCQ
      %26usg%3DAFQjCNEtLodOdxWZSGdJpL7WJ.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200

    Parámetros para todos los eventos

    Los parámetros para estos eventos deben incluir cualquier información relevante al estado actual del sistema cuando ocurrió el evento, y ser lo más específico posible. Esta sección detalla los parámetros que pueden enviarse con todos los eventos, y las siguientes secciones muestran parámetros para eventos específicos.

    Campo Tipo Detalles
    account Cuerda

    ID de la cuenta

    domain Cuerda

    siempre igual a videocloud

    Valores permitidos: "videocloud"

    session Cuerda Una identificación de sesión que es lo más universal posible: consulte la Datos mínimos la sección de arriba para más información
    device_os opcional Cuerda

    Anular para especificar el sistema operativo del dispositivo que originó el evento en casos donde el agente de usuario no es confiable (ignorado a menos que se incluyan tanto el sistema operativo como el tipo de dispositivo o si el valor enviado no se encuentra en la lista de valores que se muestra aquí. No típicamente incluido)

    Valores permitidos: "android", "bada", "ios", "linux", "mac", "tv", "os_x", "rim", "sybian", "windows", "other"

    device_os_version opcional Cuerda

    La versión de os utilizada por el dispositivo. Cuando no se especifica, esto se calculará al analizar la cadena de agente de usuario para la solicitud de seguimiento

    device_type opcional Cuerda

    Anular para especificar el tipo de dispositivo que originó el evento en los casos en que el agente de usuario no es confiable (se ignora a menos que se incluyan tanto el sistema operativo como el tipo de dispositivo o si el valor enviado no se encuentra en la lista de valores que se muestra aquí. No típicamente incluido)

    Valores permitidos: "mobile", "tablet", "tv", "desktop", "other"

    event Cuerda

    el tipo de evento

    Valores permitidos: "player_load", "catalog_request", "catalog_response", "play_request", "ad_mode_begin", "ad_mode_complete", "video_impression", "video_view", "video_engagement", "error"

    destination opcional Cuerda

    URI que originó el evento

    source opcional Cuerda

    URI que envió al usuario final al destination URI

    time opcional Número

    la marca de tiempo para el evento en tiempo de época (milisegundos)

    country opcional Cuerda

    Región ISO-3166 (región alfa 2) Código de región cISO-3166 (alpha 2) (anular en caso de que el sistema no pueda detectar información geográfica desde la dirección IP) No típicamente incluido

    country_name opcional Cuerda

    Nombre de país legible por el ser humano (anular en caso de que el sistema no pueda detectar información geográfica desde la dirección IP) No típicamente incluido

    region opcional Cuerda

    Código de región ISO-3166 (alpha 2) (anulación en caso de que el sistema no pueda detectar información geográfica desde la dirección IP) No típicamente incluido

    region_name opcional Cuerda

    Nombre de región legible por humanos (anular en caso de que el sistema no pueda detectar información geográfica desde la dirección IP) No típicamente incluido

    city opcional Cuerda

    Nombre de la ciudad No típicamente incluido

    user opcional Cuerda

    Un identificador de usuario único, si no se proporciona o está en blanco, Video Cloud utiliza el método alternativo de usar el Source IP address + the User-Agent Cadena como el identificador único; Tenga en cuenta que Brightcove usa esta información solo para calcular usuarios únicos. Los datos del usuario en sí no se pueden recuperar a través de la API o el módulo de análisis

    Parámetro del usuario

    • Si la línea player/ client application quiere rastrear el visor único, debe enviar un ID único para el usuario como parámetro de usuario para el recopilador.
    • Si la línea user no se proporciona o está en blanco, utilizamos el método alternativo para usar Source IP address + the User-Agent String como el identificador único.
    • El valor del parámetro de usuario nunca se almacena en los registros / base de datos, solo se almacena un hash (usando SHA-256).
    • El coleccionista no establece cookies.

    Usuario único

    Puedes usar Brightcove PlayerLa funcionalidad del complemento para agregar datos únicos del visor de video a los análisis reportados. Para hacer esto, agregará un identificador único a la settings objeto de la funcionalidad analítica.

    Por supuesto, la forma en que se captura una identificación de usuario única varía de una aplicación a otra, pero para un ejemplo, este código supone que se captura una URL de inicio de sesión que contiene datos de usuario únicos, como http://exampledomain.com/users/912389123. Esta URL única se pasa al complemento.

    El siguiente código del complemento realiza las siguientes tareas:

    • Utiliza la sintaxis estándar para crear un Brightcove Player complemento con el nombre del complemento definido como uniqueUserForAnalyticsPlugin. El plugin también acepta una options objeto, que contiene datos pasados ​​al complemento.
    • El myPlayer variable se le asigna una referencia a la player. Además, se crean otras dos variables.
    • El userPath a la variable se le asigna la ruta pasada al complemento a través del options objeto.
    • El uniqueViewer variable se le asigna la versión analizada de la userPath, por lo que solo los dígitos de ID de usuario se asignan a la variable.
    • Se agrega una propiedad de usuario a los complementos de Analytics settings objeto.
      videojs.registerPlugin('uniqueUserForAnalyticsPlugin', function(options) {
      var myPlayer = this,
      userPath = '',
      uniqueViewer = '';
      //Assign uniqueViewer a value according to your app and business rules
      //In this example, parsing the path passed to the plugin in the options object
      userPath = options.path;
      uniqueViewer = userPath.substring( userPath.lastIndexOf('/') + 1 );
      //Assign a user variable to Analytic's settings object
      myPlayer.bcAnalytics.client.user(USER) = uniqueViewer;
      });
      
      

    Este código debería modificarse para adecuarse a la lógica de su aplicación y luego guardarse en una URL accesible a través de Internet.

    Desde Studio, usa el Plugins sección para cargar el complemento en el player, como se muestra.

    Sección de plugin de estudio
    Sección de plugin de estudio

    En lugar del JSON que sigue, pasaría al complemento la cadena que contiene los datos del usuario. Por supuesto, el código del complemento necesitaría actualizarse en consecuencia para extraer la identificación de usuario única.

      {
      "path": "http://exampledomain.com/users/912389123"
      }
      
      

    Para obtener más información sobre el desarrollo de complementos, consulte la Paso a paso: desarrollo de complementos documento.

    device_type, device_os, device_os_version, device_manufacturer y browser_type parámetros

    De manera predeterminada, el sistema Analytics intentará detectar el tipo de dispositivo y la información del sistema operativo desde el encabezado User-Agent. Si en device_type y device_os se envían, la información del encabezado User-Agent se ignorará a favor de device_type y device_os. En la mayoría de los casos, no necesita enviar información del dispositivo, sistema operativo ni del navegador - Esta anulación solo debe utilizarse si el User-Agent no es confiable o no está disponible.

    El sistema de Analytics registrará other si una solicitud incluye valores no reconocidos para anulaciones de parámetros del dispositivo.

    Parámetros de datos geográficos

    De forma predeterminada, el sistema Analytics intentará detectar información geográfica desde la dirección IP remota. Este comportamiento puede ser anulado pasando country, country_name, region, region_name, city y dma parámetros. En la mayoría de los casos, estos parámetros no son necesarios - Esta anulación solo debe utilizarse si la dirección IP remota no es confiable o no está disponible.

    El sistema de Analytics registrará ZZ or unknown si una solicitud incluye valores no reconocidos para reemplazos.

    Destino y fuente Parámetros

    El destination y source los parámetros proporcionan el URI que originó el evento ( destination) y el URI que envió al usuario allí ( source).

    El source parámetro se utiliza para determinar la información de fuente de tráfico. Si source no se especifica, el sistema de análisis tratará los eventos como iniciados por el tráfico directo.

    El destination El parámetro se usará para determinar la información de destino del tráfico, es decir, dónde se está viendo el video. Si el URI no contiene una autoridad, la API no registrará un destination_domain. El destination_path se registrará como la ruta en el URI.

    Durante la reproducción web, la URL en la barra de direcciones de la página donde se reproduce el video es destination, y la source es el referente ( top.document.referrer).

    Por ejemplo, al buscar "transmisión en vivo por cable" en el sitio de asistencia de Brightcove y ver un video que aparece en los resultados:

    Parámetro Valor
    source
      https://support.brightcove.com/en/video-cloud/search/live%20streaming%20wirecast
      
      
    destination
      https://support.brightcove.com/en/video-cloud/training-videos/live-streaming-wirecast
      
      

    Si no hay una URL (como en el caso de la reproducción nativa, por ejemplo), ambos destination y source deberían ser URI válidos que identifiquen dónde se reproduce el video y cómo llegó el usuario allí, respectivamente.

    Suponiendo que el destination es un programa que se imparte en URI válido:

      <scheme name> : <hierarchical part> [ ? <query> ] [ # <fragment> ]
      ex. https://www.example.com/foo/bar/baz
      --------------/----------/
      |             |
      authority        path
      ---/    -------------------------/
      |                |
      scheme       hierarchical part
      
      

    el sistema de Analytics lo manejará de la siguiente manera:

    Si el URI contiene un autoridad, la respuesta de API usará esa autoridad como destination_domain y cualquier camino proporcionado como el destination_path. Si el URI no contiene una autoridad, la API no registrará un destination_domain. El destination_path se registrará como la ruta en el URI. UN destination sin una parte jerárquica (por ejemplo, solo un esquema) se considera inválido, como cualquier valor sin un esquema.

    Parámetros para eventos específicos

    parámetros de evento de error

    Los siguientes parámetros deben enviarse con error eventos.

    Campo Tipo Detalles
    error_code opcional Número

    Un código de error específico de la plataforma asociado con el evento

    parámetros de evento catalog_request

    Los siguientes parámetros deben enviarse con catalog_request eventos.

    Campo Tipo Detalles
    catalog_url opcional Cuerda

    La URL de destino asociada con el evento catalog_request

    parámetros del evento catalog_response

    Los siguientes parámetros deben enviarse con catalog_response eventos.

    Campo Tipo Detalles
    catalog_url opcional Cuerda

    La URL de destino asociada con el evento catalog_request que inició esta respuesta

    response_time_ms opcional Número

    El tiempo, en milisegundos, entre el evento catalog_request y el evento catalog_response

    parámetros del evento video_impression

    Los siguientes parámetros deben enviarse con video_impression eventos.

    Campo Tipo Detalles
    video opcional Cuerda

    el video id

    video_name opcional Cuerda

    el nombre del video

    parámetros del evento video_view

    Los siguientes parámetros deben enviarse con video_view eventos.

    Campo Tipo Detalles
    video opcional Cuerda

    el video id

    video_name opcional Cuerda

    el nombre del video

    start_time_ms opcional Cuerda

    El tiempo, en milisegundos, entre el inicio de la reproducción y el primer fotograma del video que se está procesando. Esto puede ser diferente dependiendo de la experiencia, por ejemplo, si no hay anuncios pre-roll configurados, esta medida es el tiempo entre el play_request y video_view eventos. Si hay un anuncio pre-roll, el tiempo entre ad_mode_begin y ad_mode_complete no debe ser incluido

    parámetros del evento video_engagement

    Los siguientes parámetros deben enviarse con video_engagement eventos.

    Campo Tipo Detalles
    video opcional Cuerda

    el video id

    video_name opcional Cuerda

    el nombre del video

    range opcional Cuerda

    El rango del video visto para video_engagement eventos en el formato StartSecond..EndSecond (los valores StartSecond y EndSecond deben ser números enteros [integers]): el rango puede dejarse fuera de un evento de interacción para mostrar que durante el período cubierto por el evento, no hubo actividad de visualización. (por ejemplo, cuando solo hay actividad de reaparación de buffer)

    rendition_url opcional Cuerda

    La url de la versión más recientemente seleccionada. Por ejemplo, para una secuencia HLS, esta sería la URL de la variante seleccionada más recientemente.

    rendition_indicated_bps opcional Cuerda

    La velocidad de bits indicada, en bits por segundo, de la versión más recientemente seleccionada

    rendition_mime_type opcional Cuerda

    El tipo de mimo de la versión más recientemente seleccionada

    rendition_height opcional Cuerda

    La altura codificada de la reproducción de video en píxeles

    rendition_width opcional Cuerda

    El ancho codificado de la reproducción de video en píxeles

    rebuffering_seconds opcional Cuerda

    La cantidad de segundos que el usuario pasó esperando a que se reproduzca el video debido a un retraso no solicitado durante el período de interacción

    rebuffering_count opcional Cuerda

    El número de veces que se detuvo la reproducción debido al reajuste de la memoria intermedia durante el retraso del período de compromiso representado durante el período de compromiso

    forward_buffer_seconds opcional Cuerda

    La cantidad de segundos de video que actualmente residen en el buffer directo

    measured_bps opcional Cuerda

    La proporción entre el número de bits incluidos en el segmento descargado más recientemente y el tiempo empleado en descargar ese segmento, en bits por segundo

    player_width opcional Cuerda

    El ancho de píxel actual de la player al final de engagerango de ment

    player_height opcional Cuerda

    La altura de píxel actual de la player al final de engagerango de ment

    dropped_frames opcional Cuerda

    dropped_frames

    video_duration opcional Número

    la duración del video en segundos

    video_seconds_viewed opcional Número

    recuento de segundos observados desde la última actualización de video_engagement eventos

    El video_engagement el evento es un medio de seguimiento de video engagemientras se reproduce un video, y es probable que se envíe muchas veces durante la reproducción. (El Flash / HTML5 player la instrumentación envía este evento cada 10 segundos, si la reproducción no se interrumpe). Actualmente, el sistema Analytics descarta los eventos que describen intervalos de más de 20 segundos, por lo que es necesario enviar estos eventos con mayor frecuencia.

    Hay dos formas que video_engagement el evento puede tomar (otros parámetros omitidos por brevedad):

    Ejemplo Sentido
      event=video_engagement&video=123&video_duration=75&range=0..9
      
      
    Video 123 con una duración de 75 segundos reproducidos de 0 a 9 (durante un total de 10 segundos visualizados).
    event=video_engagement&video=123&video_seconds_viewed=10 Segundo 10 de vídeo 123 nosotros revisamos.

    Mientras que ambas versiones rastrean segundos vistos, la versión que incluye video_duration y range también contiene información necesaria para calcular datos de participación adicionales, y es la forma preferida para enviar video_engagement Datos del evento al sistema Analytics. Para transmisiones en vivo, o en los casos en que la línea de tiempo del video cambia continuamente durante la reproducción o no es confiable, video_seconds_viewed Serán los únicos datos disponibles. Para VOD, a menos que duration no está disponible, el video_engagement evento debe incluir video_duration y range.

    parámetros Métricas de compromiso derivado (API)
    video_duration, range video_seconds_viewed, video_percent_viewed, engagement_score; datos de curva de compromiso
    video_seconds_viewed video_seconds_viewed

    Si los tres parámetros ( video_duration, range y video_seconds_viewed) se envían junto con un video_engagement evento, el sistema de Analytics calculará las métricas de participación de la video_duration+ range parámetros.

    Cambios de V2

    Esta sección proporciona un resumen de los cambios de v1 a v2 del Recopilador de datos para aquellos que han estado usando v1.

    URL base para rastreador

      http(s)://metrics.brightcove.com/v2
      
      

    Campos adicionales admitidos en todos los eventos:

    device_os_version: La versión del sistema operativo que usa el dispositivo. Cuando no se especifica, esto se calculará al analizar la cadena de agente de usuario para la solicitud de seguimiento.

    platform_version: Se utiliza para indicar que se está utilizando una nueva versión de la plataforma especificada para enviar los eventos.

    Nuevos eventos para V2

    catalog_request: Se envía cuando se realiza una solicitud a la api de catálogo de videocloud; tenga en cuenta que este evento es para uso interno y no se expone en el Módulo de análisis ni a través de Analytics API.

    • catalog_url: La URL de destino asociada con el catalog_request evento: tenga en cuenta que este evento es para uso interno y no está expuesto en el Módulo de análisis o a través de Analytics API..

    catalog_response: Enviado cuando una respuesta a un previo catalog_request se recibe: tenga en cuenta que este evento es para uso interno y no está expuesto en el Módulo de análisis o a través de Analytics API.

    • catalog_url: La URL de destino asociada con el catalog_request evento que inició esta respuesta; tenga en cuenta que este evento es para uso interno y no se expone en el Módulo de análisis ni a través de Analytics API..
    • response_time_ms: El tiempo, en milisegundos, entre catalog_request evento y el catalog_response evento: tenga en cuenta que este evento es para uso interno y no está expuesto en el Módulo de análisis o a través de Analytics API..

    play_request: Enviado cuando la reproducción es iniciada por el usuario haciendo clic en el botón de reproducción, o automáticamente cuando la plataforma activa la reproducción en un escenario de reproducción automática.

    ad_mode_begin: [Reemplaza ad_start] Enviado cuando la plataforma de reproducción entrega el control a un agente publicitario.

    ad_mode_complete: [Reemplaza ad_end] Enviado cuando el agente de publicidad devuelve el control a la plataforma de reproducción.

    error: Enviado cuando se encuentran errores fatales que interrumpen la experiencia de reproducción.

    • código de error: Un código de error específico de la plataforma asociado con el evento.

    Eventos actualizados para V2

    video_view: Incluye nuevas medidas de latencia

    • load_time_ms: El tiempo, en milisegundos, entre iniciar la carga de datos para que el video y el video se puedan reproducir.
    • start_time_ms: El tiempo, en milisegundos, entre el inicio de la reproducción y el primer fotograma del video que se está procesando. Esto puede ser diferente según la experiencia, por ejemplo, si no hay anuncios pre-roll configurados, esta medida es el tiempo entre el 'play_request' y video_view eventos. Si hay un anuncio pre-roll, el tiempo entre ad_mode_begin y ad_mode_complete no debe ser incluido.

    video_engagement: Incluye selección de reproducción adicional, medidas de tasa de bits e información de almacenamiento en búfer. También se realizó un cambio sutil en la participación del video, ya que se debe enviar periódicamente aunque no se haya visto durante el período de interacción. Este cambio es para permitir el seguimiento de retrasos y recuentos de almacenamiento en memoria intermedia que hacen que los usuarios esperen la reproducción.

    • distancia: El parámetro de rango ahora es opcional, el rango puede dejarse fuera de un evento de compromiso para mostrar que durante el período cubierto por el evento, no hubo actividad de visualización. (por ejemplo, cuando solo hay actividad de reaparación de buffer)
    • rendition_url: La url de la versión más recientemente seleccionada. Por ejemplo, para una transmisión HLS, esta sería la URL de la variante seleccionada más recientemente.
    • rendition_indicated_bps: La velocidad de bits indicada, en bits por segundo, de la versión seleccionada más recientemente.
    • rendition_mime_type: El tipo de mimo de la versión más recientemente seleccionada.
    • rendition_height: La altura codificada de la reproducción de video en píxeles
    • rendition_width: El ancho codificado de la reproducción de video en píxeles
    • rebuffering_seconds: La cantidad de segundos que el usuario pasó esperando a que se reproduzca el video debido a un retraso no solicitado durante el período de interacción.
    • rebuffering_count: El número de veces que se detuvo la reproducción debido al reajuste de la memoria intermedia durante el período de interacción representado.
    • forward_buffer_seconds: La cantidad de segundos de video que actualmente reside en el búfer de reenvío.
    • mide_bps: La proporción entre el número de bits incluidos en el segmento descargado más recientemente y el tiempo que se tarda en descargar ese segmento, en bits por segundo.
    • player_anchura El ancho de píxel actual de la player al final de engagerango de ment.
    • player_altura La altura de píxel actual de la player al final de engagerango de ment.
    • dropped_frames: La cantidad de fotogramas que se eliminaron de la reproducción de video durante este período de interacción

    Página actualizada por última vez el 25 Nov 2020