Method: properties.runPivotReport

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクス GA4 プロパティ ID。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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
フィールド
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 の has 句と同様に、集計後のフェーズで適用されます。このフィルタで使用するには、指標をリクエストする必要があります。このフィルタではディメンションを使用できません。
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)

省略可。リクエストして表示される比較の構成。レスポンスで比較列を取得するには、リクエストの比較フィールドと比較ディメンションの両方が必要です。

レスポンスの本文

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

認可スコープ

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

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