Method: properties.batchRunPivotReports

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

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

例: properties/1234

リクエスト本文

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

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

object (RunPivotReportRequest)

個別のリクエスト。各リクエストには、個別のピボット レポート レスポンスがあります。各バッチ リクエストは 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 プロパティの識別子。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)

レポートのディメンションを列または行で表したものです。すべてのピボットの fieldName(ディメンション名)の和集合は、ディメンションで定義されたディメンション名のサブセットにする必要があります。2 つのピボットでディメンションを共有することはできません。ディメンションは、ピボットに表示された場合にのみ表示されます。

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

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

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 に返されます。