Method: properties.runPivotReport

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクスのプロパティの識別子。本文ではなく 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 の having 句と同様に、集計後のフェーズで適用されます。このフィルタで使用する指標をリクエストする必要があります。このフィルタではディメンションを使用できません。
currencyCode

string

ISO4217 形式の通貨コード（例: AED、USD、JPY）。このフィールドが空の場合、レポートではプロパティのデフォルトの通貨が使用されます。
cohortSpec

object (CohortSpec)

このリクエストに関連付けられたコホート グループ。リクエストにコホート グループがある場合は、「コホート」ディメンションが存在する必要があります。
keepEmptyRows

boolean

false または未指定の場合、すべての指標が 0 の行は返されません。true の場合、フィルタで個別に削除されない限り、これらの行が返されます。

この keepEmptyRows の設定に関係なく、レポートに表示できるのは Google アナリティクスのプロパティで記録されたデータのみです。

たとえば、プロパティで purchase イベントが記録されない場合、eventName ディメンションと eventCount 指標のクエリには、eventName: "purchase" と eventCount: 0 の行は含まれません。
returnPropertyQuota

boolean

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

object (Comparison)

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

レスポンスの本文

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

認可スコープ

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

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