Method: domainStats.batchQuery

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

HTTP-запрос

POST https://gmailpostmastertools.googleapis.com/v2beta/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

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

ЗапросDomainStatsRequest

Запрос сообщения для 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 )

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

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.