Migration von der Analytics REST API auf Brightcove Analytics API

Einführung

Die Video Cloud Analytics API ist der Ooyala Analytics REST-API ziemlich ähnlich.

Beachten Sie auch, dass das Analytics-Modul in Video Cloud Studio eine robuste Version enthält Benutzerdefinierter Berichts-Generator Dies kann in vielen Fällen dazu führen, dass die API überhaupt nicht verwendet werden muss.

Die folgenden Abschnitte entsprechen den verschiedenen Aspekten der beiden APIs:

Die Authentifizierung
Berichte
Parameter
Maße
Filter
Metriken

Authentifizierung

Die Authentifizierung von Brightcove-API-Anforderungen wird geringfügig anders behandelt als die der Ooyala-REST-APIs. Sehen Authentifizierung für Brightcove-API-Anforderungen für Details.

Berichte

Der Single /reports Der Endpunkt für die Ooyala Analytics REST-API entspricht sehr genau der Brightcove Analytics API /data Endpunkt. Der Hauptunterschied besteht darin, dass die Ooyala-API beides zulässt GET und POST Letzteres wurde verwendet, um einige Daten im Anforderungshauptteil anstelle von URL-Parametern zu übergeben, wodurch einige längere Datenzeichenfolgen ermöglicht wurden.

Parameter

Die Parameter für Anforderungen sind für die beiden APIs ähnlich. Sie sind in der folgenden Tabelle aufgeführt, um Ihnen zu zeigen, wo die Unterschiede liegen.

Parameter
Ooyala-Parameter	Brightcove-Parameter	Dokumente
kein	`accounts`- als Parameter für alle Berichte auf mehreren Konten enthalten	Überblick über Dimensionen, Felder und Parameter
`report_type`	Keine, aber die Brightcove-API bietet einige zusätzliche Endpunkte für Engagement- und Live-Analyseberichte	Übersicht: Analytics-API
`start_date`	`from` Die beiden Parameter sind ähnlich und beide akzeptieren Werte im Formular `YYYY-MM-DD` ;; Der Brightcove-Parameter akzeptiert auch Epochendaten in Millisekunden und relative Daten wie z `-3d`	Überblick über Dimensionen, Felder und Parameter
`end_date`	`to` Die beiden Parameter sind ähnlich und beide akzeptieren Werte im Formular `YYYY-MM-DD` ;; Der Brightcove-Parameter akzeptiert auch Epochendaten in Millisekunden und relative Daten wie z `-3d`	Überblick über Dimensionen, Felder und Parameter
`metrics`	`fields`- Die beiden Parameter sind im Wesentlichen identisch. Die Brighcove-API verwendet ebenfalls `metrics` für Live Analytics-Anfragen; sehen Metriken Informationen dazu, welche Metriken verfügbar sind	Überblick über Dimensionen, Felder und Parameter
`dimensions`	`dimensions`- Die beiden Parameter sind im Wesentlichen identisch. Die Brighcove-API verwendet ebenfalls `metrics` für Live Analytics-Anfragen; sehen Maße Informationen dazu, welche Abmessungen verfügbar sind	Überblick über Dimensionen, Felder und Parameter
`filters`	`where`- Abgesehen vom Namen sind die beiden Parameter im Wesentlichen identisch. sehen Filter unten für weitere Informationen	Überblick über Dimensionen, Felder und Parameter
`time_segment`	keine - die Brightcove-API hat `date` und `date_hour` Dimensionen, die eine ähnliche Zeitsegmentierung bieten, sowie Engagement-Endpunkte für Zeiträume innerhalb der letzten 32 Tage, die Ansichten über jeden 100. Teil des Videos liefern	Überblick über Dimensionen, Felder und Parameter
`sort`	`sort` Die Parameter sind identisch, außer dass die Ooyala-API das Sortieren nach mehreren Metriken ermöglicht	Überblick über Dimensionen, Felder und Parameter
`limit`	`limit`- Die Parameter sind bis auf das 1000-Limit des Ooyala-API-Parameters identisch	Überblick über Dimensionen, Felder und Parameter
`page`	`offset`- Die Parameter nehmen unterschiedliche Werte an, funktionieren jedoch beim Paging von Datensätzen ähnlich	Überblick über Dimensionen, Felder und Parameter
kein	`reconciled`- Da Analysedaten aus unterschiedlichen Quellen nach unterschiedlichen Zeitplänen stammen, speichert die Brightcove-API aktuelle Analysedaten in einem "nicht abgestimmten" Bucket, während sie noch aktualisiert werden, und überträgt sie in einen "historischen" Bucket. Mit dem Parameter können Sie zwischen diesen Buckets wählen	Überblick über Dimensionen, Felder und Parameter
kein	`bucket_limit`- gilt nur für Live Analytics-Anfragen; zusammen mit `bucket_duration` Diese funktionieren ähnlich wie die Ooyala-API `time_segment` param	Überblick über Dimensionen, Felder und Parameter
kein	`bucket_duration`	Überblick über Dimensionen, Felder und Parameter

Abmessungen:

Die APIs Ooyala und Brightcove Analytics gruppieren Daten in Buckets, die als "Dimensionen" bezeichnet werden. Sie werden auf ähnliche Weise verwendet, aber die APIs haben etwas andere Regeln, wie mehrere Dimensionen kombiniert werden können, und Brightcove verfügt über einen breiteren Satz von Dimensionen. Sehen Unterstützte Maßkombinationen Einzelheiten zur Brightcove-API. Die folgende Tabelle bietet einen detaillierten Vergleich.

Abmessungen:
Ooyala Dimension	Brightcove-Dimension	Dokumente
`asset`	`video`- die helle Bucht `video` Dimension umfasst nur VOD-Assets; da ist auch ein `live_stream` Abmessungen	Videodimension
`country`	`country`- Abmessungen sind im Wesentlichen identisch	Länderdimension
`region`	`region`- Die Abmessungen sind im Wesentlichen identisch, mit der Ausnahme, dass die Brightcove-Abmessung US-Bundesstaaten umfasst	Dimension Region
`dma`	kein	nicht zutreffend
`state`	`region`- Die Brightcove-API enthält US-Bundesstaaten in der `region` Abmessungen	Dimension Region
`device_type`	`device_type`- Abmessungen sind im Wesentlichen identisch	Gerätetyp Dimension
`domain`	`destination_domain`	Dimension Zieldomäne
`url`	`device_os`- im Wesentlichen das gleiche	Dimension des Gerätebetriebssystems
`os`	`destination_domain`- nicht genau das gleiche, aber das nächste Äquivalent	Dimension Zieldomäne
`pcode`	`account`	Kontodimension
`player_id`	`player`	Spielerdimension
kein	`browser_type`	Browsertyp Dimension
kein	`date`	Datumsdimension
kein	`date_hour`	Datum-Stunde-Dimension
kein	`device_manufacturer`	Gerätehersteller Dimension
kein	`referrer_domain`	Referrer Domain Dimension
kein	`search_terms`	Dimension der Suchbegriffe
kein	`social_platform`	Dimension der sozialen Plattform
kein	`source_type`	Quelltyp Dimension

Filter

Filter funktionieren in den beiden APIs ziemlich identisch.

      
        // Ooyala
        filter={dimension1}=={value1};{dimension2}=={value2}
      
        // Brightcove
        where={dimension1}=={value1};{dimension2}=={value2}

Kennzahlen

Das metrics (für die Brightcove-API: fields ), die in Berichten zurückgegeben werden, variieren je nach den für die Brightcove Analytics-API angeforderten Dimensionen. Sie können das in eingebettete Tool verwenden Abmessungen und Felder um zu sehen, welche Felder für eine bestimmte Dimension oder eine Kombination von Dimensionen zurückgegeben werden können.

Beachten Sie, dass die Ooyala-API zwar alle Metriken zurückgibt, wenn keine angegeben sind, die Brightcove-API jedoch nur einen kleinen Satz von Standardmetriken zurückgibt, die je nach Dimension (Kombination) variieren, sofern Sie nicht die angeben fields in der Anfrage.

Brightcove-Felder enthalten Entsprechungen für alle Ooyala-Metriken mit Ausnahme von:

uniq_plays_requested
uniq_displays
uniq_video_starts

Die helle Bucht Analytics API kann auch die Anzahl anderer Metriken zurückgeben, die in Ooyala Analytics nicht verfügbar sind.