データをx2アナリティクスAPIでエクスポートする方法

はじめに

次に示す情報には、アナリティクスv2データの取得や保存について解説してあります。

お客様はv2アナリティクスからOoyala IQ(v3アナリティクス)に移行するので、以下のことに留意して頂く必要があります。
  • すべてのお客様は、2014年1月1日以降の再処理されたデータを利用できるようになります。
  • 2016年3月31日まで、旧v2アナリティクスAPIへアクセスすることができます。
つまり、1年以上の履歴アナリティクスデータにアクセスする必要がある場合、データにアクセスできる間にv2 APIを使用してデータをエクスポートする必要があります。

概要:Ooyala v2アナリティクスAPI

Ooyala v2アナリティクスAPIで、アナリティクスデータを提供してくれるレポートを簡単に作成できます。結果はJSON形式になります。(JSONは、簡単に読み取りや書き込みができるライトなデータ交換可能なフォーマットです。)

特定の日付範囲からアナリティクス結果を取得するには、APIで必要な結果の種類を定義して、MacのターミナルなどのターミナルエミュレーターやOoyalaスクラッチパッドで/v2/analytics/reports/をコールするだけです。

APIとは

コンピュータープログラミングでは、API(Application Programming Interface)はソフトウエアアプリケーションの一連のルティーンやプロトコルの名前です。APIは、操作や結果に関するソフトウエアコンポーネントを表しています。

API資格情報はどこで見つけることができますか?

Backlot UIでAPIキーとシークレットを見つけることができます。アカウント>開発者タブの下のBacklotにあるAPI v2資格情報を使用してください。
図 1. APIキーを見つける
APIキーを見つける

APIの仕組み

Ooyala APIコールは4つの基本的要素が必要になります。APIキー、APIシークレット、署名、有効期限です。

APIコールはHTTP方法でつくられます。GET APIコールは、データを直接修正することなくデータを取得するために使用されます。そしてそのオブジェクトのIDに基づいて入力されたJSON文書応答を取得できます。

Ooyala v2アナリティクスAPIで取得できる利用可能な結果には何がありますか?

v2アナリティクスAPIには、結果を取得するために特定する必要がある4つの主要な修飾子があります:

asset_id:この値は、探している場所によって異なる名前で表されます。Backlot APIでは、asset_idは特定のアセットの識別子です。asset_idは、コンテンツの一部を表すBacklot USで見つかるコンテンツIDと同じ値を持っています。値はすべてのシナリオで同じです。asset_idは、特定のアセットの結果を取得したい場合に使用できます。また、すべてのアセットを含むアカウントの結果を取得できます。

date_range:このレポートの日付範囲を定義します。アナリティクスは日付に基づいています。(YYYY-MM-DD)の形式の日付を定義できます。または(YYYY-MM-DD...YYYY-MM-DD)で日付範囲を定義できます。

レポートリクエスト:取得したいレポートタイプを定義します。有効な値には、パフォーマンス共有視聴者体験、および配信が含まれます。

ディメンション:ディメンションは、データの集約に使用される共通の基準で、ユーザー行動の発生日、視聴者の所在国などがあります。またすべてのディメンションには「ドリルダウン」があり、各ディメンションで特定の値によって結果をフィルターできます。

共有のクエリ文字列パラメーターや特性は共通属性とクエリー文字列パラメータで見つけることができます。

V2アナリティクスデータの取得方法

APコール形式とは何ですか?

V2アナリティクスAPIは、APIの本文で特定の順序に従います。

例えば、APIコール: /v2/analytics/reports/account/performance/[:dimension/:drilldown]/:date_range

2011-01-01から2014-01-01までのパフォーマンスレポートを取得したい場合、次のように表示されます:
図 2. パフォーマンスレポートのAPIコール
サンプルAPIコール

どうやってスクラッチパッドを使用してレポートを保存することができますか?

スクラッチパッドは、ブラウザからAPIクエリを行うことができるOoyalaが開発したツールです。

スクラッチパッドでアナリティクスレポートを取得するには:
  1. https://api.ooyala.com/docs/api_scratchpad?url=に移動します。
  2. ページの右上にある資格情報セクションの「アカウント」を選択します。
  3. ページの右上にある資格情報セクションにv2 API資格情報(APIキーとシークレット)を入力します。
  4. ページの左にあるクエリフィールドに、アナリティクスクエリを入力します。例えば、2011~2014年のパフォーマンスレポートを入手したい場合は、次のクエリをコピー・アンド・ペーストします: /v2/analytics/reports/account/performance/total/2011-01-01...2014-01-01
  5. GETを選択します。
  6. 送信をクリックします。
    注: 応答は応答フィールドに表示されます。
  7. 結果を大きなブラウザウインドウに表示したい場合は、送信ボタンの上にある緑色のAPI URLをブラウザにコピーします。この場合、URLはhttps://api.ooyala.com/v2/analytics/reports/account/performance/total/2011-01-01...2014-01-01?api_key=yourApiKey&signature=yourSignature&expires=1418771221になります。
  8. ブラウザでファイル>名前を付けて保存を選んでJSONを保存します。JSONをCSVに変換する方法については、分析形式のJSONからCSVへの変換をご覧ください。

追加のクエリの例

スクラッチパッドでクエリをつくる方法や特定のアナリティクスレポートタイプの作成方法については、以下をご覧ください:
注: アカウントのレポートタイプの全データを取得するには、「トータル」クエリ文字列パラメーターを使用します。上記のクエリ例のリンクで「トータル」を使用している例を参照できます。「トータル」はアカウントの特定のレポートタイプの全データを取得するために使用されます。
例えば、次のクエリは日付範囲011-08-01...2011-08-02におけるアカウントの全パフォーマンスデータを取得します。
[GET]/v2/analytics/reports/account/performance/total/2011-08-01...2011-08-02

どうやって自分のAPIレポートを作成するのですか?

Ooyala APIを理解していて、以前にスクリプトを作成したことがある、またはデータを取得する既存のクエリを修正できる技術的なリソースを持っている場合に限り、自分のAPIスクリプトを作成するべきです。

ターミナルを表示しているサンプルコードから次のスニペットを確認すると、、cURLを使用しているAPIコールのリクエストを送信していることが分かります。cURLはパラメーターとヘダーを修正できるhttpリクエストをつくります。
図 3. サンプルAPIレポート
APIレポート
注: 追加のスクリプト例は、サポートサイトのマニュアルをご覧ください: リクエストに署名するためのサンプルコード