Method: domains.domainStats.query

Получает список статистики домена для указанного домена за указанный период времени. Возвращает PERMISSION_DENIED, если у вас нет разрешения на доступ к DomainStats для этого домена.

HTTP-запрос

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

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

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

Параметры
parent

string

Обязательно. Имя родительского ресурса, к которому запрашивается статистика. Формат: domains/{domain}

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

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

JSON-представление 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Поля
metricDefinitions[]

object ( MetricDefinition )

Обязательно. Конкретные метрики для запроса. Вы можете задать имя для каждой метрики, которое будет использоваться в ответе.

timeQuery

object ( TimeQuery )

Обязательно. Временной диапазон или конкретные даты, для которых необходимо получить показатели.

pageSize

integer

Необязательно. Максимальное количество ресурсов DomainStats, возвращаемых в ответе. Сервер может вернуть меньше этого значения. Если не указано, будет использовано значение по умолчанию — 10. Максимальное значение — 200.

pageToken

string

Необязательно. Значение nextPageToken, возвращаемое из предыдущего запроса List, если таковое имеется. Если гранулярность агрегации — DAILY, токен страницы будет представлять собой закодированную дату + "/" + название метрики. Если гранулярность агрегации — OVERALL, токен страницы будет представлять собой закодированное название метрики.

aggregationGranularity

enum ( AggregationGranularity )

Необязательно. Уровень детализации для агрегирования статистики. Если не указано, по умолчанию используется DAILY.

Тело ответа

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

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

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

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

Более подробную информацию смотрите в Руководстве по авторизации .