v3アナリティクスReporting APIのシンタックス

v3アナリティクスReporting API GETまたはPOSTリクエストは、v3アナリティクスReporting APIの設定・仕組みに説明されているようにOoyalaが発行したAPIキーとシークレットによって署名されなければなりません。また、有効期限があるキーワードとタイムスタンプを含んでいる必要があります。

さらに、クエリ文字列パラメーターの各値とfilters=の全値はURLエンコードが必要です。

GETレポートの通常シンタックス

ルートとクエリ文字列の基本シンタックスは以下のとおりです。読みやすくするため、1行のリクエストが複数行に分かれています。

[GET] /v3/analytics/reports/?
            report_type=type
            &dimensions=dimensions
            &metrics=metrics
            &filters=filter_type=='filter_value'
            &start_date=date
            &end_date=date
            &other_parms
            &api_key=your_api_key
         
  • 必須クエリ文字パラメーター(太文字で表示)はreport_type, start_dateおよびapi_keyです。
  • ディメンションが指定されていない場合、全ディメンションのすべての値が返されます。
  • 一度に3つのディメンションまで指定できます。
  • メトリックが指定されていない場合、すべてのメトリックが返されます。
Note: 現時点で、report_typeの唯一の有効な値はパフォーマンスです。

長いクエリPOSTをレポートする一般的なシンタックス

230文字のHTTP GET仕様限度を超えるクエリパラメーターのクエリについては、POSTリクエストを使ってください。一部のブラウザとHTTPクライアントは230文字以上に対応している場合がありますが、当社はHTTP GET仕様に違反しているクエリにサポートを提供していません。POSTリクエストについては、クエリ文字パラメーターの代わりにリクエスト本文にJSONオブジェクトをパスします。

[POST] /v3/analytics/reports

{
    "report_type":"type",
    "dimensions":"dimensions",
    "metrics":"metrics",
    "filters":"(filter_type==\"filter_value\")",
    "start_date":"date",
    "end_date":"date",
    "other_parms":"other_param_value",
    "api_key":"your_api_key"
}
         

この記事はお役にたちましたか?