Paper Contacter le support | état du système L'état du système

Aperçu: Data Collection API v2

Dans cette rubrique, vous obtiendrez une vue d'ensemble de l'analyse Data Collection API v2, qui vous permet d’ajouter des événements à votre Video Cloud Données analytiques dans les situations où Brightcove ne peut pas suivre directement les événements.

Introduction

Les données analytiques sont envoyées automatiquement par le Brightcove Players, y compris ceux fournis par les autochtones Player SDK. Si vous êtes n'est pas à l'aide d'un Brightcove Player à fournir Video Cloud vidéos, vous devez instrumenter le player vous utilisez pour envoyer les données au Data Collector.

Data Collection API v2 est le standard actuel. La version v1 est obsolète. Si vous avez une implémentation v1, reportez-vous à la Changements de v1 section ci-dessous.

En plus de cet aperçu et de la Référence de l'API, voyez aussi ceci exemple d'implémentation.

Les analyses Data Collection API est le point de terminaison des événements d'analyse en temps réel. Les données d'événement sont envoyées à Brightcove via une série de paramètres soumis via des requêtes HTTP, tels que:

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

Ces paramètres décrivent un fait à propos de l'état du système lorsqu'un événement s'est produit. L'exemple ci-dessus décrit le fait qu'un video_view événement s'est produit pour la vidéo 789 pour le compte 123 (ou: un utilisateur a commencé à regarder le compte 123de la vidéo 789. Voir ci-dessous pour une description des événements d'analyse actuels suivis).

Dimensions

Les dimensions sont des faits qualitatifs sur l'état du système lorsqu'un événement se produit. Par exemple, si la requête est:

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

L'identifiant de la vidéo ( 789) et l'identifiant du compte ( 123), et toutes les informations de périphérique et d'emplacement glanées à partir de la demande elle-même sont toutes des dimensions liées au video_view un événement. Le système Analytics enregistrera qu'un video_view événement s'est produit lorsque cette demande a été faite, avec ces dimensions.

Paramètres d'événement et de domaine

Le système d'implants dentaires event paramètre décrit quel événement s'est produit. le domain paramètre fournit un espace de noms pour les événements. le event, domain session sont les paramètres requis (la valeur de domain est toujours videocloud).

Paramètres supplémentaires

Certains paramètres doivent être inclus avec les événements pour que le système Analytics puisse les analyser avec succès

Types de réponse

La réponse à une demande d'API de collecte de données analytiques comprend un code de réponse HTTP et un message lisible par l'homme.

Code d'état HTTP Description Exemple
200 La demande a été reçue avec succès par le collecteur et a été conservée. (renvoie une image GIF en pixels 1x1)
400 La requête envoyée par le client manque un paramètre requis: domain, account or event. (Cet état ne sera pas renvoyé si des paramètres spécifiques au domaine sont manquants.) "Invalid 'event' parameter"
50x Ce code d'erreur indique un problème côté serveur. Votre événement peut ou non avoir été enregistré avec succès par le système d'analyse. "Server-side failure, please retry."

Données minimales

Au minimum, vous devriez envoyer un session id et video_view événement pour chaque vidéo jouée pendant une session. le video_view devrait être envoyé après toutes les annonces pré-roll complètent.

session

C'est l'identifiant de la session. le session est essentiellement une vue d'une page ou d'une application qui a un player en elle, aussi longtemps que cela dure. La valeur doit être constante pendant toute la durée de la session et envoyé pour tous les événements. Il devrait être aussi proche que possible d'un identificateur global unique (GUID). S'il y a des collisions, les deux sessions peuvent être rejetées comme non valides si elles ne peuvent pas être démêlées.

Il existe différents systèmes pour créer des GUID en JavaScript. Un exemple est dans ce dépôt GitHub. Veuillez noter que les scripts tiers ne sont pas pris en charge par Brightcove.

Données minimales pour la performance (Play Rate & Engagementation)

Évènements

  • video_impression
  • video_view
  • video_engagement

Attributs (tous les événements)

  • account
  • video

Attributs supplémentaires (video_engagement Événement uniquement)

Vidéo à la demande
  • range
  • video_duration
Live
  • video_seconds_viewed

En-têtes HTTP

  • User-Agent - Requis pour les rapports sur les appareils

Les meilleures pratiques

Pour être sûr que vous envoyez les données correctes au collecteur, vous devez tester votre script de collecte de données avant de le déployer généralement. Nous recommandons:

  1. Créez le script de collecte de données pour votre player.
  2. Testez dans un environnement contrôlé pendant au moins une journée.
  3. Vérifiez les données d’analyse via le module d’analyse ou le Analytics API pour vous assurer que ce qui a été collecté correspond à vos attentes.

Envoyer la demande - éviter les problèmes CORS

Données indésirables

En général, les données envoyées au collecteur seront enregistrées comme véridiques par le système Google Analytics. Si un événement contient des informations inappropriées ou incorrectes, le système Analytics interprétera les données de manière incorrecte.

Par exemple, si vous envoyez accidentellement l'horodatage en tant qu'ID vidéo, vos données analytiques seront faussées de manière à affecter le résumé global.

Encodage URI

Toutes les chaînes que vous envoyez à la Data Collection API qui pourrait contenir des espaces ou des caractères spéciaux doit être codé en URI pour que la demande soit acceptée. Si vous soumettez la demande via JavaScript, vous pouvez utiliser le encodeURI() méthode l'encoder la chaîne de requête. Par exemple:

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

Évènements

Les événements répertoriés ci-dessous sont traités par le système Google Analytics.

player_load
Intention / Signification

A player session a été lancée par un utilisateur final. Cela marque le début de la session d'analyse et doit être envoyé avant tout autre événement.

Exemple
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
Intention / Signification

Envoyé lorsque des erreurs fatales qui perturbent l'expérience de lecture sont rencontrées.

Exemple
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
Intention / Signification

Envoyé lorsqu'une demande au Video Cloud Playback API est fait.

Exemple
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
Intention / Signification

Envoyé lorsqu'une réponse à un a priori catalog_request est reçu.

Exemple
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
Intention / Signification

Envoyé lorsque la lecture est initiée par l'utilisateur en cliquant sur le bouton de lecture, ou automatiquement lorsque la plate-forme déclenche la lecture dans un scénario de lecture automatique.

Exemple
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
Intention / Signification

Envoyé lorsque le contrôle est transmis à un agent publicitaire par la plateforme de lecture.

Exemple
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
Intention / Signification

Envoyé lorsque le contrôle est transmis à un agent publicitaire par la plateforme de lecture.

Exemple
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
Intention / Signification

Les métadonnées d'une vidéo ajoutée à la player a terminé le chargement et player est prêt à déclencher l'événement d'affichage, soit via la lecture automatique ou l'interaction avec l'utilisateur.

Exemple
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
Intention / Signification

Une vidéo a commencé à être lue (lecture automatique après le chargement ou à cause de l'interaction de l'utilisateur).

Exemple
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
Intention / Signification

Un utilisateur a regardé une plage de secondes de la chronologie d'une vidéo. Cet événement est un battement de cœur pour le suivi de l'engagement vidéo et sera probablement envoyé plusieurs fois pendant la lecture, selon l'interaction de l'utilisateur et la durée de la vidéo. The Brightcove player l'instrumentation envoie cet événement toutes les 10 secondes, si la lecture n'est pas interrompue. Les événements décrivant des plages sur des secondes 20 sont ignorés par le système Analytics.

Exemple
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

Paramètres pour tous les événements

Les paramètres de ces événements doivent inclure toutes les informations relatives à l'état actuel du système lorsque l'événement s'est produit, et doivent être aussi spécifiques que possible. Cette section détaille les paramètres qui peuvent être envoyés avec tous les événements, et les sections suivantes montrent les paramètres pour des événements spécifiques.

Champ Type Description
account Chaîne

identifiant de compte

domain Chaîne

toujours égal à videocloud

Valeurs autorisées: "videocloud"

session Chaîne Un identifiant de session aussi unique que possible - voir le Données minimales section ci-dessus pour plus d'informations
device_os optionnel Chaîne

Remplacer pour spécifier le système d'exploitation du périphérique à l'origine de l'événement dans les cas où l'agent utilisateur n'est pas fiable (ignoré sauf si le périphérique et le type de périphérique sont inclus ou si la valeur indiquée ne figure pas dans la liste des valeurs Pas typiquement inclus)

Valeurs autorisées: "android", "bada", "ios", "linux", "mac", "tv", "os_x", "rim", "sybian", "windows", "other"

device_os_version optionnel Chaîne

La version de os utilisée par l'appareil. Lorsqu'il n'est pas spécifié, il sera calculé en analysant la chaîne de l'agent utilisateur pour la demande de suivi

device_type optionnel Chaîne

Remplacer pour spécifier le type du périphérique à l'origine de l'événement dans les cas où l'agent utilisateur n'est pas fiable (ignoré sauf si le périphérique et le type de périphérique sont inclus ou si la valeur soumise ne figure pas dans la liste des valeurs affichées ici. Pas typiquement inclus)

Valeurs autorisées: "direct", "mobile", "tablet", "tv", "desktop", "other"

event Chaîne

le type d'événement

Valeurs autorisées: "player_load", "catalog_request", "catalog_response", "play_request", "ad_mode_begin", "ad_mode_complete", "video_impression", "video_view", "video_engagement", "error"

destination optionnel Chaîne

URI à l'origine de l'événement

source optionnel Chaîne

URI qui a envoyé l'utilisateur final à destination URI

time optionnel Numéro

l'horodatage de l'événement dans le temps (millisecondes)

country optionnel Chaîne

Code de région ISO-3166 (alpha 2) région cISO-3166 (alpha 2) (remplacer si le système ne peut pas détecter les informations géographiques de l'adresse IP) Pas typiquement inclus

country_name optionnel Chaîne

Nom de pays lisible par l'utilisateur (ignorer si le système ne peut pas détecter les informations géographiques de l'adresse IP) Pas typiquement inclus

region optionnel Chaîne

Code de région ISO-3166 (alpha 2) (remplacer si le système ne peut pas détecter les informations géographiques de l'adresse IP) Pas typiquement inclus

region_name optionnel Chaîne

Nom de région lisible par l'utilisateur (ignorer si le système ne peut pas détecter les informations géographiques de l'adresse IP) Pas typiquement inclus

city optionnel Chaîne

Nom de Ville Pas typiquement inclus

user optionnel Chaîne

Un identifiant utilisateur unique - s'il n'est pas fourni ou vide, Video Cloud utilise la méthode de secours consistant à utiliser le Source IP address + the User-Agent String comme identifiant unique Notez que Brightcove utilise ces informations uniquement pour calculer des utilisateurs uniques. Les données utilisateur elles-mêmes ne peuvent pas être récupérées via le module API ou Analytics

Paramètre utilisateur

  • Si la player/ l'application cliente souhaite suivre la visionneuse unique, elle doit envoyer un identifiant unique pour l'utilisateur en tant que paramètre utilisateur au collecteur.
  • Si la user n'est pas fourni ou est vide, nous utilisons la méthode de repli de l'utilisation de la Source IP address + the User-Agent String comme l'identifiant unique.
  • La valeur du paramètre utilisateur n'est jamais stockée dans les logs / base de données, seul un hash (utilisant SHA-256) est stocké.
  • Aucun cookie n'est défini par le collecteur.

Utilisateur unique

Vous pouvez utiliser Brightcove PlayerLa fonctionnalité du plug-in permet d'ajouter des données de visionneuse vidéo uniques aux analyses rapportées. Pour ce faire, vous allez ajouter un identifiant unique à la settings objet de la fonctionnalité d'analyse.

Bien sûr, la façon dont un ID utilisateur unique est capturé varie d'une application à l'autre, mais pour un exemple, ce code suppose qu'une URL de connexion est capturée et contient des données utilisateur uniques, telles que http://exampledomain.com/users/912389123. Cette URL unique est transmise au plugin.

Le code du plugin ci-dessous effectue les tâches suivantes:

  • Utilise la syntaxe standard pour créer un Brightcove Player plugin avec le nom du plugin défini comme uniqueUserForAnalyticsPlugin. Le plugin accepte également un options objet, qui contient des données passées au plugin.
  • Le système d'implants dentaires myPlayer une variable est affectée à la variable player. De plus, deux autres variables sont créées.
  • Le système d'implants dentaires userPath variable est attribué le chemin transmis au plugin via le options objet.
  • Le système d'implants dentaires uniqueViewer variable est affectée à la version analysée de la userPathAinsi, seuls les chiffres de l'ID utilisateur sont affectés à la variable.
  • Une propriété d'utilisateur est ajoutée au plug-in Analytics settings objet.
  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;
  });
  
  

Ce code doit être modifié en fonction de la logique de votre application, puis enregistré dans une URL accessible par Internet.

Depuis Studio, utilisez le Extensions section pour charger le plugin dans le player, comme montré.

Section Plugin Studio
Section Plugin Studio

Au lieu du JSON qui suit, vous passez au plugin la chaîne contenant les données utilisateur. Bien sûr, le code du plugin devra être mis à jour en conséquence pour extraire l'identifiant utilisateur unique.

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

Pour plus d'informations sur le développement de plugins, consultez le Pas à pas: développement de plugins document.

device_type, device_os, device_os_version, device_manufacturer browser_type paramètres

Par défaut, le système Google Analytics tentera de détecter le type de périphérique et les informations sur le système d'exploitation à partir de l'en-tête User-Agent. Si tous les deux device_type et device_os sont envoyés, les informations de l'en-tête User-Agent seront ignorées en faveur de device_type et device_os. Dans la plupart des cas, vous n'avez pas besoin d'envoyer des informations sur le périphérique, le système d'exploitation et le navigateur - cette substitution ne doit être utilisée que si l'agent utilisateur n'est pas fiable ou n'est pas disponible.

Le système Analytics enregistrera other si une requête inclut des valeurs non reconnues pour les remplacements de paramètres de périphérique.

Paramètres de données géographiques

Par défaut, le système Google Analytics tentera de détecter les informations géographiques provenant de l'adresse IP distante. Ce comportement peut être ignoré en passant country, country_name, region, region_name, city et dma paramètres. Dans la plupart des cas, ces paramètres ne sont pas requis - cette substitution ne doit être utilisée que si l'adresse IP distante n'est pas fiable ou n'est pas disponible.

Le système Analytics enregistrera ZZ or unknown si une requête inclut des valeurs non reconnues pour les remplacements.

Paramètres de destination et de source

Le système d'implants dentaires destination et source les paramètres fournissent l'URI à l'origine de l'événement ( destination) et l'URI qui y a envoyé l'utilisateur ( source).

Le système d'implants dentaires source Ce paramètre est utilisé pour déterminer les informations sur la source de trafic. Si source n'est pas spécifié, le système Google Analytics traitera les événements comme étant initiés par le trafic direct.

Le système d'implants dentaires destination Le paramètre sera utilisé pour déterminer les informations de destination du trafic, c'est-à-dire, où la vidéo est regardée. Si l'URI ne contient pas d'autorité, l'API n'enregistrera pas destination_domain. le destination_path sera enregistré comme le chemin dans l'URI.

Pendant la lecture Web, l'URL dans la barre d'adresse de la page sur laquelle la vidéo est lue est la destination, et le source est le référent ( top.document.referrer).

Par exemple, lorsque vous recherchez "diffusion en direct avec fil" sur le site d'assistance Brightcove et que vous regardez une vidéo qui apparaît dans les résultats:

Paramètre Valeur
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
  
  

S'il n'y a pas d'URL (comme dans le cas de la lecture native, par exemple), les deux destination et source devraient être des URI valides qui identifient où la vidéo est en train de lire et comment l'utilisateur est arrivé, respectivement.

En supposant que destination est URI valide:

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

le système Google Analytics le traitera comme suit:

Si l'URI contient un autorité, la réponse de l'API utilisera cette autorité en tant que destination_domain et tout chemin fourni en tant que destination_path. Si l'URI ne contient pas d'autorité, l'API n'enregistrera pas destination_domain. le destination_path sera enregistré comme le chemin dans l'URI. UNE destination sans partie hiérarchique (par exemple un schéma) est considéré comme invalide, comme toute valeur sans schéma.

Paramètres pour des événements spécifiques

paramètres d'événement d'erreur

Les paramètres suivants doivent être envoyés avec error événements.

Champ Type Description
error_code optionnel Numéro

Un code d'erreur spécifique à la plate-forme associé à l'événement

Paramètres d'événement catalog_request

Les paramètres suivants doivent être envoyés avec catalog_request événements.

Champ Type Description
catalog_url optionnel Chaîne

L'URL de destination associée à l'événement catalog_request

Paramètres d'événement catalog_response

Les paramètres suivants doivent être envoyés avec catalog_response événements.

Champ Type Description
catalog_url optionnel Chaîne

L'URL de destination associée à l'événement catalog_request qui a déclenché cette réponse

response_time_ms optionnel Numéro

Le temps, en millisecondes, entre l'événement catalog_request et l'événement catalog_response

Paramètres d'événement video_impression

Les paramètres suivants doivent être envoyés avec video_impression événements.

Champ Type Description
video optionnel Chaîne

l'identifiant de la vidéo

video_name optionnel Chaîne

le nom de la vidéo

Paramètres de l'événement video_view

Les paramètres suivants doivent être envoyés avec video_view événements.

Champ Type Description
video optionnel Chaîne

l'identifiant de la vidéo

video_name optionnel Chaîne

le nom de la vidéo

start_time_ms optionnel Chaîne

Le temps, en millisecondes, entre l'initiation de la lecture et la première image de la vidéo en cours de rendu. Cela peut être différent selon l'expérience, par exemple, s'il n'y a pas d'annonces pré-roll configurées, cette mesure est le temps entre le play_request et video_view événements. S'il y a une annonce preroll, le temps entre ad_mode_begin et ad_mode_complete ne devrait pas être inclus

Paramètres de l'événement video_engagement

Les paramètres suivants doivent être envoyés avec video_engagement événements.

Champ Type Description
video optionnel Chaîne

l'identifiant de la vidéo

video_name optionnel Chaîne

le nom de la vidéo

range optionnel Chaîne

la plage de la vidéo visionnée pour video_engagement événements dans le format StartSecond..EndSecond (les valeurs StartSecond et EndSecond doivent être des nombres entiers [entiers]) - l'intervalle peut être exclu d'un événement d'engagement pour montrer que pendant la période couverte par l'événement, il n'y a pas eu d'activité de visualisation. (par exemple, lorsqu'il n'y a qu'une activité de re-buffering)

rendition_url optionnel Chaîne

L'URL de la dernière interprétation sélectionnée. Par exemple, pour un flux HLS, il s'agit de l'URL de la dernière variante sélectionnée

rendition_indicated_bps optionnel Chaîne

Le débit indiqué, en bits par seconde, de la dernière interprétation sélectionnée

rendition_mime_type optionnel Chaîne

Le type mime de la dernière interprétation sélectionnée

rendition_height optionnel Chaîne

La hauteur codée du rendu vidéo en pixels

rendition_width optionnel Chaîne

La largeur codée du rendu vidéo en pixels

rebuffering_seconds optionnel Chaîne

Nombre de secondes pendant lesquelles l'utilisateur a attendu la lecture de la vidéo en raison d'un retard non demandé pendant la période d'engagement

rebuffering_count optionnel Chaîne

Le nombre de fois où la lecture s'est arrêtée en raison de la remise en mémoire tampon pendant le délai de la période d'engagement représentée pendant la période d'engagement

forward_buffer_seconds optionnel Chaîne

Le nombre de secondes de vidéo résidant actuellement dans le tampon de transfert

measured_bps optionnel Chaîne

Le rapport du nombre de bits inclus dans le segment le plus récemment téléchargé au temps passé à télécharger ce segment, en bits par seconde

player_width optionnel Chaîne

La largeur actuelle en pixels du player à la fin de la plage d'engagement

player_height optionnel Chaîne

La hauteur actuelle en pixels du player à la fin de la plage d'engagement

dropped_frames optionnel Chaîne

drop_frames

video_duration optionnel Numéro

la durée de la vidéo en secondes

video_seconds_viewed optionnel Numéro

nombre de secondes regardées depuis la dernière mise à jour pour video_engagement événements

Le système d'implants dentaires video_engagement L'événement est un moyen de suivre l'engagement vidéo pendant la lecture d'une vidéo et sera probablement envoyé plusieurs fois pendant la lecture. (Le Flash / HTML5 player l'instrumentation envoie cet événement toutes les 10 secondes, si la lecture n'est pas interrompue.) Actuellement, les événements décrivant des plages sur des secondes 20 sont ignorés par le système Google Analytics. Il est donc nécessaire d'envoyer ces événements plus fréquemment.

Il y a deux formes qu'un video_engagement événement peut prendre (autres paramètres omis par souci de concision):

Exemple Sens
  event=video_engagement&video=123&video_duration=75&range=0..9
  
  
Vidéo 123 avec une durée de 75 secondes jouées en secondes 0 à 9 (pour un total de 10 secondes vues).
event=video_engagement&video=123&video_seconds_viewed=10 10 secondes de vidéo 123 nous avons révisé.

Alors que les deux versions suivent les secondes, la version qui comprend video_duration et range contient également les informations nécessaires pour calculer des données d'engagement supplémentaires, et est le moyen préféré envoyer video_engagement données d'événement vers le système Analytics. Pour les flux en direct ou dans les cas où la chronologie de la vidéo change continuellement pendant la lecture ou n’est pas fiable, video_seconds_viewed seront les seules données disponibles. Pour la VOD, à moins que duration est indisponible, le video_engagement l'événement devrait inclure video_duration et range.

Paramètres Mesures d'engagement dérivées (API)
video_duration, range video_seconds_viewed, video_percent_viewed, engagement_score; données de courbe d'engagement
video_seconds_viewed video_seconds_viewed

Si les trois paramètres ( video_duration, range et video_seconds_viewed) sont envoyés avec un video_engagement événement, le système Google Analytics calcule les mesures d'interaction video_duration+ range paramètres.

Changements V2

Cette section fournit un résumé des modifications de v1 à v2 du collecteur de données pour ceux qui ont utilisé v1.

URL de base pour le tracker

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

Champs supplémentaires pris en charge sur tous les événements:

device_os_version: La version d'os utilisée par l'appareil. S'il n'est pas spécifié, il sera calculé en analysant la chaîne de l'agent utilisateur pour la demande de suivi.

platform_version: Utilisé pour indiquer qu'une nouvelle version de la plate-forme spécifiée est utilisée pour envoyer les événements.

Nouveaux événements pour V2

demande de catalogue: Envoyé lorsqu'une demande à l'API de catalogue videocloud est faite - notez que cet événement est destiné à un usage interne et n'est pas exposé dans le module Analytics API.

  • catalog_url: L'URL de destination associée à catalog_request événement - notez que cet événement est destiné à un usage interne et n’est pas exposé dans le module d’analyse ni via le Analytics API..

catalog_response: Envoyé lorsqu'une réponse à un avant catalog_request est reçu - notez que cet événement est destiné à un usage interne et n’est pas exposé dans le module d’analyse ni via le Analytics API.

  • catalog_url: L'URL de destination associée à catalog_request événement à l'origine de cette réponse - notez que cet événement est destiné à un usage interne et n'est pas exposé dans le module d'analyse ni via le Analytics API..
  • response_time_ms: Le temps, en millisecondes, entre le catalog_request événement et le catalog_response événement - notez que cet événement est destiné à un usage interne et n’est pas exposé dans le module d’analyse ni via le Analytics API..

play_request: Envoyé lorsque la lecture est initiée soit par l'utilisateur cliquant expressément sur le bouton de lecture, soit automatiquement lorsque la plate-forme déclenche la lecture dans un scénario de lecture automatique.

ad_mode_begin: [Remplace ad_start] Envoyé lorsque le contrôle est transmis à un agent publicitaire par la plate-forme de lecture.

ad_mode_complete: [Remplace ad_end] Envoyé lorsque le contrôle est transféré de l'agent publicitaire à la plate-forme de lecture.

erreur: Envoyé lorsque des erreurs fatales qui perturbent l'expérience de lecture sont rencontrées.

  • code d'erreur: Un code d'erreur spécifique à la plate-forme associé à l'événement.

Événements mis à jour pour V2

video_view: Inclut les nouvelles mesures de latence

  • load_time_ms: Le délai, en millisecondes, entre l'initiation de la charge de données pour la vidéo et la lecture de la vidéo.
  • start_time_ms: Durée, en millisecondes, entre l'initiation de la lecture et la première image de la vidéo en cours de rendu. Cela peut être différent selon l'expérience, par exemple, s'il n'y a pas d'annonces pré-roll configurées, cette mesure est le temps entre la 'play_request' et video_view événements. S'il y a une annonce preroll, le temps entre ad_mode_begin et ad_mode_complete ne devrait pas être inclus.

video_engagement: Comprend une sélection de rendu supplémentaire, des mesures de débit et des informations de mise en mémoire tampon. Une modification subtile de l'engagement vidéo a également été apportée, en ce sens qu'elle devrait être envoyée périodiquement même si aucune visualisation n'a eu lieu pendant la période d'engagement. Cette modification permet d'activer les retards de mise en mémoire tampon et les comptages qui amènent les utilisateurs à attendre la lecture.

  • gamme: Le paramètre d'étendue est maintenant facultatif, l'intervalle peut être exclu d'un événement d'engagement pour montrer que pendant la période couverte par l'événement, il n'y a pas eu d'activité de visualisation. (par exemple, lorsqu'il n'y a qu'une activité de re-buffering)
  • rendu_url: L'URL de la dernière interprétation sélectionnée. Par exemple, pour un flux HLS, il s'agit de l'URL de la dernière variante sélectionnée.
  • rendu_indication_bps: Le débit indiqué, en bits par seconde, du rendu sélectionné le plus récemment.
  • rendu_mime_type: Le type mime de la dernière interprétation sélectionnée.
  • rendition_height: La hauteur codée du rendu vidéo en pixels
  • rendition_width: La largeur codée du rendu vidéo en pixels
  • rebuffering_seconds: Nombre de secondes pendant lesquelles l'utilisateur a attendu la lecture de la vidéo en raison d'un retard non demandé pendant la période d'engagement.
  • rebuffering_count: Le nombre de fois que la lecture s'est arrêtée en raison de la remise en mémoire tampon pendant la période d'engagement représentée.
  • forward_buffer_seconds: Le nombre de secondes de vidéo résidant actuellement dans le tampon de transfert.
  • measured_bps: Le rapport entre le nombre de bits inclus dans le segment le plus récemment téléchargé et le temps passé à télécharger ce segment, en bits par seconde.
  • player_largeur La largeur actuelle en pixels du player à la fin de la plage d'engagement.
  • player_la taille La hauteur actuelle en pixels du player à la fin de la plage d'engagement.
  • drop_frames: Nombre d'images qui ont été supprimées de la lecture vidéo pendant cette période d'engagement

Dernière mise à jour de la page le 12 juin 2020