Method: domains.trafficStats.list

Répertorie les statistiques sur le trafic pour tous les jours disponibles. Renvoie PERMISSION_DENIED si l'utilisateur n'est pas autorisé à accéder à TrafficStats pour le domaine.

Requête HTTP

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Nom de la ressource du domaine dont vous souhaitez lister les statistiques de trafic. Il doit avoir le format domains/{domain_name}, où "domain_name" est le nom de domaine complet.

Paramètres de requête

Paramètres
startDate

object (Date)

Date de début des métriques à récupérer (inclus). startDate et endDate doivent être spécifiés ou non. Si vous n'en spécifiez qu'un seul ou si la date de fin est antérieure à la date de début, la valeur INVALID_ARGUMENT est renvoyée.
endDate

object (Date)

Jour le plus récent des métriques à récupérer (exclusif). startDate et endDate doivent être spécifiés ou non. Si vous n'en spécifiez qu'un seul ou si la date de fin est antérieure à la date de début, la valeur INVALID_ARGUMENT est renvoyée.
pageSize

integer

Taille de la page demandée. Le serveur peut renvoyer moins de TrafficStats que demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
pageToken

string

La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant. Il s'agit de la valeur ListTrafficStatsResponse.next_page_token renvoyée par l'appel précédent à la méthode trafficStats.list.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour trafficStats.list.

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

Représentation JSON 
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
Champs
trafficStats[]

object (TrafficStats)

Liste des TrafficStats.
nextPageToken

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • un mois et un jour, avec une année nulle (par exemple, un anniversaire) ;
  • une année seule, avec un mois et un jour nuls ;
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés:

Représentation JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Elle doit être comprise entre 1 et 9999, ou égale à 0 pour spécifier une date sans année.
month

integer

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 pour spécifier une année sans mois ni jour.
day

integer

Jour d'un mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 pour spécifier une année seule, ou une année et un mois où le jour n'est pas significatif.