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、ピボット、orderBy のいずれかで使用する必要があります。
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 の 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)

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