Method: batchRunReports

複数のレポートをまとめて返します。レポートはすべて同じエンティティのものである必要があります。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1alpha:batchRunReports

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

リクエスト本文

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

JSON 表現 
{
  "entity": {
    object (Entity)
  },
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
フィールド
entity

object (Entity)

イベントが追跡されるプロパティ。バッチにはこのエンティティを指定する必要があります。RunReportRequest 内のエンティティは、指定されていないか、このエンティティと一致しています。
requests[]

object (RunReportRequest)

個別のリクエスト。リクエストごとに個別のレポート レスポンスが返されます。各バッチ リクエストは最大 5 個までリクエストできます。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

複数のレポートを含むバッチ レスポンス。

JSON 表現 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ]
}
フィールド
reports[]

object (RunReportResponse)

個別の回答。レスポンスごとに別々のレポート リクエストがあります。

認可スコープ

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

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

RunReportRequest

レポートを生成するリクエスト。

JSON 表現 
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
フィールド
entity

object (Entity)

イベントが追跡されるプロパティ。バッチ リクエスト内では、このエンティティを指定しないか、バッチレベルのエンティティと一致させる必要があります。
dimensions[]

object (Dimension)

リクエストされ、表示されたディメンション。
metrics[]

object (Metric)

リクエストされ、表示される指標。
dateRanges[]

object (DateRange)

読み取るデータの期間。複数の期間をリクエストすると、各レスポンス行にゼロから始まる期間のインデックスが含まれます。2 つの期間が重複している場合は、重複する日のイベントデータが両方の期間のレスポンス行に含まれます。コホート リクエストでは、この dateRanges は指定できません。
offset

string (int64 format)

開始行の行数。最初の行は行 0 としてカウントされます。
limit

string (int64 format)

返される行数。limit パラメータが指定されていない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 100,000 行を返します。
metricAggregations[]

enum (MetricAggregation)

指標の集計。集計された指標値は、dimensionValue が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。
dimensionFilter

object (FilterExpression)

ディメンションのフィルタ句。このフィルタで使用するディメンションをリクエストする必要があります。このフィルタでは指標を使用できません。
metricFilter

object (FilterExpression)

指標のフィルタ句。SQL with 句と同様に、事後集計フェーズで適用されます。このフィルタで指標を使用するには、リクエストする必要があります。このフィルタではディメンションを使用できません。
orderBys[]

object (OrderBy)

レスポンス内の行の順序を指定します。
currencyCode

string

ISO4217 形式の通貨コード（「AED」、「USD」、「JPY」など）。このフィールドが空の場合、レポートではエンティティのデフォルトの通貨が使用されます。
cohortSpec

object (CohortSpec)

このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、「コホート」ディメンションを指定する必要があります。
keepEmptyRows

boolean

false または指定されていない場合、すべての指標が 0 に等しい各行は返されません。true の場合、これらの行がフィルタによって個別に削除されない場合に返されます。
returnPropertyQuota

boolean

このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。