Method: domainStats.batchQuery

Ejecuta un lote de solicitudes de QueryDomainStats para varios dominios. Devuelve PERMISSION_DENIED si no tienes permiso para acceder a DomainStats de ninguno de los dominios solicitados.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación de gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Campos
requests[]

object (QueryDomainStatsRequest)

Obligatorio. Es una lista de solicitudes de búsqueda individuales. Cada solicitud puede ser para un dominio diferente. Se puede incluir un máximo de 100 solicitudes en un solo lote.

Cuerpo de la respuesta

Es el mensaje de respuesta para domainStats.batchQuery.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Campos
results[]

object (BatchQueryDomainStatsResult)

Es una lista de respuestas, una para cada consulta en BatchQueryDomainStatsRequest. El orden de las respuestas corresponderá al orden de las solicitudes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.

QueryDomainStatsRequest

Es el mensaje de solicitud para QueryDomainStats.

Representación JSON 
{
  "parent": string,
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Campos
parent

string

Obligatorio. Es el nombre del recurso principal en el que se consultan las estadísticas. Formato: domains/{domain}
metricDefinitions[]

object (MetricDefinition)

Obligatorio. Son las métricas específicas que se consultarán. Puedes definir un nombre personalizado para cada métrica, que se usará en la respuesta.
timeQuery

object (TimeQuery)

Obligatorio. Es el período o las fechas específicas para los que se recuperarán las métricas.
pageSize

integer

Opcional. Es la cantidad máxima de recursos de DomainStats que se devolverán en la respuesta. Es posible que el servidor devuelva menos que este valor. Si no se especifica, se usará un valor predeterminado de 10. El valor máximo es 200.
pageToken

string

Opcional. El valor nextPageToken que se muestra de una solicitud de lista previa, si existe. Si el nivel de detalle de la agregación es DIARIO, el token de página será la fecha codificada + "/" + el nombre de la métrica. Si el nivel de detalle de la agregación es OVERALL, el token de página será el nombre de la métrica codificado.
aggregationGranularity

enum (AggregationGranularity)

Opcional. Es la granularidad con la que se agregan las estadísticas. Si no se especifica, el valor predeterminado es DAILY.

BatchQueryDomainStatsResult

Representa el resultado de un solo QueryDomainStatsRequest dentro de un lote.

Representación 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.
}
Campos
Campo de unión result. Es el resultado de la búsqueda individual. result puede ser solo uno de los parámetros siguientes:
response

object (QueryDomainStatsResponse)

Es la respuesta correcta para la búsqueda individual.
error

object (Status)

Es el estado de error si falló la búsqueda individual.

Estado

El tipo de Status define un modelo de error lógico que es adecuado para entornos de programación diferentes, incluidas las API de REST y las API de RPC. Lo usa gRPC. Cada mensaje Status contiene tres datos: código de error, mensaje de error y detalles del error.

Puedes obtener más información sobre este modelo de error y cómo trabajar con él en la guía de diseño de API.

Representación JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

El código de estado, que debe ser un valor enum de google.rpc.Code.
message

string

Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error dirigido al usuario debe localizarse y enviarse al campo google.rpc.Status.details; o el cliente debe localizarlo.
details[]

object

Una lista de mensajes que contienen los detalles del error. Hay un conjunto común de tipos de mensajes para que usen las API.