Method: domains.trafficStats.list

Lister les statistiques de 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

Le nom de ressource du domaine dont nous souhaitons répertorier les statistiques de trafic. Il doit se présenter sous la forme domains/{domain_name}, où domain_name correspond au nom de domaine complet.

Paramètres de requête

Paramètres
startDate

object (Date)

Premier jour des métriques à récupérer inclusive. Les valeurs startDate et endDate doivent toutes les deux être spécifiées, ou les deux ne sont pas spécifiées. Si une seule valeur est spécifiée ou si la date de fin est antérieure à startDate, INVALID_ARGUMENT est renvoyé.
endDate

object (Date)

Jour le plus récent des métriques à récupérer exclusives. Les valeurs startDate et endDate doivent toutes les deux être spécifiées ou ne sont pas spécifiées. Si une seule valeur est spécifiée ou si la date de fin est antérieure à startDate, INVALID_ARGUMENT est renvoyé.
pageSize

integer

Taille de la page demandée. Le serveur peut renvoyer un nombre de TrafficStats inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur choisit 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 de 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 statistiques de trafic.
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 relatif aux autorisations.

Date

Représente une date calendaire complète 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 relative au calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Date complète, avec des valeurs d'année, de mois et de jour non nulles.
  • Jour et mois, avec une année nulle (un anniversaire, par exemple).
  • Une année seule, avec un mois et un jour zéro.
  • Année et 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. La valeur doit être comprise entre 1 et 9999, ou égale à 0 pour indiquer une date sans année.
month

integer

Mois de l'année. La valeur doit être comprise entre 1 et 12, ou 0 pour indiquer une année sans mois ni jour.
day

integer

Jour du mois. Doit être compris entre 1 et 31, et valide pour l'année et le mois, ou la valeur 0 pour indiquer une année seule, ou une année et un mois où le jour n'est pas significatif.