Method: properties.runReport

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクス GA4 プロパティ ID。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 の has 句と同様に、レポートの行の集計後に適用されます。このフィルタではディメンションを使用できません。
offset

string (int64 format)

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

ページングでは、最初のリクエストでオフセットが指定されていません。または、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)

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

object (OrderBy)

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

string

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

object (CohortSpec)

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

boolean

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

この keepEmptyRows の設定にかかわらず、レポートに表示されるのは Google アナリティクス（GA4）プロパティで記録されたデータのみです。

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

boolean

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

object (Comparison)

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

レスポンスの本文

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

認可スコープ

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

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