ビデオレポートAPI - 統合

導入

Video Reporting API を使用して、Video ConsoleUI から利用可能なすべてのデータを引き出すことができます。

以下のエンドポイントに問い合わせることで、Browsi Videoのアクティビティに対するレポートプロセスを自動化することができます。

認証

API経由でレポートにアクセスするには、以下のものが必要です。

Endpoint - https://video-console-server.browsiprod.com/api/v1/oauth/token

METHOD: POST

{
    "username": "<EMAIL>",
    "password": "<PASSWORD>"
}

RESPONSE:

{
    "access_token": "<TOKEN>",
    "expires_in": 86400,
    "token_type": "Bearer"
}

このようにして提供されたトークンは、APIへの他のリクエストに、header 'authorization'の一部として、以下の値を伴って追加される必要があります： "Bearer <TOKEN>".

レポートの作成

このエンドポイントを呼び出してレポートを作成し、Browsi Videoのデータを取得することができます。

https://video-console-server.browsiprod.com/api/v1/reports

Method: POST
Body:

{
  "dimensions":{
    "Time":["date"]
  },
  "metrics":{
    "Revenue":["net_revenue"]
  }
  "limit":100,
  "type":"csv"| "json",
  "timeRange":{
    "startDate":"2022-05-22",
    "endDate":"2022-05-23"
 },
  "filters":{
    "os":["linux"]
  },
  "timezone": "Etc/GMT-7"--- place names also supported, e.g. "America/Chicago"
}

Notes:

行数を無制限に取得するには、"limit":-1 を使用してください。それ以外の場合、デフォルト値は5000行です。
以下のパラメータは必須です：
1. timeRange - 以下いずれかの形式で指定ください。
  1. 開始日と終了日：フォーマットは yyyy-mm-dd
  2. 期間指定：last_week, last_month, last_quarter, or mtd
2. Dimensions - 最低一つ選択してください。：利用可能な寸法は、このガイドの次のエンドポイントを使用して一覧表示できます。
3. Metrics - 最低一つ選択してください。：利用可能な寸法は、このガイドの次のエンドポイントを使用して一覧表示できます。
4. Type - csv / json：jsonはレスポンスとしてデータを返し、csvはレスポンスとしてダウンロードリンクを返します。
リクエストに含まれていない場合、デフォルトのタイムゾーンはUTCになります。
リクエストに行数制限を設定することをお勧めしますが、制限が定義されていない場合は、フィルターおよび日付範囲に一致するすべてのデータがレスポンスに含まれます。

Response:

タイプが”csv”の場合、レポートデータは s3 に置かれ、URLが返されます（Video Console UI と同じで、有効期限は 1 時間です）。
タイプが "json" の場合、レポートデータが返されます。

このエンドポイントは、1 つまたは複数の動画プレーヤのレポートを取得するために使用できます。

利用可能なメトリックスとディメンションのリスト

このルートを呼び出すと、API を通じて利用可能なメトリックスとディメンジョンのリストを返すことができます。

https://video-console-server.browsiprod.com/api/v1/reports/fields

フィールドリスト：https://docs.google.com/document/d/1_wXK2XP-5bBwBNA87ZTKtmJA30JJi1CQf-JErl8DTqw/edit#heading=h.4dxyasiwhkgt

Method: GET
Response: