Method: domainStats.batchQuery

Executa um lote de solicitações QueryDomainStats para vários domínios. Retorna PERMISSION_DENIED se você não tiver permissão para acessar DomainStats em nenhum dos domínios solicitados.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Campos
requests[]

object (QueryDomainStatsRequest)

Obrigatório. Uma lista de solicitações de consulta individuais. Cada solicitação pode ser para um domínio diferente. É possível incluir no máximo 100 solicitações em um único lote.

Corpo da resposta

Mensagem da resposta para "domainStats.batchQuery".

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Campos
results[]

object (BatchQueryDomainStatsResult)

Uma lista de respostas, uma para cada consulta em BatchQueryDomainStatsRequest. A ordem das respostas corresponde à ordem das solicitações.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o guia de autorização.

QueryDomainStatsRequest

Mensagem de solicitação para QueryDomainStats.

Representação JSON 
{
  "parent": string,
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Campos
parent

string

Obrigatório. O nome do recurso principal em que as estatísticas são consultadas. Formato: domains/{domain}
metricDefinitions[]

object (MetricDefinition)

Obrigatório. As métricas específicas a serem consultadas. Você pode definir um nome personalizado para cada métrica, que será usado na resposta.
timeQuery

object (TimeQuery)

Obrigatório. O período ou as datas específicas em que as métricas serão recuperadas.
pageSize

integer

Opcional. O número máximo de recursos DomainStats a serem retornados na resposta. O servidor pode retornar menos que esse valor. Se não for especificado, um valor padrão de 10 será usado. O valor máximo é 200.
pageToken

string

Opcional. O valor nextPageToken retornado de uma solicitação de lista anterior, se houver. Se a granularidade de agregação for DIÁRIA, o token de página será a data codificada + "/" + nome da métrica. Se a granularidade de agregação for "OVERALL", o token da página será o nome da métrica codificado.
aggregationGranularity

enum (AggregationGranularity)

Opcional. A granularidade em que as estatísticas serão agregadas. Se não for especificado, o padrão será DIÁRIO.

BatchQueryDomainStatsResult

Representa o resultado de um único QueryDomainStatsRequest em um lote.

Representação 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ão result. O resultado da consulta individual. result pode ser apenas de um dos tipos a seguir:
response

object (QueryDomainStatsResponse)

A resposta de sucesso para a consulta individual.
error

object (Status)

O status do erro se a consulta individual falhar.

Status

O tipo Status define um modelo de erro lógico que é adequado a diferentes ambientes de programação, incluindo APIs REST e RPC. É usado por gRPC. Cada mensagem Status contém três partes de dados: código do erro, mensagem de erro e detalhes do erro.

É possível descobrir mais sobre esse modelo de erro e como trabalhar com ele no Guia de design de API.

Representação JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

O código de status, que precisa ser um valor de enumeração de google.rpc.Code.
message

string

Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details, ou localizada pelo cliente.
details[]

object

Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem.