Method: properties.reportTasks.query

レポートタスクのコンテンツを取得します。reportTasks.create をリクエストすると、レポートが ACTIVE になったときにレポート コンテンツを取得できます。レポートタスクの状態が ACTIVE でない場合、このメソッドはエラーを返します。クエリ レスポンスは、レポートの表形式の行と列の値を返します。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

パスパラメータ

パラメータ
name

string

必須。レポートのソース名。形式: properties/{property}/reportTasks/{report}

リクエストの本文

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

JSON 表現 
{
  "offset": string,
  "limit": string
}
フィールド
offset

string (int64 format)

省略可。レポートの開始行の行数。最初の行は 0 行目としてカウントされます。

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

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

string (int64 format)

省略可。レポートから返す行数。指定しない場合は、10,000 行が返されます。リクエストごとに返される行数は、リクエストした数に関係なく最大 250,000 行です。limit は正の数にする必要があります。

リクエストされた limit よりもディメンション値の数が少ない場合、API はリクエストされた limit よりも少ない行数を返すことがあります。QueryReportTaskRequest で使用できる行数は、関連付けられた ReportTask の上限によってさらに制限されます。クエリで取得できる行数は、最大で ReportTask.limit 行です。たとえば、ReportTask の上限が 1,000 の場合、offset=900、limit=500 の reportTasks.query リクエストは最大 100 行を返します。

このページ設定パラメータの詳細については、ページ設定をご覧ください。

レスポンスの本文

レポートタスクに対応するレポート コンテンツ。

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

JSON 表現 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
フィールド
dimensionHeaders[]

object (DimensionHeader)

ディメンション列について説明します。DimensionHeaders の数と順序は、行に存在するディメンションと一致します。
metricHeaders[]

object (MetricHeader)

指標列について説明します。MetricHeaders の数と順序は、行に存在する指標と一致します。
rows[]

object (Row)

レポート内のディメンション値の組み合わせと指標値の行。
totals[]

object (Row)

リクエストされた場合は、指標の合計値。
maximums[]

object (Row)

リクエストされた場合は、指標の最大値。
minimums[]

object (Row)

リクエストされた場合は、指標の最小値。
rowCount

integer

クエリ結果の行の合計数。
metadata

object (ResponseMetaData)

レポートのメタデータ。

認可スコープ

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

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