assistance Contacter le support | Étatétat du système du système
Contenu de la page

    Présentation : API de collecte de données v2

    Dans cette rubrique, vous obtiendrez une vue d'ensemble de l'API de collecte de données Analytics v2, qui vous permet d'ajouter des événements à vos données Video Cloud Analytics dans les situations où Brightcove ne peut pas suivre les événements directement.

    Introduction

    Les données d'analyse sont envoyées automatiquement par les lecteurs Brightcove, y compris celles fournies par les SDK Native Player. Si vous n'utilisez pas Brightcove Player pour diffuser des vidéos Video Cloud, vous devez instrumenter le lecteur que vous utilisez pour envoyer les données au collecteur de données.

    L'API de collecte de données v2 est la norme actuelle. La version v1 est obsolète. Si vous avez une implémentation v1, consultez la section Modifications de v1 ci-dessous.

    En plus de cette vue d'ensemble et de la référence de l'API, voir également cet exemple d'implémentation.

    L'API de collecte de données Analytics 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 sur 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 compte 123 (ou : un utilisateur a commencé à regarder le compte 123de vidéo 789. Voir ci-dessous pour une description des événements analytiques 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'ID vidéo ( 789) et l'ID de compte ( 123), ainsi que les informations d'appareil et de localisation collectées à partir de la demande elle-même sont toutes des dimensions liées à l' video_view événement. Le système Analytics enregistre 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 event paramètre décrit l'événement qui s'est produit. Le domain paramètre fournit un espace de noms pour les événements. Les event, domain, et session sont des paramètres obligatoires (la valeur de domain est toujours videocloud).

    Paramètres supplémentaires

    Certains paramètres doivent être inclus avec les événements afin 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 inclut 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é maintenue. (renvoie une image GIF transparente de 1x1 pixel)
    400 La demande envoyée par le client manque un paramètre obligatoire : domain, account ou event. (Cet état ne sera pas retourné si des paramètres spécifiques au domaine sont manquants.) "Invalid 'event' parameter"
    50x Ceci est un code d'erreur indique un problème côté serveur. Votre événement peut avoir été enregistré avec succès par le système d'analyse. "Server-side failure, please retry."

    Données minimales

    Au minimum, vous devez envoyer un session identifiant et un video_view événement pour chaque vidéo jouée au cours d'une session. Le video_view devrait être envoyé après toutes les annonces pré-roll terminées.

    session

    Il s'agit de l'identificateur de session. session Il s'agit essentiellement d'une vue d'une page ou d'une vue d'application qui contient un lecteur, aussi longtemps que cela dure. La valeur doit être constante pour la durée de la session et envoyée 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 ignorées comme invalides si elles ne peuvent pas être démêlées.

    Il existe différents schémas 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 les performances (taux de jeu et score d'engagement)

    Événements

    • video_impression
    • video_view
    • video_engagement

    Attributs (tous les événements)

    • account
    • video

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

    VOD
    • range
    • video_duration
    En direct
    • video_seconds_viewed

    En-têtes HTTP

    • User-Agent - Requis pour les rapports d'appareil

    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 en général. Nous recommandons :

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

    Envoi de 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érités par le système Analytics. Si un événement contient des informations inappropriées ou incorrectes, le système Analytics interprète 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 biaisées de manière à affecter la synthèse globale.

    Encodage URI

    Toutes les chaînes que vous envoyez à l'API de collecte de données qui peuvent contenir des espaces ou des caractères spéciaux doivent être encodées en URI pour que la demande soit réussie. Si vous soumettez la requête via JavaScript, vous pouvez utiliser la encodeURI() méthode pour 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 Analytics.

    player_load
    Intente/Sens

    Une session de joueur a été initié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
    Intente/Sens

    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
    Intente/Sens

    Envoyé lorsqu'une demande à l'API de lecture de Video Cloud est faite.

    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
    Intente/Sens

    Envoyé lorsqu'une réponse à un précédent catalog_request est reçue.

    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
    Intente/Sens

    Envoyé lorsque la lecture est initiée soit par l'utilisateur en 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. Notez que plusieurs play_request événements peuvent être envoyés au cours d'une seule session de visualisation si le spectateur interrompt et reprend la vidéo.

    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
    Intente/Sens

    Envoyé lorsque le contrôle est remis à un agent publicitaire par la plate-forme 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
    Intente/Sens

    Envoyé lorsque le contrôle est remis à un agent publicitaire par la plate-forme 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
    Intente/Sens

    Les métadonnées d'une vidéo ajoutée au lecteur ont terminé le chargement et le lecteur est prêt à déclencher l'événement de vue, soit via la lecture automatique ou l'interaction de 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
    Intente/Sens

    Une vidéo a commencé à lire (lecture automatique après chargement ou en raison de l'interaction de l'utilisateur). Notez qu'un seul video_view événement est enregistré au cours d'une session de visualisation même si le spectateur arrête, redémarre ou relance la vidéo.

    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
    Intente/Sens

    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, en fonction de l'interaction de l'utilisateur et de la durée de la vidéo. L'instrumentation du lecteur Brightcove envoie cet événement toutes les 10 secondes, si la lecture n'est pas interrompue. Les événements décrivant des plages de plus de 20 secondes 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 toute information pertinente à l'état actuel du système au moment où l'événement s'est produit, et être aussi précis que possible. Cette section détaille les paramètres pouvant être envoyés avec tous les événements, et les sections suivantes présentent les paramètres d'événements spécifiques.

    Champ Type Description
    account Chaîne

    ID du compte

    domain Chaîne

    toujours égal à videocloud

    Valeurs autorisées : "videocloud"

    session Chaîne Un identifiant de session aussi universel que possible - voir la section Données minimales 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 système d'exploitation et le type de périphérique sont inclus ou si la valeur soumise ne figure pas dans la liste de valeurs affichée ici. Typiquement non inclus)

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

    device_os_version optionnel Chaîne

    Version du système d'exploitation utilisée par l'appareil. Lorsqu'il n'est pas spécifié, cela 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 de périphérique à l'origine de l'événement dans les cas où l'agent utilisateur n'est pas fiable (ignoré sauf si le système d'exploitation et le type de périphérique sont inclus ou si la valeur soumise ne figure pas dans la liste de valeurs affichée ici. Typiquement non inclus)

    Valeurs autorisées: "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 qui est à l'origine de l'événement

    source optionnel Chaîne

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

    time optionnel Nombre

    l'horodatage de l'événement en temps d'époque (millisecondes)

    country optionnel Chaîne

    ISO-3166 (alpha 2) région CISO-3166 (alpha 2) code de région (remplacement au cas où le système ne peut pas détecter des informations géographiques à partir de l'adresse IP) Typiquement Non inclus

    country_name optionnel Chaîne

    Nom de pays lisible par l'homme (remplacement au cas où le système ne peut pas détecter des informations géographiques à partir de l'adresse IP)

    region optionnel Chaîne

    Code régional ISO-3166 (alpha 2) (remplacement au cas où le système ne peut pas détecter d'informations géographiques à partir de l'adresse IP) Non inclus

    region_name optionnel Chaîne

    Nom de région lisible par l'homme (remplacement au cas où le système ne peut pas détecter d'informations géographiques à partir de l'adresse IP) Non généralement inclus

    city optionnel Chaîne

    Nom de ville non inclus

    user optionnel Chaîne

    Identificateur d'utilisateur unique - s'il n'est pas fourni ou vide, Video Cloud utilise la méthode de secours consistant à utiliser la Source IP address + the User-Agent chaîne 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 l'API ou le module Analytics

    Paramètre utilisateur

    • Si l'application lecteur/client souhaite suivre la visionneuse unique, elle doit envoyer un ID unique à l'utilisateur en tant que paramètre utilisateur au collecteur.
    • Si le n' user est pas fourni ou est vide, nous utilisons la méthode de secours qui consiste à utiliser l' Source IP address + the User-Agent String comme identifiant unique.
    • La valeur du paramètre utilisateur n'est jamais stockée dans les logs/base de données, seul un hachage (en utilisant SHA-256) est stocké.
    • Aucun cookie n'est mis en place par le collecteur.

    Utilisateur unique

    Vous pouvez utiliser la fonctionnalité plug-in de Brightcove Player pour ajouter des données uniques de visionneur vidéo aux analyses rapportées. Pour ce faire, vous allez ajouter un identifiant unique à l' 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 par exemple, ce code suppose qu'une URL de connexion est capturée contenant 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 plugin Brightcove Player avec le nom du plugin défini comme uniqueUserForAnalyticsPlugin. Le plugin accepte également un options objet, qui contient des données transmises au plugin.
    • La myPlayer variable se voit attribuer une référence au joueur. En outre, deux autres variables sont créées.
    • La userPath variable se voit attribuer le chemin passé au plugin via l' options objet.
    • La uniqueViewer variable est affectée à la version analysée de la userPath , de sorte que seuls les chiffres de l'ID utilisateur sont affectés à la variable.
    • Une propriété utilisateur est ajoutée à l' settings objet du plugin 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;
      });
      
      

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

    Depuis Studio, utilisez la section Plugins pour charger le plugin dans le lecteur, comme indiqué.

    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 devrait être mis à jour en conséquence pour extraire l'ID utilisateur unique.

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

    Pour plus d'informations sur le développement de plugin, voir étape par étape : Document de développement de plug-in .

    device_type, device_os , device_os_version , device_manufacturer , et browser_type paramètres

    Par défaut, le système Analytics tente de détecter le type de périphérique et les informations du 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 au profit de device_type et device_os. Dans la plupart des cas, vous n'avez pas besoin d'envoyer des informations sur l'appareil, le système d'exploitation et le navigateur . Ce remplacement ne doit être utilisé que si l'agent utilisateur n'est pas fiable ou autrement indisponible.

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

    Données géographiques Paramètres

    Par défaut, le système Analytics tente de détecter les informations géographiques provenant de l'adresse IP distante. Ce comportement peut être remplacé 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 autrement indisponible.

    Le système Analytics enregistre ZZ ou unknown si une demande inclut des valeurs non reconnues pour les remplacements.

    Paramètres de destination et source

    le 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 source paramètre est utilisé pour déterminer les informations sur la source de trafic. Si source cette option n'est pas spécifiée, le système Analytics traitera les événements comme étant initiés par le trafic direct.

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

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

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

    Paramètre Montant
    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 doivent être des URI valides qui identifient l'endroit où la vidéo est lue et comment l'utilisateur y est arrivé, respectivement.

    En supposant que le destination est un URI valide:

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

    le système Analytics le gérera comme suit :

    Si l'URI contient une autorité, la réponse de l'API utilisera cette autorité comme chemin destination_domain et tout chemin fourni en tant que destination_path. Si l'URI ne contient pas d'autorité, l'API n'enregistre pas un destination_domain. Le destination_path sera enregistré comme chemin d'accès dans l'URI. Un destination sans partie hiérarchique (par exemple, juste un schéma) est considéré comme invalide, tout 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 les error événements.

    Champ Type Description
    error_code optionnel Nombre

    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 les catalog_request événements.

    Champ Type Description
    catalog_url optionnel Chaîne

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

    catalog_response paramètres d'événement

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

    Champ Type Description
    catalog_url optionnel Chaîne

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

    response_time_ms optionnel Nombre

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

    paramètres de l'événement video_impression

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

    Champ Type Description
    video optionnel Chaîne

    l'ID de la vidéo

    video_name optionnel Chaîne

    le nom de la vidéo

    paramètres d'événement video_view

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

    Champ Type Description
    video optionnel Chaîne

    l'ID de la vidéo

    video_name optionnel Chaîne

    le nom de la vidéo

    start_time_ms optionnel Chaîne

    Temps, en millisecondes, entre le début 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 correspond au temps entre les play_request et video_view événements. S'il y a une annonce pré-oll, le temps entre ad_mode_begin et ne ad_mode_complete doit pas être inclus

    paramètres de l'événement video_engagement

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

    Champ Type Description
    video optionnel Chaîne

    l'ID 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 affichée pour les video_engagement événements au format StartSecond..EndSecond (les valeurs StartSecond et EndSecond doivent être des nombres entiers [entiers]) - la plage peut être laissée hors d'un événement d'engagement pour montrer que pendant la période couvert par l'événement, il n'y avait pas d'activité de visionnage. (par exemple, lorsqu'il n'y a qu'une activité de remise en mémoire tampon)

    rendition_url optionnel Chaîne

    URL du dernier format associé sélectionné. Par exemple, pour un flux HLS, il s'agit de l'URL de la variante la plus récente sélectionnée

    rendition_indicated_bps optionnel Chaîne

    Le débit binaire indiqué, en bits par seconde, du rendu le plus récent

    rendition_mime_type optionnel Chaîne

    Le type mime du dernier format associé sélectionné

    rendition_height optionnel Chaîne

    Hauteur encodée du rendu vidéo en pixels

    rendition_width optionnel Chaîne

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

    rebuffering_seconds optionnel Chaîne

    Nombre de secondes que l'utilisateur a passé à attendre la lecture de la vidéo en raison d'un retard non demandé au cours de la période d'engagement

    rebuffering_count optionnel Chaîne

    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 optionnel Chaîne

    Nombre de secondes de vidéo résidant actuellement dans la mémoire tampon avant

    measured_bps optionnel Chaîne

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

    player_width optionnel Chaîne

    Largeur de pixel actuelle du joueur à la fin de la plage de fiançailles

    player_height optionnel Chaîne

    Hauteur de pixel actuelle du joueur à la fin de la plage de fiançailles

    dropped_frames optionnel Chaîne

    dropped_frames

    video_duration optionnel Nombre

    la durée de la vidéo en secondes

    video_seconds_viewed optionnel Nombre

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

    L' video_engagement é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. (L'instrumentation du lecteur Flash/HTML5 envoie cet événement toutes les 10 secondes, si la lecture n'est pas interrompue.) À l'heure actuelle, les événements décrivant des plages de plus de 20 secondes sont ignorés par le système 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 (d'autres paramètres omis par souci de concision) :

    Exemple C'est-à-dire
      event=video_engagement&video=123&video_duration=75&range=0..9
      
      
    Vidéo 123 d'une durée de 75 secondes jouées 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 ont été visionnées.

    Bien que les deux versions suivent les secondes vues, la version qui inclut video_duration et contient range également les informations nécessaires pour calculer des données d'engagement supplémentaires, et est la méthode préférée pour envoyer des données d' video_engagement événement au système Analytics. Pour les diffusions en direct, ou dans les cas où la chronologie de la vidéo est en constante évolution pendant la lecture ou est autrement peu fiable, video_seconds_viewed seront les seules données disponibles. Pour la VOD, sauf si duration elle n'est pas disponible, l' video_engagement événement doit 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 Analytics calculera les métriques d'engagement à partir de 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: Version du système d'exploitation utilisée par l'appareil. Lorsqu'il n'est pas spécifié, cela sera calculé en analysant la chaîne de l'agent utilisateur pour la demande de suivi.

    platform_version: Permet d'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

    catalog_request: Envoyé lorsqu'une requête à l'API du catalogue videocloud est faite - notez que cet événement est destiné à un usage interne et n'est pas exposé dans le module Analytics ou via l'API Analytics.

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

    catalog_response: Envoyé lorsqu'une réponse à un précédent catalog_request est reçue - notez que cet événement est destiné à un usage interne et n'est pas exposé dans le module Analytics ou via l'API Analytics.

    • catalog_url: URL de destination associée à l' catalog_request événement qui a initié cette réponse - notez que cet événement est destiné à un usage interne et n'est pas exposé dans le module Analytics ou via l'API Analytics.
    • response_time_ms: Temps, en millisecondes, entre l' catalog_request événement et l' catalog_response événement - notez que cet événement est destiné à un usage interne et n'est pas exposé dans le module Analytics ou via l'API Analytics.

    play_request: Envoyé lorsque la lecture est initiée soit par l'utilisateur en 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 remis à un agent publicitaire par la plate-forme de lecture.

    ad_mode_complete : [Remplace ad_end] Envoyé lorsque le contrôle est remis 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.

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

    Événements mis à jour pour V2

    video_view: Inclut de nouvelles mesures de latence

    • load_time_ms: Temps, en millisecondes, entre le lancement du chargement des données pour la vidéo et la vidéo devenant jouable.
    • start_time_ms: Temps, en millisecondes, entre le début de la lecture et la première image de la vidéo en cours de rendu. Cela peut être différent en fonction de l'expérience, par exemple, si aucune annonce pré-roll n'est configurée, cette mesure est le temps entre la « play_request » et les video_view événements. S'il y a une annonce prérooll, le temps entre ad_mode_begin et ne ad_mode_complete doit pas être inclus.

    video_engagement: Inclut des informations supplémentaires sur la sélection du format associé, les mesures de débit binaire et la mise en mémoire tampon. Un changement subtil a également été apporté à l'engagement vidéo en ce sens qu'il devait être envoyé périodiquement même si aucun affichage n'a eu lieu pendant la période d'engagement. Cette modification vise à permettre le suivi des retards de remise en mémoire tampon et des dénombrements qui font attendre la lecture des utilisateurs.

    • gamme: Le paramètre de plage est désormais facultatif, la plage peut être laissée hors d'un événement d'engagement pour indiquer qu'au cours de la période couverte par l'événement, il n'y a pas eu d'activité d'affichage. (par exemple, lorsqu'il n'y a qu'une activité de remise en mémoire tampon)
    • rendition_url: URL du dernier format associé sélectionné. Par exemple, pour un flux HLS, il s'agit de l'URL de la variante la plus récente sélectionnée.
    • rendition_indicated_bps: Débit binaire indiqué, en bits par seconde, du rendu le plus récent sélectionné.
    • rendition_mime_type: Type mime du dernier format associé sélectionné.
    • rendition_height: Hauteur encodée du rendu vidéo en pixels
    • rendition_width: La largeur encodée du rendu vidéo en pixels
    • rebuffering_seconds: Nombre de secondes que l'utilisateur a passé à attendre la lecture de la vidéo en raison d'un retard non demandé pendant la période d'engagement.
    • rebuffering_count: 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: Nombre de secondes de vidéo résidant actuellement dans la mémoire tampon avant.
    • mesured_bps: Rapport entre le nombre de bits inclus dans le segment le plus récent téléchargé et le temps passé à télécharger ce segment, en bits par seconde.
    • player_width Largeur de pixel actuelle du joueur à la fin de la plage de fiançailles.
    • player_height Hauteur de pixel actuelle du joueur à la fin de la plage de fiançailles.
    • dropped_frames: Nombre d'images supprimées de la lecture vidéo au cours de cette période d'engagement