Method: runReport

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

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1alpha:runReport

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

リクエストの本文

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

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

object (Entity)

イベントが追跡されるプロパティ。バッチ リクエスト内では、このエンティティは指定しないか、バッチレベルのエンティティと一致する必要があります。
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

string (int64 format)

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

string (int64 format)

返される行数。limit パラメータが指定されていない場合、10,000 行が返されます。この API では、指定した行数に関係なく、リクエストごとに最大 100,000 行が返されます。
metricAggregations[]

enum (MetricAggregation)

指標の集計。集計された指標値は、dimensionValues が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。
dimensionFilter

object (FilterExpression)

ディメンションのフィルタ句。このフィルタで使用するディメンションをリクエストする必要があります。このフィルタでは指標を使用できません。
metricFilter

object (FilterExpression)

指標のフィルタ句。SQL の has 句と同様に、集計後のフェーズで適用されます。このフィルタで使用するには、指標をリクエストする必要があります。このフィルタではディメンションを使用できません。
orderBys[]

object (OrderBy)

レスポンスの行の順序を指定します。
currencyCode

string

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

object (CohortSpec)

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

boolean

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

boolean

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

レスポンスの本文

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

認証スコープ

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

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