Эта страница переведена с помощью Cloud Translation API.

Method: runReport

HTTP-запрос
Тело запроса
- JSON-представление
Тело ответа
Области авторизации
Попробуй это!

Возвращает настроенный отчет с данными о событиях Google Analytics. Отчеты содержат статистику, полученную на основе данных, собранных кодом отслеживания Google Analytics. Данные, возвращаемые из API, представляют собой таблицу со столбцами для запрошенных параметров и показателей. Метрики – это отдельные показатели активности пользователей на вашем ресурсе, например количество активных пользователей или количество событий. Параметры разбивают показатели по некоторым общим критериям, таким как страна или название мероприятия.

HTTP-запрос

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

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

Тело запроса

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

JSON-представление

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)
    }
  ],
  "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 )` Диапазоны дат данных для чтения. Если запрошено несколько диапазонов дат, каждая строка ответа будет содержать индекс диапазона дат, отсчитываемый от нуля. Если два диапазона дат перекрываются, данные о событиях для перекрывающихся дней включаются в строки ответа для обоих диапазонов дат. В запросе когорты этот `dateRanges` не должен быть указан.
`offset`	`string ( int64 format)` Количество строк в начальной строке. Первая строка считается строкой 0.
`limit`	`string ( int64 format)` Количество возвращаемых строк. Если параметр `limit` не указан, возвращается 10 000 строк. API возвращает максимум 100 000 строк на запрос, независимо от того, сколько вы запрашиваете.
`metricAggregations[]`	`enum ( MetricAggregation )` Агрегация метрик. Агрегированные значения показателей будут отображаться в строках, где для параметра DimensionValues установлено значение «RESERVED_(MetricAggregation)».
`dimensionFilter`	`object ( FilterExpression )` Предложение фильтра измерений. Для использования в этом фильтре необходимо запросить размеры. В этом фильтре нельзя использовать метрики.
`metricFilter`	`object ( FilterExpression )` Предложение фильтра метрик. Применяется на этапе после агрегирования, аналогично предложению «имеет» в SQL. Метрики должны быть запрошены для использования в этом фильтре. В этом фильтре нельзя использовать размеры.
`orderBys[]`	`object ( OrderBy )` Указывает, как упорядочены строки в ответе.
`currencyCode`	`string` Код валюты в формате ISO4217, например «AED», «USD», «JPY». Если поле пусто, в отчете используется валюта сущности по умолчанию.
`cohortSpec`	`object ( CohortSpec )` Когортная группа, связанная с этим запросом. Если в запросе указана когортная группа, параметр «когорта» должен присутствовать.
`keepEmptyRows`	`boolean` Если значение false или не указано, каждая строка со всеми метриками, равными 0, не будет возвращена. Если это правда, эти строки будут возвращены, если они не будут удалены фильтром отдельно.
`returnPropertyQuota`	`boolean` Переключает, возвращать ли текущее состояние квоты этого ресурса Google Analytics. Квота возвращается в PropertyQuota .

Тело ответа

В случае успеха тело ответа содержит экземпляр RunReportResponse .

Области авторизации

Требуется одна из следующих областей OAuth:

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