Method: properties.batchRunPivotReports

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

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

例: properties/1234

リクエスト本文

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

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

object (RunPivotReportRequest)

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

レスポンスの本文

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

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

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

object (RunPivotReportResponse)

個々の回答各レスポンスには個別のピボット レポート リクエストがあります。
kind

string

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

認可スコープ

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

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

RunPivotReportRequest

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

JSON 表現 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
フィールド
property

string

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

例: properties/1234
dimensions[]

object (Dimension)

リクエストするディメンション。定義されたすべてのディメンションは、dimensionExpression、dimensionFilter、pivots、orderBys のいずれかで使用する必要があります。
metrics[]

object (Metric)

リクエストする指標は、少なくとも 1 つ指定する必要があります。定義されたすべての指標は、metric_expression、metricFilter、orderBys のいずれかで使用する必要があります。
dateRanges[]

object (DateRange)

レポートのイベントデータを取得する期間です。複数の期間を指定した場合は、各期間のイベントデータがレポートで使用されます。ピボットのフィールド名に「dateRange」フィールド名の特別なディメンションを含めると、レポートでは期間を比較できます。コホート リクエストでは、この dateRanges を指定しない（指定しない）必要があります。
pivots[]

object (Pivot)

レポートのディメンションの視覚的な形式を列または行で表します。すべてのピボットで fieldNames（ディメンション名）を合わせたものが、ディメンションで定義されたディメンション名のサブセットである必要があります。ディメンションを共有できないピボットは 2 つあります。ディメンションは、ピボットで表示される場合にのみ表示されます。
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

指標のフィルタ句。集計後のフェーズで適用（SQL 句あり）と同様。このフィルタで使用する指標をリクエストする必要があります。このフィルタではディメンションを使用できません。
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 で返されます。