Method: properties.runReport

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

リクエストの作成とレスポンスの解釈のガイドについては、レポートの作成をご覧ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクス GA4 プロパティの識別子。本文ではなく 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
}
フィールド
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

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

string (int64 format)

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

ページングの際に、最初のリクエストで offset が指定されていません。または、これと同等に、offset を 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)

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

object (OrderBy)

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

string

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

object (CohortSpec)

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

boolean

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

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

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

boolean

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

レスポンスの本文

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

承認スコープ

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

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