Method: domainStats.batchQuery

Выполняет пакет запросов QueryDomainStats для нескольких доменов. Возвращает PERMISSION_DENIED, если у вас нет разрешения на доступ к DomainStats для какого-либо из запрошенных доменов.

HTTP-запрос

POST https://gmailpostmastertools.googleapis.com/v2/domainStats:batchQuery

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

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

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

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

object ( QueryDomainStatsRequest )

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

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

Ответное сообщение для domainStats.batchQuery.

В случае успеха тело ответа содержит данные следующей структуры:

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

object ( BatchQueryDomainStatsResult )

Список ответов, по одному для каждого запроса в объекте BatchQueryDomainStatsRequest. Порядок ответов будет соответствовать порядку запросов.

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

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

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

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

QueryDomainStatsRequest

Сообщение запроса для QueryDomainStats.

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

string

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

metricDefinitions[]

object ( MetricDefinition )

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

timeQuery

object ( TimeQuery )

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

pageSize

integer

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

pageToken

string

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

aggregationGranularity

enum ( AggregationGranularity )

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

BatchQueryDomainStatsResult

Представляет результат одного запроса QueryDomainStatsRequest в пакете.

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

  // Union field result can be only one of the following:
  "response": {
    object (QueryDomainStatsResponse)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Поля
result выполнения объединенного поля. Результат отдельного запроса. result может быть только одним из следующих:
response

object ( QueryDomainStatsResponse )

Успешный ответ на индивидуальный запрос.

error

object ( Status )

Статус ошибки отображается, если отдельный запрос не удался.

Статус

Тип Status определяет логическую модель ошибок, подходящую для различных сред программирования, включая REST API и RPC API. Он используется в gRPC . Каждое сообщение Status содержит три элемента данных: код ошибки, сообщение об ошибке и подробности ошибки.

Более подробную информацию об этой модели ошибок и способах работы с ней вы найдете в Руководстве по проектированию API .

JSON-представление 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Поля
code

integer

Код состояния, который должен быть значением перечисления google.rpc.Code .

message

string

Сообщение об ошибке, предназначенное для разработчика, должно быть на английском языке. Любое сообщение об ошибке, предназначенное для пользователя, должно быть локализовано и отправлено в поле google.rpc.Status.details или локализовано клиентом.

details[]

object

Список сообщений, содержащих подробную информацию об ошибке. Существует общий набор типов сообщений, используемых API.