Method: properties.runReport

Google アナリティクスのイベントデータのカスタマイズされたレポートを返します。レポートには、Google アナリティクスのトラッキング コードによって収集されたデータから導出された統計情報が含まれます。API から返されるデータは、リクエストされたディメンションと指標の列を含むテーブル形式です。指標は、プロパティでのユーザー アクティビティの個々の測定値です（アクティブ ユーザー数やイベント数など）。ディメンションは、国やイベント名などの一般的な条件で指標を分類します。

リクエストの作成とレスポンスの理解については、レポートを作成するをご覧ください。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクスのプロパティの識別子。本文ではなく URL パスで指定します。詳細については、プロパティ ID を確認するをご覧ください。バッチ リクエストでは、このプロパティは指定しないか、バッチレベルのプロパティと一致させる必要があります。

例: properties/1234

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
フィールド
dimensions[]

object (Dimension)

リクエストされて表示されるディメンション。
metrics[]

object (Metric)

リクエストされて表示される指標。
dateRanges[]

object (DateRange)

読み取るデータの期間。複数の期間がリクエストされた場合、各レスポンス行には 0 から始まる期間インデックスが含まれます。2 つの期間が重複している場合、重複する日のイベントデータは両方の期間のレスポンス行に含まれます。コホート リクエストでは、この dateRanges は指定しないでください。
dimensionFilter

object (FilterExpression)

ディメンション フィルタを使用すると、レポートで特定のディメンション値のみをリクエストできます。例については、ディメンション フィルタの基本をご覧ください。このフィルタでは指標を使用できません。
metricFilter

object (FilterExpression)

指標のフィルタ句。SQL の having 句と同様に、レポートの行を集計した後に適用されます。このフィルタではディメンションを使用できません。
offset

string (int64 format)

開始行の行数。最初の行は 0 行目としてカウントされます。

ページ分割の場合、最初のリクエストではオフセットを指定しません。つまり、オフセットを 0 に設定します。最初のリクエストは、最初の limit 行を返します。2 番目のリクエストでは、オフセットを最初のリクエストの limit に設定します。2 番目のリクエストは、2 番目の limit 行を返します。

このページ分割パラメータの詳細については、ページ分割をご覧ください。
limit

string (int64 format)

返す行数。指定しない場合は、10,000 行が返されます。リクエストする数に関係なく、API はリクエストごとに最大 250,000 行を返します。limit は正の値にする必要があります。

また、ディメンション値の数が limit よりも少ない場合、API はリクエストされた limit よりも少ない行を返すことがあります。たとえば、ディメンション country の可能な値は 300 未満であるため、country のみをレポートする場合、limit を大きな値に設定しても 300 行を超える行を取得することはできません。

このページ分割パラメータの詳細については、ページ分割をご覧ください。
metricAggregations[]

enum (MetricAggregation)

指標の集計。集計された指標値は、dimensionValues が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。比較と複数の期間の両方を含む集計は、期間に基づいて集計されます。
orderBys[]

object (OrderBy)

レスポンスで行を並べ替える方法を指定します。比較と複数の期間の両方を含むリクエストでは、比較に並べ替えが適用されます。
currencyCode

string

ISO4217 形式の通貨コード（「AED」、「USD」、「JPY」など）。このフィールドが空の場合、レポートではプロパティのデフォルトの通貨が使用されます。
cohortSpec

object (CohortSpec)

このリクエストに関連付けられたコホート グループ。リクエストにコホート グループがある場合は、「コホート」ディメンションが存在する必要があります。
keepEmptyRows

boolean

false または未指定の場合、すべての指標が 0 の行は返されません。true の場合、フィルタで個別に削除されない限り、これらの行が返されます。

この keepEmptyRows の設定に関係なく、レポートに表示できるのは Google アナリティクスのプロパティで記録されたデータのみです。

たとえば、プロパティで purchase イベントが記録されない場合、eventName ディメンションと eventCount 指標のクエリには、eventName: "purchase" と eventCount: 0 の行は含まれません。
returnPropertyQuota

boolean

この Google アナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。
comparisons[]

object (Comparison)

省略可。リクエストされて表示される比較の構成。レスポンスで比較列を受け取るには、リクエストに comparisons フィールドのみが必要です。

レスポンスの本文

成功した場合、レスポンスの本文には RunReportResponse のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics