Dimension: Betrachter

Einleitung

Die viewer Dimension ermöglicht es Ihnen, Analysen nach Viewern zu betrachten. Wenn keine Betrachter-IDs vom Player an den Analysedatensammler gesendet werden, versuchen wir, eine Betrachter-ID aus der IP-Adresse und dem User-Agent des Betrachters zu konstruieren - diese Methode ist jedoch fehleranfällig. Zuschaueranalysen sind am nützlichsten, wenn Sie eingeloggte Zuschauer haben und diese somit zuverlässig identifizieren können.

URL-Parameter

Analytics-API-Berichte unterstützen die folgenden URL-Parameter.

URL-Parameter
Parameter	Beschreibung	Erforderlich	Werte	Standardwert
`account`	Die Konten, über die Sie berichten möchten	Ja	eine oder mehrere Konto-IDs als durch Kommas getrennte Liste	keiner
`dimensions`	Die Dimension(en), über die berichtet werden soll	Ja	eine oder mehrere Dimensionen als kommagetrennte Liste (einige Kombinationen sind nicht gültig - verwenden Sie das interaktive Tool hier, um festzustellen, ob eine Kombination gültig ist)	keiner
`where`	Wird verwendet, um Filter für Berichte anzugeben	nein	{Dimension}=={Wert} - eine oder mehrere als durch Semikolon getrennte Liste. Der Wert ist ein oder mehrere Werte für die primäre Metrik der betreffenden Dimension. Zum Beispiel: `video==video_id`, `country=country-code`, oder `viewer=viewer_id`(im letzten Fall variiert die Form der viewer_id, je nachdem, ob Sie selbst eine Art von Viewer_ID erfassen und senden, oder abhängig von dem vom Analysesystem generierten Wert).	keiner
`limit`	Anzahl der zurückzugebenden Artikel	nein	positive ganze Zahl	10
`offset`	Anzahl der zu überspringenden Elemente	nein	positive ganze Zahl	0
`sort`	Feld zum Sortieren von Elementen	nein	jedes Feld, das von der Anfrage zurückgegeben wird	video_view
`fields`	Felder zum Zurückgeben	nein	variiert je nach Dimension, über die Sie berichten	Video, Videoansicht
`format`	Format, um Ergebnisse in zurückzugeben	nein	json (Standard) \| csv \| xlxs	json
`reconciled`	Falls vorhanden, werden die Ergebnisse auf historische oder Echtzeitdaten beschränkt. Analysedaten stammen aus mehreren Quellen: Einige werden vom Player gesendet, andere werden von CDNs und dem Video Cloud-System gesammelt. Um Analysen so schnell wie möglich bereitzustellen, beginnen wir mit der Bereitstellung von "Echtzeit"-Daten, sobald diese verfügbar sind, und passen die Analysen später an, wenn Daten aus allen Quellen gesammelt und verarbeitet wurden. Die vollständig verarbeiteten Daten werden als abgestimmte	nein	wahr \| falsch	wahr
`from`	Der Anfang des Datumsbereichs für die Anfrage	nein	Einer der folgenden: Ein ISO 8601-Datum (JJJJ-MM-TT) Epochenzeit in Millisekunden (Beispiel: 1659641316719 [= Donnerstag, 4. August 2022, 19:28:36 .719 Uhr GMT]). Siehe den Epoch-Zeitkonverter. Eine Zeichenfolge: `from=alltime` +/- relative Daten in Tagen (d), Wochen (w) oder Monaten (m) — Beispiel: `from=-6m&to=%2B2w`(der Zeitraum von vor 6 Monaten bis 2 Wochen danach — beachten Sie, dass das Pluszeichen URI-kodiert sein muss als `%2B`) Für Engagement-Endpunkte sind nur Daten innerhalb der letzten 32 Tage zulässig oder wenn reconciled=false.	-30d
`to`	Das Ende des Zeitraums für die Anfrage	nein	Einer der folgenden: Ein ISO 8601-Datum (JJJJ-MM-TT) Epochenzeit in Millisekunden (Beispiel: 1659641316719 [= Donnerstag, 4. August 2022, 19:28:36 .719 Uhr GMT]). Siehe den Epoch-Zeitkonverter. Eine Zeichenfolge: `to=now` +/- relative Daten in Tagen (d), Wochen (w) oder Monaten (m) — Beispiel: `from=-6m&to=%2B2w`(der Zeitraum von vor 6 Monaten bis 2 Wochen danach — beachten Sie, dass das Pluszeichen URI-kodiert sein muss als `%2B`) Für Engagement-Endpunkte sind nur Daten innerhalb der letzten 32 Tage zulässig oder wenn reconciled=false.	jetzt

Verfügbare Felder

Die folgenden Felder können für die Dimension zurückgegeben werden.

application- die ID des virtuellen Veranstaltungserlebnisses. Wenn nicht übergeben, ist es null
engagement_score- Engagement-Score
video_engagement_1- Video-Engagement bei 1% der Dauer
video_engagement_25- Videointeraktion bei 25% der Dauer
video_engagement_50- Video-Engagement bei 50% der Dauer
video_engagement_75- Video-Engagement bei 75% der Dauer
video_engagement_100- Video-Engagement bei 100% der Dauer
time- die Epochenzeit des letzten eingegangenen Ereignisses
video_view- die Häufigkeit, mit der die Wiedergabe des Zuschauers begonnen hat
viewer^[1]- Ereignisanzeige (SSO-ID oder Geräte-ID oder eindeutiger String basierend auf User-Agent und IP)

Zusätzliche Felder sind verfügbar, wenn die Abfrage auch die entsprechende(n) Dimension(en) enthält:

city- die Stadt, in der sich der Betrachter befand (erfordert die city Dimension)
country- das Land (Code), in dem sich der Betrachter befand (erfordert die country Dimension)
country_name- der Ländername, in dem sich der Zuschauer befand (erfordert die country Dimension)
region- die Region (Code), in der sich der Betrachter befand (erfordert die region Dimension)
region_name- der Name der Region, in der sich der Betrachter befand (erfordert die region Dimension)
rebuffering_seconds- die Gesamtzeit, die die Spieler mit Rebuffern verbracht haben (erfordert, dass der country oder enthalten region ist)
device_type- der Gerätetyp, den der Betrachter verwendet hat (erfordert die device_type Dimension)

Senden der Betrachter-ID

Um eine Betrachter-ID an das Analysesystem zu senden, müssen Sie die Logik erstellen, um eine eindeutige ID zu konstruieren, die den Betrachter zur Laufzeit identifiziert, und diese dann vom Player an den Analysedatensammler senden. Der Brightcove-Webplayer und die iOS- und Android-SDK-Player können die Benutzer-ID an die Analysefunktion senden. In den folgenden Abschnitten erfahren Sie, wie Sie dies für den Web- und SDK-Player tun können.

Betrachter-ID senden - Brightcove-Player

Zunächst müssen Sie die Benutzer-ID festlegen, um ihre Anzeigeaktivität zu speichern.

Brightcove Spieler

Wenn Sie Brightcove Player verwenden, gehen Sie folgendermaßen vor:

Obwohl Viewer-Daten automatisch an Brightcove Analytics gesendet werden, müssen Sie die Benutzer-ID festlegen. Verwenden Sie dazu die setUser() Methode. Zum Beispiel:
```
myPlayer.bcAnalytics.client.setUser('viewer id');
```
Auf Ihren Websites, auf denen Brightcove Player gehostet wird, können Sie ein Authentifizierungsgateway oder eine Identitätsverwaltungslösung verwenden, um den Überblick über die Betrachter zu behalten. Verwenden Sie diese Viewer-ID als Viewer-ID, um sie an Brightcove Analytics zu übergeben.

Der Wert der Betrachter-ID muss eine eindeutige Zeichenfolge sein. Ein ungültiger Wert, z. B. eine Zahl, wird ignoriert.

Es ist wichtig, die Viewer-ID festzulegen, bevor eine Quelle auf dem Player festgelegt wird. Es sollte sofort nach der Initialisierung des Players aufgerufen werden.

<video-js
  id="myPlayerID"
  data-account="1752604059001"
  data-player="hyQW6GByl"
  data-embed="default"
  controls=""
  data-video-id="6156696074001"
  data-playlist-id=""
  data-application-id=""
  width="640" height="360"></video-js>
<script src="https://players.brightcove.net/1752604059001/hyQW6GByl_default/index.min.js"></script>

<script>
  videojs.getPlayer('myPlayerID').ready(function() {
    var myPlayer = this;

    // Set the viewer id for Brightcove analytics
    myPlayer.bcAnalytics.client.setUser('viewer id');
  });
</script>

Wenn der setUser() Methode verwendet wird, wird der Wert nicht gehasht und wird mit allen nachfolgenden Beacons im Klartext gesendet.
Notiere dass der player_init Veranstaltung wird die nicht enthalten user Feld in diesem Fall, aber alle video_* Ereignisse sollten es enthalten.

Benutzerdefinierter Webplayer

Wenn Sie eine benutzerdefinierte Implementierung erstellen, die Brightcove Player nicht verwendet, fügen Sie die hinzu user Parameter für Ihre Datenerfassungs-API-Anforderungen. Einzelheiten finden Sie im Überblick: Datenerfassungs-API v2 Dokument.

Auf Ihren Websites, auf denen sich Ihr Player befindet, können Sie ein Authentifizierungsgateway oder eine Identitätsverwaltungslösung verwenden, um den Überblick über die Betrachter zu behalten. Verwenden Sie diese Viewer-ID als Viewer-ID, um sie an Brightcove Analytics zu übergeben.

Für die nativen SDK-Player von Brightcove müssen Sie ebenfalls eine Betrachter-ID senden, sofern Sie nicht auf die von Brightcove generierte ID angewiesen sind.

Android

Für den Android-Player fügen Sie diesen Code hinzu:

HashMap<String, String> baseParams = new HashMap<>();
  baseParams.put(Analytics.Fields.USER, "viewer id");
  baseParams.put(Analytics.Fields.APPLICATION_ID, "application id");
  
  HashMap<String, Object> eventParams = new HashMap<>();
  eventParams.put(Analytics.Fields.BASE_PARAMS, baseParams);
  eventEmitter.emit(EventType.ADD_ANALYTICS_BASE_PARAMS, eventParams);

iOS

Für iOS oder tvOS fügen Sie den folgenden Code hinzu:

@try
  {
    [BCOVGlobalConfiguration.sharedConfig setValue:@{
      @"privateUser": self.viewer id,
      @"privateApplication": @"application id"
    }
    forKey:@"privateSessionAnalytics"];
  }
  @catch (NSException *e)
  {
    NSLog(@"%@", e.description);
  }

Filterwerte

Eine Dimension, die als Filter verwendet wird, ermöglicht es Ihnen, die Ergebnisse einzugrenzen.

Filterwerte: Betrachter-IDs

Dimensionen kombinieren

Die viewer Dimension kann mit mehreren anderen kombiniert werden, die zusätzliche Felder hinzufügen, die abgerufen werden können. Die Details finden Sie in der Tabelle unten. (Fett gedruckt Elemente sind standardmäßig in der Antwort enthalten, wenn die Dimension enthalten ist.)

Unterstützte Dimensionskombinationen
Abmessungen	Weitere Felder
`video`	`video` `video_engagement_1` `video_engagement_25` `video_engagement_50` `video_engagement_75` `video_engagement_100` `video_percent_viewed` `video_seconds_viewed` `video_view` `video.tags` `video.reference_id` `video.name` `video.description` `video.long_description` `video.duration`
`country`	`country` `country_name`
`region`	`region` `region_name`
`city`	`city` `dma`
`device_type`	`device_type`

Beispiele anfordern

Muster für Abmessungsanfrage

    https://analytics.api.brightcove.com/v1/data?accounts=3365624256001&dimensions=viewer&limit=10&fields=viewer,time,video_view,engagement_score

Beispielantwort

{
  "item_count": 8,
  "items": [
    {
      "engagement_score": null,
      "viewer": "6798840584846290049",
      "time": 1623870475157,
      "video_view": 0
    },
    {
      "engagement_score": 100,
      "viewer": "-1094565064376617663",
      "time": 1623870472882,
      "video_view": 1
    },
    {
      "engagement_score": 100,
      "viewer": "8997125557862445199",
      "time": 1623870433989,
      "video_view": 1
    },
    {
      "engagement_score": 39.13,
      "viewer": "-8839675754655082792",
      "time": 1623872904633,
      "video_view": 1
    },
    {
      "engagement_score": 143.48,
      "viewer": "-6771654281667224776",
      "time": 1623869869930,
      "video_view": 2
    }
  ],
  "summary": {
    "engagement_score": 110.51,
    "time": 1623875119506,
    "video_view": 12
  }
}

Beispiel für eine mehrdimensionale Anfrage

    https://analytics.api.brightcove.com/v1/data?accounts=3365624256001&dimensions=viewer,country,region,city,video,device_type&limit=10&fields=viewer,time,video_view,engagement_score,video_percent_viewed,video_seconds_viewed,video_engagement_1,video_engagement_25,video_engagement_50,video_engagement_75,video_engagement_100,video.tags,video.reference_id,video.name,video.description,video.duration,video.long_description,dma,country_name,region_name