Method: properties.batchRunReports

複数のレポートを一括で返します。すべてのレポートが同じ GA4 プロパティのものである必要があります。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクス GA4 プロパティ ID。本文ではなく URL パスで指定します。詳しくは、プロパティ ID を確認する方法をご覧ください。このプロパティはバッチに指定する必要があります。RunReportRequest 内のプロパティは、指定しないか、このプロパティと一致します。

例: properties/1234

リクエスト本文

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

JSON 表現
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
フィールド
requests[]

object (RunReportRequest)

個々のリクエスト。リクエストごとに個別のレポート レスポンスが得られます。1 つのバッチ リクエストには、最大 5 つのリクエストを使用できます。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

複数のレポートを含むバッチ レスポンス。

JSON 表現
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
フィールド
reports[]

object (RunReportResponse)

個々の回答各レスポンスには個別のレポート リクエストが含まれます。

kind

string

このメッセージがどのようなリソースであるかを示します。この kind は常に固定文字列 "analyticsData#batchRunReports" です。JSON でのレスポンス タイプを区別する場合に便利です。

認可スコープ

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

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

RunReportRequest

レポートの生成リクエスト。

JSON 表現
{
  "property": string,
  "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
}
フィールド
property

string

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

例: properties/1234

dimensions[]

object (Dimension)

リクエストされ、表示されたディメンションです。

metrics[]

object (Metric)

リクエストされ、表示された指標。

dateRanges[]

object (DateRange)

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

dimensionFilter

object (FilterExpression)

ディメンション フィルタを使用すると、レポートで特定のディメンション値のみを要求できます。詳しくは、ディメンション フィルタの基礎知識をご覧ください。このフィルタでは指標を使用できません。

metricFilter

object (FilterExpression)

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

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 を 100 より大きい値に設定しても、追加できる行数は 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 アナリティクス(GA4)プロパティで記録されたデータのみがレポートに表示されます。

たとえば、プロパティが purchase イベントをログに記録しない場合、eventName ディメンションと eventCount 指標のクエリでは、eventName: "purchase" と eventCount: 0 の行がなくなります。

returnPropertyQuota

boolean

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