Method: properties.batchRunPivotReports

複数のピボット レポートをバッチで返します。すべてのレポートは、同じ Google アナリティクスのプロパティのものである必要があります。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクスのプロパティの ID。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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
フィールド
property

string

イベントがトラッキングされる Google アナリティクスのプロパティの 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 の 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)

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