Method: properties.reportTasks.query

Получает содержимое задачи отчета. После запроса метода reportTasks.create вы сможете получить содержимое отчета, как только он станет АКТИВНЫМ. Этот метод вернет ошибку, если состояние задачи отчета не ACTIVE . В ответ на запрос будут возвращены табличные значения строк и столбцов отчета.

HTTP-запрос

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

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Обязательно. Название источника отчета. Формат: properties/{property}/reportTasks/{report}

Текст запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "offset": string,
  "limit": string
}
Поля
offset

string ( int64 format)

Необязательно. Количество строк в начале отчета. Первая строка считается нулевой.

При постраничной навигации первый запрос не указывает смещение; или, эквивалентно, устанавливает смещение равным 0; первый запрос возвращает первое limit количества строк. Второй запрос устанавливает смещение равным limit первого запроса; второй запрос возвращает второе limit количества строк.

Чтобы узнать больше об этом параметре пагинации, см. раздел «Пагинация» .

limit

string ( int64 format)

Необязательный параметр. Количество строк, которые должны быть возвращены из отчета. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк за запрос, независимо от количества запрошенных строк. limit должен быть положительным.

API также может возвращать меньше строк, чем запрошенный limit , если количество значений измерений меньше limit . Количество строк, доступных для QueryReportTaskRequest, дополнительно ограничивается лимитом связанной задачи ReportTask. Запрос может получить максимум ReportTask.limit строк. Например, если у задачи ReportTask лимит 1000, то запрос reportTasks.query со смещением = 900 и лимитом = 500 вернет максимум 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 )

Описывает столбцы измерений. Количество заголовков измерений и порядок заголовков измерений соответствуют измерениям, присутствующим в строках.

metricHeaders[]

object ( MetricHeader )

Описывает столбцы метрик. Количество заголовков метрик и порядок их отображения соответствуют метрикам, присутствующим в строках.

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