Google アナリティクスのイベントデータのカスタマイズされたピボット レポートを返します。ピボット レポートは、通常のレポートよりも高度で表現力豊かなフォーマットです。ピボット レポートでは、ディメンションはピボットに含まれている場合にのみ表示されます。複数のピボットを指定して、データをさらに分析できます。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runPivotReport
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
property |
イベントがトラッキングされる Google アナリティクス GA4 プロパティの識別子。本文ではなく URL パスで指定します。詳しくは、プロパティ ID を確認する方法をご覧ください。バッチ リクエスト内では、このプロパティを指定しないか、バッチレベルのプロパティと一致させる必要があります。 例: properties/1234 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dimensions": [ { object ( |
フィールド | |
---|---|
dimensions[] |
リクエストされたサイズ。定義されたすべてのディメンションは、dimensionExpression、dimensionFilter、Pivot、orderBys のいずれかを使用する必要があります。 |
metrics[] |
リクエストする指標。少なくとも 1 つの指標を指定する必要があります。定義されたすべての指標は、metric_expression、metricFilter、orderBys のいずれかで使用する必要があります。 |
dateRanges[] |
レポートのイベントデータを取得する期間。複数の期間が指定されている場合は、各期間のイベントデータがレポートで使用されます。ピボットのフィールド名に「dateRange」という特別なディメンションを含めることができます。指定すると、レポートでは期間同士が比較されます。コホート リクエストでは、この |
pivots[] |
レポートのディメンション(列または行)の視覚的な形式を表します。すべてのピボットの fieldNames(ディメンション名)の和集合は、ディメンションで定義されたディメンション名のサブセットである必要があります。2 つのピボットでディメンションを共有することはできません。ディメンションは、ピボットに表示されている場合にのみ表示されます。 |
dimensionFilter |
ディメンションのフィルタ句。このフィルタで使用するディメンションをリクエストする必要があります。このフィルタでは指標を使用できません。 |
metricFilter |
指標のフィルタ句。SQL with 句と同様に、事後集計フェーズで適用されます。このフィルタで指標を使用するには、リクエストする必要があります。このフィルタではディメンションを使用できません。 |
currencyCode |
ISO4217 形式の通貨コード(「AED」、「USD」、「JPY」など)。このフィールドが空の場合、レポートではプロパティのデフォルトの通貨が使用されます。 |
cohortSpec |
このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、「コホート」ディメンションを指定する必要があります。 |
keepEmptyRows |
false または指定されていない場合、すべての指標が 0 に等しい各行は返されません。true の場合、これらの行がフィルタによって個別に削除されない場合に返されます。 この たとえば、あるプロパティで |
returnPropertyQuota |
このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。 |
comparisons[] |
省略可。リクエストおよび表示される比較の設定。レスポンスで比較列を取得するには、比較フィールドと比較ディメンションの両方が必要です。 |
レスポンスの本文
成功した場合、レスポンスの本文には RunPivotReportResponse
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics