Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    Überblick: Data Collection API v2

    In diesem Thema erhalten Sie einen Überblick über die Analytics Data Collection API v2, mit dem Sie Ereignisse zu Ihrem hinzufügen können Video Cloud Analysedaten in Situationen, in denen Brightcove die Ereignisse nicht direkt verfolgen kann.

    Einführung

    Analytics-Daten werden automatisch vom gesendet Brightcove Players, einschließlich der vom Eingeborenen bereitgestellten Player SDKs. Wenn du bist Verwendung eines Brightcove Player . Video Cloud Videos müssen Sie die instrumentieren player Sie verwenden, um die Daten an den Datenkollektor zu senden.

    Data Collection API v2 ist der aktuelle Standard. Die v1-Version ist veraltet. Wenn Sie eine v1-Implementierung haben, lesen Sie den Abschnitt Änderungen von v1 Abschnitt unten.

    Neben dieser Übersicht und der API-Referenz, sieh das auch Beispiel Implementierung.

    Die Analytics Data Collection API ist der Endpunkt für Echtzeitanalyseereignisse. Ereignisdaten werden über eine Reihe von Parametern, die über HTTP-Anforderungen übermittelt werden, an Brightcove gesendet, z.

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

    Diese Parameter beschreiben a Tatsache über den Zustand des Systems, als ein Ereignis auftrat. Das obige Beispiel beschreibt die Tatsache, dass a video_view Ereignis trat für Video auf 789 für Rechnung 123 (oder: ein Nutzer hat begonnen, ein Konto anzusehen 123's Video 789. Sehen unten für eine Beschreibung der aktuellen verfolgten Analyseereignisse).

    Maße

    Dimensionen sind qualitative Fakten über den Zustand des Systems, wenn ein Ereignis eintritt. Zum Beispiel, wenn die Anfrage lautet:

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

    Die Video-ID ( 789) und Konto-ID ( 123) und alle Geräte - und Standortinformationen, die aus der Anfrage selbst entnommen werden, sind alle Dimensionen, die mit der video_view Veranstaltung. Das Analytics-System zeichnet Folgendes auf: a video_view Bei diesen Anforderungen ist ein Ereignis eingetreten, als diese Anforderung ausgeführt wurde.

    Ereignis- und Domänenparameter

    Das event Parameter beschreibt, welches Ereignis aufgetreten ist. Das domain Parameter stellt einen Namespace für Ereignisse bereit. Das event, domain, und session sind erforderliche Parameter (der Wert von domain immer videocloud).

    Zusätzliche Parameter

    Bestimmte Parameter müssen in Ereignissen enthalten sein, damit das Analytics-System sie erfolgreich analysieren kann

    Antworttypen

    Die Antwort auf eine Analytics-Datenerfassungs-API-Anfrage enthält einen HTTP-Antwortcode und eine für Menschen lesbare Nachricht.

    HTTP-Status-Code Beschreibung Beispiel
    200 Die Anfrage wurde erfolgreich vom Collector empfangen und wurde beibehalten. (gibt ein 1x1-Pixel-transparentes GIF-Bild zurück)
    400 Für die vom Client gesendete Anfrage fehlt ein erforderlicher Parameter: domain, account or event. (Dieser Status wird nicht zurückgegeben, wenn domänenspezifische Parameter fehlen.) "Invalid 'event' parameter"
    50x Dies ist ein Fehlercode, der auf ein Problem auf der Serverseite hinweist. Möglicherweise wurde Ihr Ereignis vom Analysesystem erfolgreich aufgezeichnet. "Server-side failure, please retry."

    Minimale Daten

    Zumindest sollten Sie eine senden session id und video_view Ereignis für jedes Video, das während einer Sitzung abgespielt wird. Das video_view sollte gesendet werden nach Alle Pre-Roll-Anzeigen sind abgeschlossen.

    session

    Dies ist die Sitzungskennung. Das session ist im Wesentlichen eine Ansicht einer Seiten- oder App-Ansicht mit einem player darin, solange das dauert. Der Wert sollte für die Dauer der Sitzung und konstant sein Für alle Ereignisse gesendet. Es sollte so nahe wie möglich an einem global eindeutigen Bezeichner (GUID) liegen. Bei Kollisionen können die beiden Sitzungen als ungültig verworfen werden, wenn sie nicht getrennt werden können.

    Es gibt verschiedene Schemata zum Erstellen von GUIDs in JavaScript. Ein Beispiel ist in Dieses GitHub-Repository. Bitte beachten Sie, dass Skripte von Drittanbietern von Brightcove nicht unterstützt werden.

    Minimale Daten für die Leistung (Wiedergaberate & EngageWertung)

    Veranstaltungen

    • video_impression
    • video_view
    • video_engagement

    Attribute (alle Ereignisse)

    • account
    • video

    Zusätzliche Attribute (video_engagement Nur Veranstaltung)

    VOD
    • range
    • video_duration
    Live
    • video_seconds_viewed

    HTTP-Header

    • User-Agent - Erforderlich für Geräteberichte

    Best Practices

    Um sicherzustellen, dass Sie die richtigen Daten an den Collector senden, sollten Sie Ihr Datensammlungsskript testen, bevor Sie es allgemein bereitstellen. Wir empfehlen:

    1. Erstellen Sie das Datenerfassungsskript für Ihre player.
    2. Test in einer kontrollierten Umgebung für mindestens einen Tag.
    3. Überprüfen Sie die Analysedaten entweder über das Analytics-Modul oder das Analytics API um sicherzustellen, dass das, was gesammelt wurde, Ihren Erwartungen entspricht.

    Senden der Anfrage - Vermeiden von CORS-Problemen

    Junk-Daten

    Im Allgemeinen werden Daten, die an den Collector gesendet werden, vom Analytics-System als wahr gemeldet. Wenn ein Ereignis unangemessene oder falsche Informationen enthält, interpretiert das Analytics-System die Daten falsch.

    Wenn Sie beispielsweise den Zeitstempel versehentlich als Video-ID senden, werden Ihre Analysedaten so verzerrt, dass sie sich auf die gesamte Zusammenfassung auswirken.

    URI-Codierung

    Alle Zeichenfolgen, die Sie an die Data Collection API das könnte Leerzeichen oder Sonderzeichen enthalten muss URI-codiert sein damit die Anfrage erfolgreich ist. Wenn Sie die Anfrage über JavaScript einreichen, können Sie die encodeURI() Methode die Encodierung der Anforderungszeichenfolge. Beispielsweise:

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

    Veranstaltungen

    Die unten aufgeführten Ereignisse werden vom Analytics-System verarbeitet.

    player_load
    Absicht / Bedeutung

    A player Die Sitzung wurde von einem Endbenutzer initiiert. Dies markiert den Beginn der Analysesitzung und sollte vor allen anderen Ereignissen gesendet werden.

    Beispiel
    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
    Absicht / Bedeutung

    Wird gesendet, wenn schwerwiegende Fehler auftreten, die die Wiedergabe beeinträchtigen.

    Beispiel
    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
    Absicht / Bedeutung

    Gesendet, wenn eine Anfrage an die Video Cloud Playback API hergestellt wird.

    Beispiel
    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
    Absicht / Bedeutung

    Wird gesendet, wenn eine Antwort auf einen Prior vorliegt catalog_request Ist angekommen.

    Beispiel
    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
    Absicht / Bedeutung

    Wird gesendet, wenn die Wiedergabe entweder vom Benutzer ausgelöst wird, der ausdrücklich auf die Wiedergabetaste klickt, oder automatisch, wenn die Plattform die Wiedergabe in einem Szenario mit automatischer Wiedergabe auslöst.

    Beispiel
    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
    Absicht / Bedeutung

    Wird gesendet, wenn die Kontrolle von der Wiedergabeplattform an einen Werbeagenten übergeben wird.

    Beispiel
    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
    Absicht / Bedeutung

    Wird gesendet, wenn die Kontrolle von der Wiedergabeplattform an einen Werbeagenten übergeben wird.

    Beispiel
    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
    Absicht / Bedeutung

    Die Metadaten für ein Video wurden hinzugefügt player hat das Laden beendet und die player ist bereit, das Ansichtsereignis entweder über die automatische Wiedergabe oder die Benutzerinteraktion auszulösen.

    Beispiel
    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
    Absicht / Bedeutung

    Ein Video wird wiedergegeben (entweder automatisch nach dem Laden oder durch Benutzerinteraktion).

    Beispiel
    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
    Absicht / Bedeutung

    Ein Benutzer hat einen Bereich von Sekunden der Zeitleiste eines Videos angesehen. Dieses Ereignis ist ein Herzschlag für die Verfolgung des Video-Engagements und wird während der Wiedergabe wahrscheinlich mehrmals gesendet, abhängig von der Benutzerinteraktion und der Länge des Videos. Die helle Bucht player Die Instrumentierung sendet dieses Ereignis alle 10 Sekunden, wenn die Wiedergabe nicht unterbrochen wird. Ereignisse, die Bereiche über 20-Sekunden hinweg beschreiben, werden vom Analytics-System verworfen.

    Beispiel
    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

    Parameter für alle Ereignisse

    Die Parameter für diese Ereignisse sollten alle Informationen enthalten, die für den aktuellen Zustand des Systems beim Auftreten des Ereignisses relevant sind, und so genau wie möglich sein. In diesem Abschnitt werden Parameter beschrieben, die mit allen Ereignissen gesendet werden können. In den folgenden Abschnitten werden Parameter für bestimmte Ereignisse angezeigt.

    Feld Typ Beschreibung
    account Schnur

    Konto-ID

    domain Schnur

    immer gleich videocloud

    Erlaubte Werte: "videocloud"

    session Schnur Eine Session-ID, die so universell wie möglich ist - siehe Minimal Daten Abschnitt oben für weitere Informationen
    device_os fakultativ Schnur

    Überschreiben, um das Betriebssystem des Geräts anzugeben, von dem das Ereignis ausgelöst wurde, in Fällen, in denen der Benutzeragent unzuverlässig ist (ignoriert, sofern weder Geräte- noch Gerätetyp enthalten sind oder wenn der übergebene Wert nicht in der Liste der hier angezeigten Werte enthalten ist). In der Regel nicht enthalten)

    Erlaubte Werte: "android", "bada", "ios", "linux", "mac", "tv", "os_x", "rim", "sybian", "windows", "other"

    device_os_version fakultativ Schnur

    Die Version von os, die vom Gerät verwendet wird. Wenn nicht angegeben, wird dies berechnet, indem die User-Agent-Zeichenfolge für die Verfolgungsanforderung analysiert wird

    device_type fakultativ Schnur

    Überschreiben, um den Typ des Geräts anzugeben, von dem das Ereignis ausgelöst wurde, wenn der Benutzeragent unzuverlässig ist (wird ignoriert, es sei denn, sowohl der Geräte- als auch der Gerätetyp sind enthalten oder wenn der übergebene Wert nicht in der Liste der hier angezeigten Werte enthalten ist. In der Regel nicht enthalten)

    Erlaubte Werte: "mobile", "tablet", "tv", "desktop", "other"

    event Schnur

    der Ereignistyp

    Erlaubte Werte: "player_load", "catalog_request", "catalog_response", "play_request", "ad_mode_begin", "ad_mode_complete", "video_impression", "video_view", "video_engagement", "error"

    destination fakultativ Schnur

    URI, die das Ereignis ausgelöst hat

    source fakultativ Schnur

    URI, mit dem der Endbenutzer an die destination URI

    time fakultativ Nummer

    der Zeitstempel für das Ereignis in der Epochenzeit (Millisekunden)

    country fakultativ Schnur

    ISO-3166 (Alpha 2) -Region cISO-3166 (Alpha 2) -Regionscode (Außerkraftsetzung für den Fall, dass das System keine geographischen Informationen von der IP-Adresse erkennen kann) In der Regel nicht enthalten

    country_name fakultativ Schnur

    Vom Menschen lesbarer Ländername (außer Kraft setzen, falls das System keine geographischen Informationen von der IP-Adresse erkennen kann) In der Regel nicht enthalten

    region fakultativ Schnur

    ISO-3166 (Alpha 2) -Regionscode (Außerkraftsetzung für den Fall, dass das System geografische Informationen von der IP-Adresse nicht erkennen kann) In der Regel nicht enthalten

    region_name fakultativ Schnur

    Name der lesbaren Region (Überschreiben, falls das System keine geographischen Informationen von der IP-Adresse erkennen kann) In der Regel nicht enthalten

    city fakultativ Schnur

    Stadtname In der Regel nicht enthalten

    user fakultativ Schnur

    Eine eindeutige Benutzerkennung - falls nicht angegeben oder leer, Video Cloud verwendet die Fallback - Methode der Verwendung der Source IP address + the User-Agent String als eindeutige Kennung; Beachten Sie, dass Brightcove diese Informationen nur zur Berechnung eindeutiger Benutzer verwendet. Die Benutzerdaten selbst können nicht über die API oder das Analytics-Modul abgerufen werden

    Benutzerparameter

    • Wenn die playerDie / client-Anwendung möchte den eindeutigen Viewer verfolgen. Sie sollte eine eindeutige ID für den Benutzer als Benutzerparameter an den Collector senden.
    • Wenn die user wird nicht zur Verfügung gestellt oder ist leer, wir verwenden die Fallback-Methode der Verwendung der Source IP address + the User-Agent String als eindeutige Kennung.
    • Der Wert des Benutzerparameters wird nie in den Protokollen / der Datenbank gespeichert, nur ein Hash (unter Verwendung von SHA-256) wird gespeichert.
    • Vom Sammler werden keine Cookies gesetzt.

    Eindeutiger Benutzer

    Sie können verwenden Brightcove PlayerPlug-in-Funktionalität zum Hinzufügen eindeutiger Video-Viewer-Daten zu den gemeldeten Analysen. Um dies zu tun, fügen Sie eine eindeutige Kennung zu dem hinzu settings Objekt der Analytics-Funktionalität.

    Wie eine eindeutige Benutzer-ID erfasst wird, variiert natürlich von Anwendung zu Anwendung. Für ein Beispiel geht dieser Code jedoch davon aus, dass eine Anmelde-URL erfasst wird, die eindeutige Benutzerdaten enthält, z http://exampledomain.com/users/912389123. Diese eindeutige URL wird an das Plugin übergeben.

    Der folgende Code des Plugins führt die folgenden Aufgaben aus:

    • Verwendet die Standardsyntax zum Erstellen eines Brightcove Player Plugin mit dem Namen des Plugins definiert als uniqueUserForAnalyticsPlugin. Das Plugin akzeptiert auch ein options Objekt, das Daten enthält, die an das Plugin übergeben werden.
    • Das myPlayer Variable wird ein Verweis auf die zugewiesen player. Außerdem werden zwei weitere Variablen erstellt.
    • Das userPath Variable wird der Pfad zugewiesen, der über das Plugin an das Plugin übergeben wird options Objekt.
    • Das uniqueViewer Die Variable wird der geparsten Version von userPath, daher werden nur die Benutzer-ID-Ziffern der Variablen zugewiesen.
    • Eine Benutzereigenschaft wird dem Analytics-Plugin hinzugefügt settings Objekt.
      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;
      });
      
      

    Dieser Code müsste geändert werden, um Ihrer Anwendungslogik zu entsprechen, und dann in einer Internet-URL gespeichert werden.

    Verwenden Sie von Studio aus die Plugins Abschnitt zum Laden des Plugins in die player, wie gezeigt.

    Studio Plugin Abschnitt
    Studio Plugin Abschnitt

    Anstelle des folgenden JSON würden Sie dem String die Zeichenfolge mit den Benutzerdaten übergeben. Natürlich müsste der Plugin-Code entsprechend aktualisiert werden, um die eindeutige Benutzer-ID zu extrahieren.

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

    Weitere Informationen zur Pluginentwicklung finden Sie in der Schritt für Schritt: Plugin-Entwicklung Dokument.

    device_type, device_os, device_os_version, device_manufacturer, und browser_type Parameter

    Standardmäßig versucht das Analytics-System, Gerätetyp- und Betriebssysteminformationen aus dem User-Agent-Header zu erkennen. Ob beide device_type und device_os gesendet werden, werden die Informationen aus dem User-Agent-Header zugunsten von ignoriert device_type und device_os. In den meisten Fällen müssen Sie keine Geräte-, Betriebssystem- und Browserinformationen senden - Diese Überschreibung sollte nur verwendet werden, wenn der Benutzer-Agent unzuverlässig oder anderweitig nicht verfügbar ist.

    Das Analytics-System zeichnet auf other wenn eine Anfrage nicht erkannte Werte für Geräteparameterüberschreibungen enthält.

    Geografische Daten Parameter

    Standardmäßig versucht das Analytics-System, geographische Informationen von der Remote-IP-Adresse zu erkennen. Dieses Verhalten kann durch Übergeben überschrieben werden country, country_name, region, region_name, city und dma Parameter. In den meisten Fällen sind diese Parameter nicht erforderlich - Diese Außerkraftsetzung sollte nur verwendet werden, wenn die Remote-IP-Adresse unzuverlässig oder anderweitig nicht verfügbar ist.

    Das Analytics-System zeichnet auf ZZ or unknown wenn eine Anfrage nicht erkannte Werte für Überschreibungen enthält.

    Ziel- und Quellparameter

    Das destination und source Parameter liefern den URI, der das Ereignis ausgelöst hat ( destination) und die URI, die den Benutzer dorthin geschickt hat ( source).

    Das source Parameter wird verwendet, um Verkehrsquellinformationen zu bestimmen. Ob source Wenn das Analytics-System nicht angegeben ist, behandelt es Ereignisse als vom direkten Datenverkehr initiiert.

    Das destination Parameter wird verwendet, um Informationen zum Verkehrsziel zu bestimmen - das heißt, wo das Video angeschaut wird. Wenn der URI keine Berechtigung enthält, zeichnet das API keine auf destination_domaindem „Vermischten Geschmack“. Seine destination_path wird als Pfad im URI aufgezeichnet.

    Während der Webwiedergabe ist die URL in der Adressleiste der Seite, auf der das Video abgespielt wird, die destinationUnd der source ist der Referrer ( top.document.referrer).

    Wenn Sie beispielsweise auf der Brightcove-Support-Website nach "Live-Streaming-Wirecast" suchen und ein Video ansehen, das in den Ergebnissen angezeigt wird:

    Parameter Wert
    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
      
      

    Wenn keine URL vorhanden ist (z. B. bei nativer Wiedergabe), beide destination und source sollten gültige URIs sein, die angeben, wo das Video abgespielt wird und wie der Nutzer dorthin gelangt ist.

    Angenommen, das destination ist ein gültiger URI:

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

    Das Analytics-System wird es wie folgt behandeln:

    Wenn der URI einen enthält Autorität, verwendet die API - Antwort diese Autorität als destination_domain und jeder Pfad als der zur Verfügung gestellt destination_path. Wenn der URI keine Berechtigung enthält, zeichnet das API keine auf destination_domaindem „Vermischten Geschmack“. Seine destination_path wird als Pfad im URI aufgezeichnet. EIN destination ohne einen hierarchischen Teil (z. B. nur ein Schema) gilt als ungültig, ebenso wie jeder Wert ohne Schema.

    Parameter für bestimmte Ereignisse

    Fehlerereignisparameter

    Die folgenden Parameter sollten mit gesendet werden error Veranstaltungen.

    Feld Typ Beschreibung
    error_code fakultativ Nummer

    Ein plattformspezifischer Fehlercode, der dem Ereignis zugeordnet ist

    catalog_request Event-Parameter

    Die folgenden Parameter sollten mit gesendet werden catalog_request Veranstaltungen.

    Feld Typ Beschreibung
    catalog_url fakultativ Schnur

    Die Ziel-URL, die dem catalog_request-Ereignis zugeordnet ist

    catalog_response-Ereignisparameter

    Die folgenden Parameter sollten mit gesendet werden catalog_response Veranstaltungen.

    Feld Typ Beschreibung
    catalog_url fakultativ Schnur

    Die Ziel-URL, die dem catalog_request-Ereignis zugeordnet ist, das diese Antwort ausgelöst hat

    response_time_ms fakultativ Nummer

    Die Zeit in Millisekunden zwischen dem catalog_request-Ereignis und dem catalog_response-Ereignis

    video_impression Ereignisparameter

    Die folgenden Parameter sollten mit gesendet werden video_impression Veranstaltungen.

    Feld Typ Beschreibung
    video fakultativ Schnur

    die Video-ID

    video_name fakultativ Schnur

    der Name des Videos

    video_view Ereignisparameter

    Die folgenden Parameter sollten mit gesendet werden video_view Veranstaltungen.

    Feld Typ Beschreibung
    video fakultativ Schnur

    die Video-ID

    video_name fakultativ Schnur

    der Name des Videos

    start_time_ms fakultativ Schnur

    Die Zeit in Millisekunden zwischen dem Beginn der Wiedergabe und dem ersten Bild des gerenderten Videos. Dies kann je nach Erfahrung unterschiedlich sein. Wenn beispielsweise keine Pre-Roll-Anzeigen konfiguriert sind, ist diese Messung die Zeit zwischen der play_request und video_view Veranstaltungen. Wenn es eine Preroll-Anzeige gibt, ist die Zeit zwischen ad_mode_begin und ad_mode_complete sollte nicht enthalten sein

    video_game Event-Parameter

    Die folgenden Parameter sollten mit gesendet werden video_engagement Veranstaltungen.

    Feld Typ Beschreibung
    video fakultativ Schnur

    die Video-ID

    video_name fakultativ Schnur

    der Name des Videos

    range fakultativ Schnur

    Die Reichweite des Videos, für das die Wiedergabe erfolgt ist video_engagement Ereignisse im Format StartSecond..EndSecond (Die Werte StartSecond und EndSecond müssen ganze Zahlen [Ganzzahlen] sein) - Der Bereich kann aus einem Engagement-Ereignis herausgelassen werden, um zu zeigen, dass während des vom Ereignis abgedeckten Zeitraums keine Anzeigeaktivitäten stattfanden. (Wenn beispielsweise nur eine erneute Pufferung stattfindet)

    rendition_url fakultativ Schnur

    Die URL zur zuletzt ausgewählten Wiedergabe. Bei einem HLS-Stream wäre dies beispielsweise die URL der zuletzt ausgewählten Variante

    rendition_indicated_bps fakultativ Schnur

    Die angegebene Bitrate in Bits pro Sekunde der zuletzt ausgewählten Wiedergabe

    rendition_mime_type fakultativ Schnur

    Der Mime-Typ der zuletzt ausgewählten Wiedergabe

    rendition_height fakultativ Schnur

    Die kodierte Höhe der Videowiedergabe in Pixeln

    rendition_width fakultativ Schnur

    Die codierte Breite der Videowiedergabe in Pixel

    rebuffering_seconds fakultativ Schnur

    Die Anzahl der Sekunden, die der Benutzer darauf gewartet hat, dass das Video aufgrund der nicht angeforderten Verzögerung während der Interaktionsperiode wiedergegeben wird

    rebuffering_count fakultativ Schnur

    Die Häufigkeit, mit der die Wiedergabe aufgrund der erneuten Pufferung während der Verzögerung der dargestellten Eingriffsperiode während der Eingriffsperiode angehalten wurde

    forward_buffer_seconds fakultativ Schnur

    Die Anzahl der Video-Sekunden, die derzeit im Forward-Puffer gespeichert sind

    measured_bps fakultativ Schnur

    Das Verhältnis der Anzahl von Bits, die in dem zuletzt heruntergeladenen Segment enthalten sind, zu der Zeit, die das Herunterladen dieses Segments in Bits pro Sekunde kostet

    player_width fakultativ Schnur

    Die aktuelle Pixelbreite des player am Ende des Eingriffsbereichs

    player_height fakultativ Schnur

    Die aktuelle Pixelhöhe des player am Ende des Eingriffsbereichs

    dropped_frames fakultativ Schnur

    dropped_frames

    video_duration fakultativ Nummer

    Die Dauer des Videos in Sekunden

    video_seconds_viewed fakultativ Nummer

    Anzahl der beobachteten Sekunden seit dem letzten Update für video_engagement Ereignisse ein

    Das video_engagement Ereignis ist ein Mittel zum Verfolgen des Video-Engagements während der Wiedergabe eines Videos und wird während der Wiedergabe wahrscheinlich viele Male gesendet. (Der Flash / HTML5 player Die Instrumentierung sendet dieses Ereignis alle 10 Sekunden, wenn die Wiedergabe nicht unterbrochen wird.) Derzeit werden Ereignisse, die Bereiche über 20-Sekunden hinweg beschreiben, vom Analytics-System verworfen. Daher müssen diese Ereignisse häufiger gesendet werden.

    Es gibt zwei Formen, die a video_engagement Event kann dauern (andere Parameter werden aus Platzgründen weggelassen):

    Beispiel Bedeutung
      event=video_engagement&video=123&video_duration=75&range=0..9
      
      
    Video 123 mit einer Dauer von 75 Sekunden gespielt Sekunden 0 bis 9 (für insgesamt 10 Sekunden angezeigt).
    event=video_engagement&video=123&video_seconds_viewed=10 10 Sekunden Video 123 wie haben überprüft.

    Während beide Versionen gesehenen Sekunden verfolgen, enthält die Version, die enthält video_duration und range enthält auch Informationen, die notwendig sind, um zusätzliche Engagementdaten zu berechnen, und ist der bevorzugte Weg und senden video_engagement Ereignisdaten an das Analytics-System. Für Livestreams oder in Fällen, in denen sich die Zeitleiste des Videos während der Wiedergabe ständig ändert oder auf andere Weise unzuverlässig ist. video_seconds_viewed werden die einzigen verfügbaren Daten sein. Für VOD, sofern nicht duration ist nicht verfügbar, die video_engagement Veranstaltung sollte enthalten video_duration und range.

    Parameter Abgeleitete Interaktionsmetriken (API)
    video_duration, range video_seconds_viewed, video_percent_viewed, engagement_score; Daten der Eingriffskurve
    video_seconds_viewed video_seconds_viewed

    Wenn alle drei Parameter ( video_duration, range und video_seconds_viewed) werden zusammen mit einem geschickt video_engagement Ereignis wird das Analytics-System die Interaktionsmetriken von video_duration+ range Parameter.

    V2 Änderungen

    Dieser Abschnitt enthält eine Zusammenfassung der Änderungen von v1 an v2 des Datenkollektors für Benutzer, die v1 verwendet haben.

    Basis-URL für Tracker

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

    Zusätzliche Felder, die für alle Ereignisse unterstützt werden:

    device_os_version: Die Version von os, die vom Gerät verwendet wird. Wenn nicht angegeben, wird dies berechnet, indem die User-Agent-Zeichenfolge für die Verfolgungsanforderung analysiert wird.

    Plattformversion: Wird verwendet, um anzuzeigen, dass eine neue Version der angegebenen Plattform zum Senden der Ereignisse verwendet wird.

    Neue Ereignisse für V2

    Kataloganfrage: Wird gesendet, wenn eine Anforderung an die Videocloud-Katalog-API gestellt wird. Beachten Sie, dass dieses Ereignis für den internen Gebrauch bestimmt ist und nicht im Analytics-Modul oder über das bereitgestellt wird Analytics API.

    • Katalog_url: Die mit dem Ziel verknüpfte Ziel-URL catalog_request Ereignis - Beachten Sie, dass dieses Ereignis für den internen Gebrauch bestimmt ist und nicht im Analytics-Modul oder über das bereitgestellt wird Analytics API..

    Katalogantwort: Wird gesendet, wenn eine Antwort auf einen Prior vorliegt catalog_request empfangen wird - Beachten Sie, dass dieses Ereignis für den internen Gebrauch bestimmt ist und nicht im Analytics-Modul oder über das verfügbar gemacht wird Analytics API.

    • Katalog_url: Die mit dem Ziel verknüpfte Ziel-URL catalog_request Ereignis, das diese Antwort ausgelöst hat - Beachten Sie, dass dieses Ereignis für die interne Verwendung und nicht im Analytics-Modul oder über das verfügbar gemacht wird Analytics API..
    • Antwortzeit_ms: Die Zeit in Millisekunden zwischen der catalog_request Ereignis und die catalog_response Ereignis - Beachten Sie, dass dieses Ereignis für den internen Gebrauch bestimmt ist und nicht im Analytics-Modul oder über das bereitgestellt wird Analytics API..

    Spielanfrage: Wird gesendet, wenn die Wiedergabe entweder vom Benutzer ausgelöst wird, der ausdrücklich auf die Wiedergabetaste klickt, oder automatisch, wenn die Plattform die Wiedergabe in einem Szenario mit automatischer Wiedergabe auslöst.

    ad_mode_begin: [Ersetzt ad_start] Wird gesendet, wenn die Kontrolle von der Wiedergabeplattform an einen Werbeagenten übergeben wird.

    ad_mode_complete: [Ersetzt ad_end] Wird gesendet, wenn die Kontrolle vom Werbeagenten an die Wiedergabeplattform zurückgegeben wird.

    Fehler: Wird gesendet, wenn schwerwiegende Fehler auftreten, die die Wiedergabeerfahrung stören.

    • Fehlercode: Ein plattformspezifischer Fehlercode, der dem Ereignis zugeordnet ist.

    Aktualisierte Ereignisse für V2

    Videoansicht: Beinhaltet neue Latenzmessungen

    • load_time_ms: Die Zeit in Millisekunden zwischen dem Beginn der Dateneingabe für das Video und der Wiedergabe des Videos.
    • start_time_ms: Die Zeit in Millisekunden zwischen dem Beginn der Wiedergabe und dem ersten Bild des gerenderten Videos. Dies kann je nach Erfahrung unterschiedlich sein. Wenn beispielsweise keine Pre-Roll-Anzeigen konfiguriert sind, ist diese Messung die Zeit zwischen 'play_request' und ' video_view Veranstaltungen. Wenn es eine Preroll-Anzeige gibt, ist die Zeit zwischen ad_mode_begin und ad_mode_complete sollte nicht enthalten sein.

    Video_Engagement: Enthält zusätzliche Wiedergabeauswahl, Bitratenmessungen und Pufferinformationen. Eine subtile Änderung bei der Videointeraktion wurde auch dahingehend vorgenommen, dass sie regelmäßig gesendet werden sollte, auch wenn während des Engagementzeitraums keine Anzeige erfolgte. Diese Änderung ermöglicht die Verfolgung von Verzögerungen und Zählungen bei der erneuten Pufferung, die dazu führen, dass Benutzer auf die Wiedergabe warten.

    • Angebot: Der Bereichsparameter ist jetzt optional, Bereich kann aus einem Engagement-Ereignis herausgelassen werden, um zu zeigen, dass während des vom Ereignis abgedeckten Zeitraums keine Anzeigeaktivitäten stattfanden. (Wenn beispielsweise nur eine erneute Pufferung stattfindet)
    • rendition_url: Die URL zur zuletzt ausgewählten Wiedergabe. Bei einem HLS-Stream wäre dies beispielsweise die URL der zuletzt ausgewählten Variante.
    • rendition_indicated_bps: Die angegebene Bitrate in Bits pro Sekunde der zuletzt ausgewählten Wiedergabe.
    • rendition_mime_type: Der Mime-Typ der zuletzt ausgewählten Wiedergabe.
    • rendition_height: Die kodierte Höhe der Videowiedergabe in Pixeln
    • rendition_width: Die codierte Breite der Videowiedergabe in Pixeln
    • rebuffering_seconds: Die Anzahl der Sekunden, die der Benutzer darauf gewartet hat, dass das Video aufgrund der nicht angeforderten Verzögerung während des Einrückzeitraums wiedergegeben wird.
    • rebuffering_count: Die Häufigkeit, mit der die Wiedergabe aufgrund der erneuten Pufferung während des dargestellten Einrückzeitraums angehalten wurde.
    • forward_buffer_seconds: Die Anzahl der Sekunden des Videos, das sich derzeit im Vorwärtspuffer befindet.
    • gemessene_bps: Das Verhältnis der Anzahl der Bits, die in dem zuletzt heruntergeladenen Segment enthalten sind, zu der Zeit, die das Herunterladen dieses Segments in Bits pro Sekunde kostet.
    • player_Breite Die aktuelle Pixelbreite des player am Ende des Eingriffsbereichs.
    • player_Höhe Die aktuelle Pixelhöhe des player am Ende des Eingriffsbereichs.
    • dropped_frames: Die Anzahl der Frames, die während der Interaktionsperiode von der Videowiedergabe entfernt wurden

    Seite zuletzt aktualisiert am 28