このページは Cloud Translation API によって翻訳されました。

Method: properties.runPivotReport

HTTP リクエスト
パスパラメータ
リクエストの本文
- JSON 表現
レスポンスの本文
認可スコープ
試してみる

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ

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

property

string

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

例: properties/1234

リクエスト本文

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

JSON 表現

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)
    }
  ],
  "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、ピボット、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)` 省略可。リクエストされ、表示される比較の構成。レスポンスで比較列を受け取るには、リクエストに比較フィールドと比較ディメンションの両方が必要です。

レスポンスの本文

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

認可スコープ

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

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