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.

При пейджинге первый запрос не указывает смещение; или, что то же самое, устанавливает смещение в 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 )

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

metricHeaders[]

object ( MetricHeader )

Описывает столбцы показателей. Количество MetricHeaders и порядок 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

Респонсенметатадата

Метаданные ответа, содержащие дополнительную информацию о содержимом отчета.

JSON-представление 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Поля
dataLossFromOtherRow

boolean

Если это правда, указывает, что некоторые сегменты комбинаций измерений перенесены в строку «(другое)». Это может произойти с отчетами с большим количеством элементов.

Параметр метаданных dataLossFromOtherRow заполняется на основе таблицы агрегированных данных, используемой в отчете. Параметр будет точно заполнен независимо от фильтров и ограничений в отчете.

Например, (другая) строка может быть исключена из отчета, поскольку запрос содержит фильтр sessionSource = google. Этот параметр все равно будет заполнен, если во входных агрегатных данных, использованных для создания этого отчета, присутствовала потеря данных из другой строки.

Дополнительные сведения см. в разделе О (другой) строке и выборке данных .

schemaRestrictionResponse

object ( SchemaRestrictionResponse )

Описывает ограничения схемы, активно применяемые при создании этого отчета. Дополнительные сведения см. в разделе Управление доступом и ограничением данных .

currencyCode

string

Код валюты, используемый в этом отчете. Предназначен для использования при форматировании валютных показателей, таких как purchaseRevenue для визуализации. Если в запросе был указан валютный код, этот параметр ответа будет повторять параметр запроса; в противном случае этот параметр ответа является текущим валютным кодом свойства.

Коды валют — это строковые кодировки типов валют из стандарта ISO 4217 ( https://en.wikipedia.org/wiki/ISO_4217) ; например «USD», «EUR», «JPY». Дополнительную информацию см. на странице https://support.google.com/analytics/answer/9796179 .

timeZone

string

Текущий часовой пояс объекта размещения. Предназначен для интерпретации основанных на времени измерений, таких как hour и minute . Отформатировано как строки из базы данных часовых поясов IANA ( https://www.iana.org/time-zones) ; например «Америка/Нью-Йорк» или «Азия/Токио».

emptyReason

string

Если указана пустая причина, по этой причине отчет будет пустым.

subjectToThresholding

boolean

Если subjectToThresholding имеет значение true, этот отчет подлежит установлению пороговых значений и возвращает только данные, соответствующие минимальным пороговым значениям агрегации. Возможна ситуация, когда запрос подвергается установлению пороговых значений, и в отчете отсутствуют данные, и это происходит, когда все данные превышают пороговые значения. Дополнительную информацию см. в разделах «Пороговые значения данных» и «О демографии и интересах» .

СхемаRestrictionResponse

Ограничения схемы активно применяются при создании этого отчета. Дополнительные сведения см. в разделе Управление доступом и ограничением данных .

JSON-представление 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Поля
activeMetricRestrictions[]

object ( ActiveMetricRestriction )

Все ограничения активно соблюдаются при создании отчета. Например, purchaseRevenue всегда имеет тип ограничения REVENUE_DATA . Однако это ограничение активного ответа заполняется только в том случае, если настраиваемая роль пользователя запрещает доступ к REVENUE_DATA .

АктивМетрикритион

Метрика, активно ограниченная при создании отчета.

JSON-представление 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Поля
restrictedMetricTypes[]

enum ( RestrictedMetricType )

Причина ограничения этого показателя.

metricName

string

Имя ограниченной метрики.

Ограниченныйметриктипе

Категории данных, просмотр которых может быть ограничен на определенных ресурсах GA4.

Перечисления
RESTRICTED_METRIC_TYPE_UNSPECIFIED Неопределенный тип.
COST_DATA Метрики стоимости, такие как adCost .
REVENUE_DATA Метрики дохода, такие как purchaseRevenue .