Descripción general: API de recopilación de datos v2

En este tema, obtendrá una descripción general de Analytics Data Collection API v2, que le permite agregar eventos a sus datos de Brightcove Analytics en situaciones en las que Brightcove no puede realizar un seguimiento de los eventos directamente.

Introducción

Brightcove Players envía automáticamente los datos de análisis, incluidos los proporcionados por los SDK de Native Player. Si usted es no Si usa un reproductor Brightcove para entregar videos de Video Cloud, debe instrumentar el reproductor que está usando para enviar los datos al recopilador de datos.

La API de recopilación de datos v2 es el estándar actual. La versión v1 está obsoleta. Si tiene una implementación v1, consulte la Cambios de v1 sección siguiente.

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

La API de recopilación de datos de análisis es el punto final para los eventos de análisis en tiempo real. Los datos del evento se envían a Brightcove a través de una serie de parámetros enviados a través de solicitudes HTTP, como:

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

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

Dimensiones

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

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

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

Parámetros de dominio y evento

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

Parámetros adicionales

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

Tipos de respuesta

La respuesta a una solicitud de 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 Descripción Ejemplo
200 La solicitud fue recibida con éxito por el recopilador y se ha mantenido. (devuelve una imagen GIF transparente de 1x1 píxeles)
400 A la solicitud enviada por el cliente le falta un parámetro obligatorio: domain , account o 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 con éxito por el sistema de análisis. "Server-side failure, please retry."

VOD y eventos en vivo

Eventos en vivo

Se deben cumplir las siguientes condiciones para que la API de recopilación de datos clasifique un evento como Vivir:

  • La solicitud debe no tener el parámetro video_duration.
  • La solicitud debe tener un parámetro de cuenta.
  • La solicitud debe tener un parámetro de video.
  • El tipo de evento debe ser uno de los siguientes:
    • play_request
    • video_impression
    • video_view
    • video_engagement
    • alive_ss_ad_start
  • La cuenta debe estar habilitada por Brightcove Support for Live Video Streaming.

VOD

  • debe incluir la video_duration con peticiones solo para VOD. Nunca envíe un video_duration para transmisiones en vivo.
  • Cualquier solicitud que contenga un video_duration El parámetro se clasificará como VOD.

Datos mínimos

Como mínimo, debe enviar un session id y video_view evento para cada video reproducido durante una sesión. La video_view debería enviar después cualquier anuncio previo al video completo.

session

Este es el identificador de sesión. La session es esencialmente una vista de una página o vista de una aplicación que tiene un reproductor, mientras 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 pueden descartarse como inválidas si no se pueden desenredar.

Existen varios esquemas para crear GUID en JavaScript. Un ejemplo está 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 puntuación de participación)

Eventos

  • video_impression
  • play_request
  • video_view
  • video_engagement

Atributos (todos los eventos)

  • account
  • video

Atributos adicionales (video_engagement Solo evento)

VOD
  • range
  • video_duration
Vivir
  • video_seconds_viewed

Encabezados HTTP

  • User-Agent- Obligatorio para los informes de dispositivos

Mejores prácticas

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

  1. Cree el script de recopilación de datos para su reproductor.
  2. Pruebe en un ambiente controlado durante al menos un día.
  3. Verifique los datos de análisis a través del Módulo de análisis o el Analytics API para asegurarse de que lo recopilado coincida con sus expectativas.

Envío de la solicitud: evitar problemas de CORS

Datos basura

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

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

Codificación URI

Cualquier cadena que envíe a la API de recopilación de datos que pueda contener espacios o caracteres especiales debe estar codificado en URI para que la solicitud tenga éxito. Si envía la solicitud a través de JavaScript, puede utilizar el encodeURI() el método codifica la cadena de solicitud. Por ejemplo:

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

Eventos

El sistema de análisis procesa los eventos que se enumeran a continuación.

player_load
Intención / Significado

Un usuario final ha iniciado una sesión de jugador. Esto marca el comienzo de la sesión de análisis y debe enviarse antes de cualquier otro evento.

Ejemplo
https://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

Se envía cuando se encuentran errores fatales que interrumpen la experiencia de reproducción.

Ejemplo
https://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

Se envía cuando se realiza una solicitud a la API de reproducción de Video Cloud.

Ejemplo
https://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 anterior catalog_request Esta recibido.

Ejemplo
https://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 haciendo 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
https://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
  &video_duration=189
  &time=1377191644796
ad_mode_begin
Intención / Significado

Se envía cuando la plataforma de reproducción cede el control a un agente de publicidad.

Ejemplo
https://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

Se envía cuando la plataforma de reproducción cede el control a un agente de publicidad.

Ejemplo
https://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 al reproductor han terminado de cargarse y el reproductor está listo para activar el evento de visualización, ya sea a través de la reproducción automática o la interacción del usuario.

Ejemplo
https://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
  &video_duration=189
  &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
https://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 rastrear la interacción de vídeo y es probable que se envíe muchas veces durante la reproducción, según la interacción del usuario y la duración del vídeo. La instrumentación del reproductor Brightcove envía este evento cada 10 segundos, si la reproducción no se interrumpe. El sistema de Analytics descarta los eventos que describen rangos de más de 20 segundos.

Ejemplo
https://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íficos posible. Esta sección detalla los parámetros que se pueden enviar con todos los eventos, y las siguientes secciones muestran los parámetros para eventos específicos.

Campo Tipo Descripción
account Cadena

ID de la cuenta

domain Cadena

siempre igual a videocloud

Valores permitidos: "videocloud"

session Cadena Un ID de sesión que sea lo más universalmente único posible; consulte la Datos mínimos sección anterior para obtener más información
device_os opcional Cadena

Anular para especificar el sistema operativo del dispositivo que originó el evento en los casos en que el agente de usuario no sea confiable (ignorado a menos que se incluyan tanto el sistema operativo como el tipo de dispositivo o si el valor enviado no está en la lista de valores que se muestra aquí. Normalmente no incluido)

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

device_os_version opcional Cadena

La versión del sistema operativo que utiliza el dispositivo. Cuando no se especifica, esto se calculará analizando la cadena del agente de usuario para la solicitud de seguimiento

device_type opcional Cadena

Anular para especificar el tipo de dispositivo que originó el evento en los casos en que el agente de usuario no sea confiable (ignorado a menos que se incluyan tanto el sistema operativo como el tipo de dispositivo o si el valor enviado no está en la lista de valores que se muestra aquí. Normalmente no incluido)

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

event Cadena

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 Cadena

URI que originó el evento

source opcional Cadena

URI que envió al usuario final al destination URI

time opcional Número

la marca de tiempo del evento en tiempo de época (milisegundos)

country opcional Cadena

Código de región ISO-3166 (alfa 2) cISO-3166 (alfa 2) (anular en caso de que el sistema no pueda detectar información geográfica de la dirección IP) Normalmente no incluido

country_name opcional Cadena

Nombre de país legible por humanos (anular en caso de que el sistema no pueda detectar información geográfica de la dirección IP) Normalmente no incluido

region opcional Cadena

Código de región ISO-3166 (alfa 2) (anular en caso de que el sistema no pueda detectar información geográfica de la dirección IP) Normalmente no incluido

region_name opcional Cadena

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

city opcional Cadena

Nombre de la ciudad Normalmente no incluido

user opcional Cadena

Un identificador de usuario único: si no se proporciona o está en blanco, Video Cloud utiliza el método alternativo Source IP address + the User-Agent Cadena como identificador único; Tenga en cuenta que Brightcove utiliza 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 de usuario

  • Si la aplicación cliente / reproductor desea rastrear al espectador único, debe enviar una identificación única para el usuario como parámetro de usuario al recopilador.
  • Si el user no se proporciona o está en blanco, utilizamos el método alternativo de utilizar el Source IP address + the User-Agent String como 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 recopilador no establece cookies.

Usuario único

Puede utilizar la función de complemento de Brightcove Player para agregar datos únicos del visor de video a los análisis informados. Para hacer esto, agregará un identificador único al settings objeto de la funcionalidad analítica.

Por supuesto, la forma en que se captura una ID de usuario única varía de una aplicación a otra, pero, por ejemplo, este código asume que se captura una URL de inicio de sesión que contiene datos de usuario únicos, como https://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 complemento de Brightcove Player con el nombre del complemento definido como uniqueUserForAnalyticsPlugin. El complemento también acepta un options objeto, que contiene datos pasados al complemento.
  • La myPlayer A la variable se le asigna una referencia al jugador. Además, se crean otras dos variables.
  • La userPath A la variable se le asigna la ruta pasada al complemento a través de la 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 al complemento 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 adaptarse a la lógica de su aplicación y luego guardarse en una URL accesible desde Internet.

Desde Studio, use el Complementos sección para cargar el complemento en el reproductor, como se muestra.

Sección de complementos de Studio
Sección de complementos de Studio

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 debería actualizarse en consecuencia para extraer la ID de usuario única.

  {
  "path": "https://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 forma predeterminada, el sistema de análisis intentará detectar el tipo de dispositivo y la información del sistema operativo desde el encabezado User-Agent. Si ambas cosas 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 es necesario enviar información sobre el dispositivo, el sistema operativo y el navegador. - esta anulación solo debe usarse si el agente de usuario no es confiable o no está disponible.

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

Parámetros de datos geográficos

De forma predeterminada, el sistema de análisis intentará detectar información geográfica desde la dirección IP remota. Este comportamiento se puede anular 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 usarse si la dirección IP remota no es confiable o no está disponible.

El sistema de análisis registrará ZZ o unknown si una solicitud incluye valores no reconocidos para anulaciones.

Parámetros de origen y destino

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

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

La destination El parámetro se utilizará para determinar la información del destino del tráfico, es decir, dónde se está viendo el video. Si el URI no contiene una autoridad, la API no registrará una destination_domain. La 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 la destination , y el source es el referente ( top.document.referrer).

Por ejemplo, cuando busque "transmisión por cable en vivo" en el sitio de soporte de Brightcove y vea 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 deben ser URI válidos que identifiquen dónde se está reproduciendo el video y cómo llegó el usuario, respectivamente.

Asumiendo el destination es un 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 la API usará esa autoridad como la destination_domain y cualquier camino provisto como el destination_path. Si el URI no contiene una autoridad, la API no registrará una destination_domain. La destination_path se registrará como la ruta en el URI. A destination sin una parte jerárquica (por ejemplo, solo un esquema) se considera inválido, al igual que 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 Descripción
error_code opcional Número

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

parámetros del evento catalog_request

Los siguientes parámetros deben enviarse con catalog_request eventos.

Campo Tipo Descripción
catalog_url opcional Cadena

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 Descripción
catalog_url opcional Cadena

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 Descripción
video opcional Cadena

la identificación del video

video_name opcional Cadena

el nombre del video

parámetros del evento video_view

Los siguientes parámetros deben enviarse con video_view eventos.

Campo Tipo Descripción
video opcional Cadena

la identificación del video

video_name opcional Cadena

el nombre del video

start_time_ms opcional Cadena

El tiempo, en milisegundos, entre el inicio de la reproducción y el primer fotograma del video que se procesa. 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

parámetros del evento video_engagement

Los siguientes parámetros deben enviarse con video_engagement eventos.

Campo Tipo Descripción
video opcional Cadena

la identificación del video

video_name opcional Cadena

el nombre del video

range opcional Cadena

el rango del video visto durante video_engagement eventos en el formato StartSecond..EndSecond (los valores StartSecond y EndSecond deben ser números enteros [enteros]) - el rango se puede dejar fuera de un evento de participació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 reabastecimiento)

rendition_url opcional Cadena

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

rendition_indicated_bps opcional Cadena

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

rendition_mime_type opcional Cadena

El tipo de mímica de la versión seleccionada más recientemente.

rendition_height opcional Cadena

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

rendition_width opcional Cadena

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

rebuffering_seconds opcional Cadena

La cantidad de segundos que el usuario pasó esperando la reproducción del video debido a un retraso no solicitado durante el período de participación.

rebuffering_count opcional Cadena

El número de veces que la reproducción se detuvo debido a la re-almacenamiento en búfer durante el período de participación representado, el retraso durante el período de participación

forward_buffer_seconds opcional Cadena

La cantidad de segundos de video que residen actualmente en el búfer de reenvío

measured_bps opcional Cadena

La relación entre la cantidad de bits incluidos en el segmento descargado más recientemente y el tiempo dedicado a descargar ese segmento, en bits por segundo

player_width opcional Cadena

El ancho de píxel actual del jugador al final del rango de interacción

player_height opcional Cadena

La altura de píxel actual del jugador al final del rango de interacción

dropped_frames opcional Cadena

drop_frames

video_duration opcional Número

la duración del video en segundos

video_seconds_viewed opcional Número

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

La video_engagement El evento es un medio para rastrear la participación del video mientras se reproduce un video, y probablemente se enviará muchas veces durante la reproducción. (La instrumentación del reproductor Flash/HTML5 envía este evento cada 10 segundos, si la reproducción no se interrumpe). En la actualidad, los eventos que describen rangos superiores a 20 segundos son descartados por el sistema Analytics, por lo que es necesario enviar estos eventos con mayor frecuencia.

Hay dos formas en las que un video_engagement evento puede tomar (otros parámetros se omiten por brevedad):

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

Si bien ambas versiones registran los 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 mandar video_engagement datos de eventos al sistema de análisis. Para transmisiones en vivo, o en los casos en los 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 el evento debe incluir video_duration y range.

Parámetros Métricas de participación derivadas (API)
video_duration, range video_seconds_viewed, video_percent_viewed , engagement_score ; datos de la 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 análisis calculará las métricas de participación a partir de la video_duration+ range parámetros

Cambios 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 el rastreador

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

Campos adicionales admitidos en todos los eventos:

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

plataforma_versión: 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 del catálogo de videoclips; 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 la API de análisis.

  • catalog_url: La URL de destino asociada con el catalog_request evento: 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 la API de análisis.

catalog_response: Enviado cuando una respuesta a un anterior catalog_request se recibe: 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 la API de análisis.

  • 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 la API de análisis.
  • response_time_ms: El tiempo, en milisegundos, entre el catalog_request evento y el catalog_response evento: 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 la API de análisis.

play_request: Se envía cuando la reproducción es iniciada por el usuario haciendo 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.

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

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

error: Se envía 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 el inicio de la carga de datos para el video y la reproducción del video.
  • start_time_ms: El tiempo, en milisegundos, entre el inicio de la reproducción y el primer fotograma del video que se procesa. Esto puede ser diferente según la experiencia, por ejemplo, si no hay anuncios previos al video configurados, esta medida es el tiempo entre 'play_request' y video_view eventos. Si hay un anuncio pre-roll, el tiempo entre ad_mode_begin y ad_mode_complete no debe incluirse.

video_engagement: Incluye selección de reproducción adicional, mediciones 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 en el sentido de que debe enviarse periódicamente, incluso si no se produjo ninguna visualización durante el período de participación. Este cambio es para permitir el seguimiento de retrasos y recuentos de almacenamiento en búfer que hacen que los usuarios esperen la reproducción.

  • distancia: El parámetro de rango ahora es opcional, el rango se puede dejar fuera de un evento de participació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 reabastecimiento)
  • rendition_url: La URL de la versión seleccionada más recientemente. Por ejemplo, para una transmisión HLS, esta sería la URL de la variante seleccionada más recientemente.
  • rendition_indicated_bps: La tasa de bits indicada, en bits por segundo, de la versión seleccionada más recientemente.
  • rendition_mime_type: El tipo de mímica de la versión seleccionada más recientemente.
  • 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 la reproducción del video debido a un retraso no solicitado durante el período de participación.
  • rebuffering_count: El número de veces que se detuvo la reproducción debido al almacenamiento en búfer durante el período de participación representado.
  • forward_buffer_seconds: La cantidad de segundos de video que residen actualmente en el búfer de reenvío.
  • mid_bps: La relación entre el número de bits incluidos en el segmento descargado más recientemente y el tiempo dedicado a descargar ese segmento, en bits por segundo.
  • player_width El ancho de píxel actual del jugador al final del rango de interacción.
  • player_height La altura de píxel actual del jugador al final del rango de interacción.
  • drop_frames: La cantidad de fotogramas que se eliminaron de la reproducción de video durante este período de participación