Method: properties.runPivotReport

Google アナリティクスのイベントデータのカスタマイズされたピボット レポートを返します。ピボット レポートは、通常のレポートよりも高度で表現力豊かなフォーマットです。ピボット レポートでは、ディメンションはピボットに含まれている場合にのみ表示されます。複数のピボットを指定して、データをさらに分析できます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

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

例: properties/1234

リクエスト本文

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

JSON 表現 
{
  "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
}
フィールド
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 つのピボットで 1 つのディメンションを共有することはできません。ディメンションは、ピボットに表示される場合にのみ表示されます。
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

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

レスポンスの本文

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

認可スコープ

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

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