Method: properties.batchRunReports

複数のレポートをバッチで返します。すべてのレポートが同じ Google アナリティクス プロパティのものである必要があります。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

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

例: properties/1234

リクエスト本文

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

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

object (RunReportRequest)

個別のリクエスト。各リクエストには個別のレポート レスポンスがあります。各バッチ リクエストで許可されるリクエストは 5 件までです。

レスポンスの本文

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

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (RunReportResponse)

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

string

このメッセージのリソースの種類を示します。この kind は常に固定文字列「analyticsData#batchRunReports」です。JSON でレスポンス タイプを区別する場合に便利です。

認可スコープ

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

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

RunReportRequest

レポートの生成リクエスト。

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

string

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

例: properties/1234
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

読み取るデータの日付範囲。複数の期間がリクエストされた場合、各レスポンス行にはゼロベースの期間インデックスが含まれます。2 つの期間が重複する場合、重複する日のイベントデータは、両方の期間のレスポンスの行に含まれます。コホート リクエストでは、この dateRanges を指定しないでください。
dimensionFilter

object (FilterExpression)

ディメンション フィルタを使用すると、レポート内の特定のディメンション値のみを取得できます。詳細については、ディメンション フィルタの基本で例をご覧ください。このフィルタでは指標を使用できません。
metricFilter

object (FilterExpression)

指標のフィルタ句。SQL の having 句と同様に、レポートの行の集計後に適用されます。このフィルタではディメンションを使用できません。
offset

string (int64 format)

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

ページングする場合、最初のリクエストではオフセットを指定しません。つまり、オフセットを 0 に設定します。最初のリクエストは、最初の limit 行を返します。2 番目のリクエストは、オフセットを最初のリクエストの limit に設定します。2 番目のリクエストは、行の 2 番目の limit を返します。

このページネーション パラメータの詳細については、ページネーションをご覧ください。
limit

string (int64 format)

返す行数。指定しない場合、10,000 行が返されます。API は、リクエストに応じて最大 250,000 行を返します。limit には正の値を指定してください。

limit と同じ数のディメンション値がない場合、API から返される行数がリクエストされた limit よりも少なくなることもあります。たとえば、ディメンション country の有効な値は 300 未満であるため、country のみをレポートする場合、limit をより大きい値に設定しても、300 行を超える行を取得することはできません。

このページネーション パラメータの詳細については、ページネーションをご覧ください。
metricAggregations[]

enum (MetricAggregation)

指標の集計。集計された指標値は、dimensionValues が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。比較と複数の期間の両方を含む集計は、期間に基づいて集計されます。
orderBys[]

object (OrderBy)

レスポンスで行を並べ替える方法を指定します。比較と複数の期間の両方を含むリクエストでは、比較に並べ替え順序が適用されます。
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)

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