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 )

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

Ответный текст

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

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

Для получения более подробной информации см. руководство по авторизации .