Method: domainStats.batchQuery

Exécute un lot de requêtes QueryDomainStats pour plusieurs domaines. Renvoie PERMISSION_DENIED si vous n'êtes pas autorisé à accéder à DomainStats pour l'un des domaines demandés.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Champs
requests[]

object (QueryDomainStatsRequest)

Obligatoire. Liste des demandes de requête individuelles. Chaque demande peut concerner un domaine différent. Un lot ne peut pas comporter plus de 100 requêtes.

Corps de la réponse

Message de réponse pour domainStats.batchQuery.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Champs
results[]

object (BatchQueryDomainStatsResult)

Liste des réponses, une pour chaque requête dans BatchQueryDomainStatsRequest. L'ordre des réponses correspond à celui des requêtes.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide d'autorisation.

QueryDomainStatsRequest

Message de requête pour QueryDomainStats.

Représentation JSON 
{
  "parent": string,
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Champs
parent

string

Obligatoire. Nom de la ressource parente pour laquelle les statistiques sont demandées. Format : domains/{domain}
metricDefinitions[]

object (MetricDefinition)

Obligatoire. Métriques spécifiques à interroger. Vous pouvez définir un nom personnalisé pour chaque métrique, qui sera utilisé dans la réponse.
timeQuery

object (TimeQuery)

Obligatoire. Plage de dates ou dates spécifiques pour lesquelles récupérer les métriques.
pageSize

integer

Facultatif. Nombre maximal de ressources DomainStats à renvoyer dans la réponse. Le serveur peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, la valeur par défaut de 10 est utilisée. La valeur maximale est de 200.
pageToken

string

Facultatif. La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant. Si la précision de l'agrégation est "DAILY", le jeton de page sera la date encodée + "/" + nom de la métrique. Si la précision de l'agrégation est "OVERALL", le jeton de page sera le nom de la métrique encodé.
aggregationGranularity

enum (AggregationGranularity)

Facultatif. Précision à laquelle agréger les statistiques. Si aucune valeur n'est spécifiée, la valeur par défaut est "DAILY" (QUOTIDIEN).

BatchQueryDomainStatsResult

Représente le résultat d'une seule QueryDomainStatsRequest dans un lot.

Représentation 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.
}
Champs
Champ d'union result. Résultat de la requête individuelle. result ne peut être qu'un des éléments suivants :
response

object (QueryDomainStatsResponse)

Réponse positive à la requête individuelle.
error

object (Status)

État de l'erreur si la requête individuelle a échoué.

État

Le type Status définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.

Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.

Représentation JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Champs
code

integer

Code d'état, qui doit être une valeur d'énumération de google.rpc.Code.
message

string

Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details, ou localisé par le client.
details[]

object

Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API.