soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Resumen: API de recopilación de datos v2

    En este tema, obtendrá una descripción general de la API de recopilación de datos de Analytics v2, que le permite agregar eventos a los datos de Video Cloud Analytics en situaciones en las que Brightcove no puede realizar un seguimiento directo de los eventos.

    Introducción

    Los reproductores de Brightcove envían automáticamente los datos de análisis, incluidos los proporcionados por los SDK de Native Player. Si no utiliza un reproductor de Brightcove para entregar vídeos de Video Cloud, debe instrumentar el reproductor que está utilizando 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 sección Cambios de v1 a continuación.

    Además de esta descripción general y la Referencia de API, consulte también esta implementación de ejemplo.

    La API de recopilación de datos de Analytics 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 un hecho sobre el estado del sistema cuando se produjo un evento. El ejemplo anterior describe el hecho de que se produjo un video_view evento para el vídeo 789 para la cuenta 123 (o: un usuario comenzó a ver la cuenta 123de vídeo 789. Consulte a continuación para obtener una descripción de los eventos de análisis actuales rastreados).

    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
      
      

    El ID de vídeo ( 789) y el ID de cuenta ( 123), así como cualquier información de dispositivo y ubicación obtenida de la propia solicitud son dimensiones relacionadas con el video_view evento. El sistema Analytics registrará que se produjo un video_view evento cuando se realizó esta solicitud, con estas dimensiones.

    Parámetros de evento y dominio

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

    Parámetros adicionales

    Determinados parámetros deben incluirse con los eventos para que el sistema Analytics pueda analizarlos correctamente

    Tipos de respuesta

    La respuesta a una solicitud de API de recopilación de datos de analítica 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 correctamente por el recopilador y se ha mantenido. (devuelve una imagen GIF transparente de 1x1 píxel)
    400 A la solicitud enviada por el cliente le falta un parámetro requerido: domain, account o event. (Este estado no se devolverá si faltan parámetros específicos de dominio). "Invalid 'event' parameter"
    50x Este código de error indica un problema en el lado del servidor. Su evento puede o no haber sido registrado correctamente por el sistema de análisis. "Server-side failure, please retry."

    Datos mínimos

    Como mínimo, debe enviar un session ID y un video_view evento para cada vídeo reproducido durante una sesión. El video_view debe enviarse después de que se completen los anuncios pre-roll.

    session

    Este es el identificador de sesión. El session es esencialmente una vista de una página o vista de aplicación que tiene un reproductor en ella, durante el tiempo que dure. El valor debe ser constante durante la duración de la sesión y enviarse 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 no válidas si no se pueden desenredar.

    Hay 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 juego y puntuación de interacción)

    Eventos

    • video_impression
    • video_view
    • video_engagement

    Atributos (todos los eventos)

    • account
    • video

    Atributos adicionales (sólovideo_engagement evento)

    Vídeo a la carta
    • range
    • video_duration
    En directo
    • video_seconds_viewed

    Encabezados HTTP

    • User-Agent - Necesario para informes de dispositivos

    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. Recomendamos:

    1. Cree el script de recopilación de datos para su reproductor.
    2. Pruebe en un entorno controlado durante al menos un día.
    3. Compruebe los datos de análisis a través del módulo Analytics o el Analytics API para asegurarse de que lo que se recopiló coincide con sus expectativas.

    Envío de la solicitud - evitar problemas de CORS

    Datos no deseados

    En general, los datos enviados al Recopilador serán registrados como veracidad por el sistema Analytics. Si un evento contiene información inadecuada o incorrecta, el sistema de Analytics interpretará los datos de forma incorrecta.

    Por ejemplo, si envía accidentalmente la marca de tiempo como ID de vídeo, los datos de análisis se sesgarán de manera que afecten al 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 codificada en URI para que la solicitud se realice correctamente. Si está enviando la solicitud a través de JavaScript, puede usar el encodeURI() método de codificación de 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 Analytics.

    player_load
    Intención/Significado

    Un usuario final ha iniciado una sesión de reproductor. Esto marca el comienzo de la sesión de análisis y debe enviarse antes de 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

    Se envía cuando se detectan errores graves 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

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

    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

    Se envía cuando se recibe una respuesta a catalog_request un anterior.

    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 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 se pueden enviar varios play_request eventos durante una sola sesión de visualización si el espectador hace una pausa y reanuda el vídeo.

    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

    Se envía cuando el control es entregado a un agente publicitario por la plataforma de reproducción.

    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

    Se envía cuando el control es entregado a un agente publicitario por la plataforma de reproducción.

    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 vídeo 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
    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

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

    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 intervalo de segundos de la línea de tiempo de un vídeo. Este evento es un latido para el seguimiento de la interacción del vídeo y probablemente se enviará muchas veces durante la reproducción, dependiendo de la interacción del usuario y de la duración del vídeo. La instrumentación del reproductor de Brightcove envía este evento cada 10 segundos, si la reproducción no se interrumpe. Los eventos que describen rangos de más de 20 segundos son descartados por el sistema Analytics.

    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 para el estado actual del sistema cuando se produjo 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 en las secciones siguientes se muestran los parámetros para eventos específicos.

    Campo Tipo Descripción
    account Cadena

    ID de cuenta

    domain Cadena

    siempre igual a videocloud

    Valores permitidos: "videocloud"

    session Cadena Un identificador de sesión que es lo más universal posible: consulte la sección Datos mínimos arriba para obtener más información
    device_os opcional Cadena

    Sustituir para especificar el sistema operativo del 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 del dispositivo como el tipo de dispositivo o si el valor enviado no está en la lista de valores que se muestra aquí. Normalmente no se incluye)

    Valores permitidos: "android" , "bada" , "ios" , "linux" , "mac" , "tv" , "os_x" , "rim" , "sybian" , "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

    Sustituir 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 del dispositivo como el tipo de dispositivo o si el valor enviado no está en la lista de valores que se muestra aquí. Normalmente no se incluye)

    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 para el evento en tiempo de época (milisegundos)

    country opcional Cadena

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

    country_name opcional Cadena

    Nombre del país legible por humanos (anulación en caso de que el sistema no pueda detectar información geográfica de la dirección IP) No se incluye normalmente

    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 se incluye

    region_name opcional Cadena

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

    city opcional Cadena

    Nombre de la ciudad Normalmente no se incluye

    user opcional Cadena

    Identificador de usuario único: si no se proporciona o está en blanco, Video Cloud utiliza el método de reserva de utilizar Source IP address + the User-Agent String como identificador único. Tenga en cuenta que Brightcove utiliza esta información sólo para calcular usuarios únicos. Los datos de usuario en sí no se pueden recuperar a través de la API o el módulo Analytics

    Parámetro Usuario

    • Si la aplicación reproductor/cliente desea realizar un seguimiento del visor único, debe enviar un Id único para el usuario como parámetro de usuario al recopilador.
    • Si el no user se proporciona o está en blanco, utilizamos el método de reserva de usar el Source IP address + the User-Agent String como identificador único.
    • El valor del parámetro usuario nunca se almacena en los logs/base de datos, sólo se almacena un hash (usando SHA-256).
    • El coleccionista no establece cookies.

    Usuario único

    Puede utilizar la funcionalidad del complemento de Brightcove Player para agregar datos únicos del visor de vídeo a los análisis informados. Para ello, agregará un identificador único al settings objeto de la funcionalidad de análisis.

    Por supuesto, la forma en que se captura un ID de usuario único varía de una aplicación a otra, pero, por 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 plugin.

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

    • Utiliza la sintaxis estándar para crear un plugin de Brightcove Player con el nombre del complemento definido como uniqueUserForAnalyticsPlugin. El plugin también acepta un options objeto, que contiene datos pasados al complemento.
    • A la myPlayer variable se le asigna una referencia al jugador. Además, se crean otras dos variables.
    • A la userPath variable se le asigna la ruta pasada al plugin a través del options objeto.
    • A la uniqueViewer variable se le asigna la versión analizada de userPath , por lo que sólo los dígitos de ID de usuario se asignan a la variable.
    • Se agrega una propiedad de usuario al settings objeto del complemento de Analytics.
      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 tendría que modificarse para adaptarse a la lógica de su aplicación y, a continuación, guardarlo en una URL accesible a Internet.

    Desde Studio, utilice la sección Plugins para cargar el plugin en el reproductor, como se muestra.

    Sección de plugin de Studio
    Sección de plugin 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 tendría que actualizarse en consecuencia para extraer el ID de usuario único.

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

    Para obtener más información sobre el desarrollo de complementos, consulte el paso a paso: Documento de desarrollo de plugin .

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

    De forma predeterminada, el sistema de Analytics intentará detectar el tipo de dispositivo y la información del sistema operativo desde el encabezado User-Agent. Si ambos 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 se debe usar si el agente de usuario no es confiable o no está disponible de otro modo.

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

    Datos geográficos Parámetros

    De forma predeterminada, el sistema de Analytics intentará detectar información geográfica de 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 se debe utilizar si la dirección IP remota no es confiable o no está disponible de otro modo.

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

    Parámetros de destino y origen

    los 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 origen de tráfico. Si no source se especifica, el sistema de Analytics tratará los eventos como iniciados por el tráfico directo.

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

    Durante la reproducción web, la URL en la barra de direcciones de la página donde se está reproduciendo el vídeo es el destination, y el source es el referrer ( top.document.referrer).

    Por ejemplo, cuando busque «transmisión inalámbrica en directo» en el sitio de soporte técnico de Brightcove y vea un vídeo que aparece en los resultados:

    Parámetros 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 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.

    Suponiendo que 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 Analytics lo manejará de la siguiente manera:

    Si el URI contiene una autoridad, la respuesta de la API utilizará esa autoridad como la ruta de acceso destination_domain y cualquier proporcionada como destination_path. Si el URI no contiene una autoridad, la API no registrará un archivo destination_domain. El se registrará como la ruta en el URI.destination_path 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 al evento

    parámetros de 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 al evento catalog_request

    parámetros de 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 de evento video_impression

    Los siguientes parámetros deben enviarse con video_impression eventos.

    Campo Tipo Descripción
    video opcional Cadena

    el id de vídeo

    video_name opcional Cadena

    el nombre del vídeo

    parámetros de evento video_view

    Los siguientes parámetros deben enviarse con video_view eventos.

    Campo Tipo Descripción
    video opcional Cadena

    el id de vídeo

    video_name opcional Cadena

    el nombre del vídeo

    start_time_ms opcional Cadena

    Tiempo, en milisegundos, entre el inicio de la reproducción y el primer fotograma del vídeo 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-oll, el tiempo entre ad_mode_begin y no ad_mode_complete debe incluirse

    parámetros de evento video_engagement

    Los siguientes parámetros deben enviarse con video_engagement eventos.

    Campo Tipo Descripción
    video opcional Cadena

    el id de vídeo

    video_name opcional Cadena

    el nombre del vídeo

    range opcional Cadena

    el rango del vídeo visto para 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 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 rebúfer)

    rendition_url opcional Cadena

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

    rendition_indicated_bps opcional Cadena

    La velocidad de bits indicada, en bits por segundo, de la copia seleccionada más recientemente

    rendition_mime_type opcional Cadena

    El tipo mime de la copia seleccionada más recientemente

    rendition_height opcional Cadena

    La altura codificada de la representación del vídeo en píxeles

    rendition_width opcional Cadena

    El ancho codificado de la representación de vídeo en píxeles

    rebuffering_seconds opcional Cadena

    El número de segundos que el usuario pasó esperando que se reproduzca el vídeo debido a un retraso no solicitado durante el período de interacción

    rebuffering_count opcional Cadena

    El número de veces que se detuvo la reproducción debido al realmacenamiento en búfer durante el retraso del período de interacción representado durante el período de interacción

    forward_buffer_seconds opcional Cadena

    El número de segundos de vídeo que residen actualmente en el búfer de reenvío

    measured_bps opcional Cadena

    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 opcional Cadena

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

    player_height opcional Cadena

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

    dropped_frames opcional Cadena

    dropped_frames

    video_duration opcional Número

    la duración del vídeo en segundos

    video_seconds_viewed opcional Número

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

    El video_engagement evento es un medio para rastrear la interacción de vídeo mientras se reproduce un vídeo, y es probable que se envíe 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 de más de 20 segundos son descartados por el sistema Analytics, por lo que es necesario enviar estos eventos con más frecuencia.

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

    Ejemplo Significado
      event=video_engagement&video=123&video_duration=75&range=0..9
      
      
    Vídeo 123 con una duración de 75 segundos se reproducen segundos 0 a 9 (para un total de 10 segundos visualizados).
    event=video_engagement&video=123&video_seconds_viewed=10 123 Se vieron 10 segundos de vídeo.

    Mientras que ambas versiones realizan un seguimiento de los segundos vistos, la versión que incluye video_duration y range también contiene la información necesaria para calcular datos adicionales de interacción, y es la forma preferida de enviar datos de video_engagement eventos al sistema de Analytics. Para las transmisiones en directo, o en los casos en que la línea de tiempo del vídeo cambia continuamente durante la reproducción o no es fiable, video_seconds_viewed serán los únicos datos disponibles. Para VOD, a menos que no duration esté disponible, el video_engagement evento debe incluir video_duration y range.

    Parámetros Métricas de interacción derivadas (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 análisis calculará las métricas de participación 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 utilizando 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 utiliza el dispositivo. Si no se especifica, esto se calculará analizando la cadena del agente de usuario para la solicitud de seguimiento.

    versión de plataforma: 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 videocloud: tenga en cuenta que este evento es para uso interno y no se expone en el Módulo de Analytics ni a través de la API de Analytics.

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

    catalog_response: Se envía cuando se recibe una respuesta a un anterior catalog_request : tenga en cuenta que este evento es para uso interno y no está expuesto en el módulo Analytics ni a través de la API de Analytics.

    • 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 está expuesto en el Módulo de Analytics o a través de la API de Analytics.
    • response_time_ms: El tiempo, en milisegundos, entre el catalog_request evento y el evento: tenga en cuenta que este catalog_response evento es para uso interno y no está expuesto en el Módulo de Analytics o a través de la API de Analytics.

    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] Se envía cuando la plataforma de reproducción transfiere el control a un agente publicitario.

    ad_mode_complete: [Reemplaza ad_end] Se envía cuando el control se devuelve desde el agente de publicidad a la plataforma de reproducción.

    error: Se envía cuando se detectan errores graves que interrumpen la experiencia de reproducción.

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

    Eventos actualizados para V2

    video_view: Incluye nuevas mediciones de latencia

    • load_time_ms: El tiempo, en milisegundos, entre el inicio de la carga de datos para el vídeo y el vídeo que se puede reproducir.
    • start_time_ms: Tiempo, en milisegundos, entre el inicio de la reproducción y el primer fotograma del vídeo que se procesa. Esto puede ser diferente dependiendo de la experiencia, por ejemplo, si no hay anuncios pre-roll configurados, esta medida es el tiempo entre la 'play_request' y video_view los eventos. Si hay un anuncio pre-oll, el tiempo entre ad_mode_begin y no ad_mode_complete debe incluirse.

    video_engagement: Incluye selección de copias adicionales, mediciones de velocidad de bits e información de almacenamiento en búfer. También se hizo un cambio sutil en la interacción con el vídeo, ya que debería enviarse periódicamente aunque no se produjera ninguna visualización durante el período de interacción. Este cambio es para habilitar el seguimiento de los retrasos en el almacenamiento en búfer y los recuentos que hacen que los usuarios esperen la reproducción.

    • rango: El parámetro de rango ahora es opcional, el rango se puede dejar 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 rebúfer)
    • rendition_url: La URL de la copia seleccionada más recientemente. Por ejemplo, para una secuencia HLS, esta sería la url a la variante seleccionada más recientemente.
    • rendition_indicated_bps: La velocidad de bits indicada, en bits por segundo, de la copia seleccionada más recientemente.
    • rendition_mime_type: El tipo mime de la copia seleccionada más recientemente.
    • rendition_height: La altura codificada de la representación del vídeo en píxeles
    • rendition_width: El ancho codificado de la representación de vídeo en píxeles
    • rebúfering_seconds: El número de segundos que el usuario ha pasado esperando que se reproduzca el vídeo 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 cambio de búfer durante el período de interacción representado.
    • forward_buffer_seconds: El número de segundos de vídeo que residen actualmente en el búfer de reenvío.
    • medid_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 reproductor al final del rango de interacción.
    • player_height Altura del píxel actual del jugador al final del rango de interacción.
    • dropped_frames: El número de fotogramas que se eliminaron de la reproducción de vídeo durante este período de interacción

    Última actualización de la página el 25 nov 2020