複数のピボット レポートをバッチで返します。レポートはすべて同じエンティティのものである必要があります。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha:batchRunPivotReports
この URL は gRPC Transcoding 構文を使用します。
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 | |
---|---|
{ "entity": { object ( |
フィールド | |
---|---|
entity |
イベントが追跡されるプロパティ。バッチにはこのエンティティを指定する必要があります。RunPivotReportRequest 内のエンティティは、指定されていないか、このエンティティと整合性がとれている可能性があります。 |
requests[] |
個別のリクエスト。各リクエストには、個別のピボット レポート レスポンスがあります。各バッチ リクエストは最大 5 個までリクエストできます。 |
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
複数のピボット レポートを含むバッチ レスポンス。
JSON 表現 | |
---|---|
{
"pivotReports": [
{
object ( |
フィールド | |
---|---|
pivotReports[] |
個別の回答。各レスポンスには個別のピボット レポート リクエストが含まれます。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunPivotReportRequest
ピボット レポートを生成するリクエスト。
JSON 表現 | |
---|---|
{ "entity": { object ( |
フィールド | |
---|---|
entity |
イベントが追跡されるプロパティ。バッチ リクエスト内では、このエンティティを指定しないか、バッチレベルのエンティティと一致させる必要があります。 |
dimensions[] |
リクエストされたサイズ。定義されたすべてのディメンションは、dimensionExpression、dimensionFilter、Pivot、orderBys のいずれかを使用する必要があります。 |
metrics[] |
リクエストする指標。少なくとも 1 つの指標を指定する必要があります。定義されたすべての指標は、metric_expression、metricFilter、orderBys のいずれかで使用する必要があります。 |
dimensionFilter |
ディメンションのフィルタ句。このフィルタで使用するディメンションをリクエストする必要があります。このフィルタでは指標を使用できません。 |
metricFilter |
指標のフィルタ句。SQL with 句と同様に、事後集計フェーズで適用されます。このフィルタで指標を使用するには、リクエストする必要があります。このフィルタではディメンションを使用できません。 |
pivots[] |
レポートのディメンション(列または行)の視覚的な形式を表します。すべてのピボットの fieldNames(ディメンション名)の和集合は、ディメンションで定義されたディメンション名のサブセットである必要があります。2 つのピボットでディメンションを共有することはできません。ディメンションは、ピボットに表示されている場合にのみ表示されます。 |
dateRanges[] |
レポートのイベントデータを取得する期間。複数の期間が指定されている場合は、各期間のイベントデータがレポートで使用されます。ピボットのフィールド名に「dateRange」という特別なディメンションを含めることができます。指定すると、レポートでは期間同士が比較されます。コホート リクエストでは、この |
currencyCode |
ISO4217 形式の通貨コード(「AED」、「USD」、「JPY」など)。このフィールドが空の場合、レポートではエンティティのデフォルトの通貨が使用されます。 |
cohortSpec |
このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、「コホート」ディメンションを指定する必要があります。 |
keepEmptyRows |
false または指定されていない場合、すべての指標が 0 に等しい各行は返されません。true の場合、これらの行がフィルタによって個別に削除されない場合に返されます。 |
returnPropertyQuota |
このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。 |