Analytics RESTAPIからBrightcoveAnalyticsAPIへの移行
はじめに
ビデオクラウド分析 APIは、Ooyala アナリティクス REST API と非常によく似ています。
また、Video Cloud Studio の分析モジュールには堅牢なカスタムレポートビルダーが含まれているため、多くの場合、API をまったく使用する必要がない場合があります。
以下のセクションは、2 つの API のさまざまな側面に対応しています。
[認証]
ブライトコーブ API リクエストの認証は、Ooyala REST API の場合とは少し異なります。詳細については、ブライトコーブ API リクエストの認証を参照してください。
レポート
Ooyala アナリティクス REST API /reports
の単一のエンドポイントは、ブライトコーブアナリティクス API に非常に密接に対応しています。/data
エンドポイント。主な違いは、Ooyala GET
APIはとの両方を許可しPOST
、後者はURLパラメータではなくリクエスト本文にいくつかのデータを渡すために使用されていることです。長いデータ文字列を許可します。
パラメータ
リクエストのパラメーターは、2 つの API でも同様です。相違点がどこにあるかを示すために、以下の表で詳しく説明しています。
ウーヤラパラメータ | ブライトコーブのパラメータ | ドキュメント |
---|---|---|
無し | accounts -複数のアカウントのすべてのレポートにパラメータとして含まれる |
ディメンション、フィールド、およびパラメータの概要 |
report_type |
なし。ただし、ブライトコーブ API には、エンゲージメントレポートとライブ分析レポート用のエンドポイントがいくつか追加されています | 概要:アナリティクス API |
start_date |
from 2 つのパラメータは似ており、どちらも次の形式の値を受け入れます。 YYYY-MM-DD; Brightcoveパラメータは、ミリ秒単位のエポック日付と次のような相対日付も受け入れます。 -3d |
ディメンション、フィールド、パラメータの概要 |
end_date |
to 2 つのパラメータは似ており、どちらも次の形式の値を受け入れます。 YYYY-MM-DD; Brightcoveパラメータは、ミリ秒単位のエポック日付と次のような相対日付も受け入れます。 -3d |
ディメンション、フィールド、パラメータの概要 |
metrics |
fields -2 つのパラメータは本質的に同じです。Brighcove API metrics はライブ分析リクエストにも使用します。使用可能なメトリックスの詳細については、メトリック |
ディメンション、フィールド、およびパラメータの概要 |
dimensions |
dimensions -2 つのパラメータは本質的に同じです。Brighcove API metrics はライブ分析リクエストにも使用します。使用できるディメンションについては、ディメンション |
ディメンション、フィールド、およびパラメータの概要 |
filters |
where -名前とは別に、2 つのパラメータは本質的に同一です。詳細については、以下のフィルタを参照してください。 |
ディメンション、フィールド、およびパラメータの概要 |
time_segment |
なし-ブライトコーブ API には、date date_hour 同様の時間セグメント化を提供するディメンションと、期間のエンゲージメントエンドポイントがあります。過去 32 日以内に、ビデオの 100 番目の各部分の視聴回数が表示される |
ディメンション、フィールド、およびパラメータの概要 |
sort |
sort パラメータは同じですが、Ooyala API が複数の指標でソートできる点が異なります。 |
ディメンション、フィールド、およびパラメータの概要 |
limit |
limit -Ooyala API パラメーターの 1000 の制限を除いて、パラメーターは同じです。 |
ディメンション、フィールド、およびパラメータの概要 |
page |
offset -params は異なる値を取るが、データセットのページングでも同様に機能する |
ディメンション、フィールド、およびパラメータの概要 |
無し | reconciled -分析データは異なるスケジュールの異なるソースから得られるため、ブライトコーブ API は最新の分析データを「調整されていない」バケットにまだ更新されている間に配置し、歴史」バケット。パラメータを使用すると、これらのバケットを選択できます。 |
ディメンション、フィールド、およびパラメータの概要 |
無し | bucket_limit -ライブアナリティクスのリクエストにのみ適用されます。これらを組み合わせてbucket_duration 、Ooyala API と多少似た方法で機能します。time_segment パラメーター |
ディメンション、フィールド、およびパラメータの概要 |
無し | bucket_duration |
ディメンション、フィールド、およびパラメータの概要 |
[寸法]
Ooyala および Brightcove Analytics API はいずれも、データを「ディメンション」と呼ばれるバケットにグループ化しています。これらは同様の方法で使用されますが、API には複数のディメンションを組み合わせる方法に関するルールが多少異なります。ブライトコーブには、より広範なディメンションセットがあります。見るサポートされている寸法の組み合わせ BrightcoveAPIの詳細については。以下の表に、詳細な比較を示します。
ウーヤラ次元 | ブライトコーブディメンション | ドキュメント |
---|---|---|
asset |
video - video ブライトコーブのディメンションは VOD アセットのみを対象としています。live_stream 次元 |
ビデオディメンション |
country |
country -寸法は本質的に同一である |
国次元 |
region |
region -ブライトコーブの次元が米国の州を含むことを除いて、寸法は本質的に同一である |
リージョンディメンション |
dma |
無し | なし |
state |
region -ブライトコーブ API には、region ディメンションに米国の州が含まれています |
リージョンディメンション |
device_type |
device_type -寸法は本質的に同一である |
デバイスタイプの寸法 |
domain |
destination_domain |
デスティネーションドメインディメンション |
url |
device_os -本質的に同じ |
デバイス OS の寸法 |
os |
destination_domain -まったく同じではありませんが、最も近い同等物 |
デスティネーションドメインディメンション |
pcode |
account |
勘定ディメンション |
player_id |
player |
プレイヤーディメンション |
無し | browser_type |
ブラウザータイプのディメンション |
無し | date |
日付ディメンション |
無し | date_hour |
日付/時間ディメンション |
無し | device_manufacturer |
デバイス製造元の寸法 |
無し | referrer_domain |
リファラードメインディメンション |
無し | search_terms |
検索用語のディメンション |
無し | social_platform |
ソーシャル・プラットフォーム・ディメンション |
無し | source_type |
ソースタイプディメンション |
[フィルタ]
フィルターは、次の 2 つの API でほぼ同じように機能します。
// Ooyala
filter={dimension1}=={value1};{dimension2}=={value2}
// Brightcove
where={dimension1}=={value1};{dimension2}=={value2}
メトリックス
レポートで返されるmetrics
(ブライトコーブ API の場合: fields
) は、ブライトコーブ Analytics API で要求されたディメンションによって異なります。ディメンションとフィールドに埋め込まれたツール。特定のディメンションまたはディメンションの組み合わせに対して返すことができるフィールドを確認します。
Ooyala API は、何も指定されていない場合はすべてのメトリクスを返しますが、Brightcove API は、リクエストに含めない限り、ディメンション(組み合わせ)によって異なる少数のデフォルトメトリックセットのみを返します。fields
ブライトコーブの項目には、以下を除くすべての Ooyala メトリックスと同等の項目が含まれます。
uniq_plays_requested
uniq_displays
uniq_video_starts
Brightcove Analytics APIは、Ooyala アナリティクスでは利用できないその他の指標の数を返すこともできます。