Method: domains.trafficStats.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Elenca le statistiche sul traffico per tutti i giorni disponibili. Restituisce PERMISSION_DENIED se l'utente non ha l'autorizzazione per accedere a TrafficStats per il dominio.
Richiesta HTTP
GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
| Parametri |
parent |
string
Il nome della risorsa del dominio di cui vogliamo elencare le statistiche sul traffico. Deve avere il formato domains/{domain_name}, dove nome_dominio è il nome di dominio completo.
|
Parametri di query
| Parametri |
startDate |
object (Date)
Il primo giorno delle metriche da recuperare, incluso. startDate e endDate devono essere entrambi specificati o entrambi non specificati. Se ne viene specificato solo uno o se endDate è precedente a startDate, viene restituito INVALID_ARGUMENT.
|
endDate |
object (Date)
Il giorno più recente delle metriche da recuperare in modo esclusivo. startDate e endDate devono essere entrambi specificati o entrambi non specificati. Se ne viene specificato solo uno o se la data di fine è precedente a quella di inizio, viene restituito INVALID_ARGUMENT.
|
pageSize |
integer
Dimensioni della pagina richiesta. Il server potrebbe restituire meno dati TrafficStats rispetto a quelli richiesti. Se non viene specificato, il server sceglierà un valore predefinito appropriato.
|
pageToken |
string
Il valore nextPageToken restituito da una precedente richiesta di elenco, se presente. Questo è il valore di ListTrafficStatsResponse.next_page_token restituito dalla chiamata precedente al metodo trafficStats.list.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Messaggio di risposta per trafficStats.list.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
| Rappresentazione JSON |
{
"trafficStats": [
{
object (TrafficStats)
}
],
"nextPageToken": string
} |
| Campi |
trafficStats[] |
object (TrafficStats)
L'elenco di TrafficStats.
|
nextPageToken |
string
Token per recuperare la pagina di risultati successiva o vuoto se non ci sono altri risultati nell'elenco.
|
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/postmaster.readonly
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Data
Rappresenta una data di calendario intera o parziale, ad esempio un compleanno. L'ora del giorno e il fuso orario sono specificati altrove o non sono significativi. La data è relativa al calendario gregoriano. Può rappresentare uno dei seguenti elementi:
- Una data completa, con valori di anno, mese e giorno diversi da zero.
- Un mese e un giorno, con un anno pari a zero (ad esempio un anniversario).
- Un anno da solo, con un mese e un giorno pari a zero.
- Un anno e un mese, con un giorno pari a zero (ad esempio, la data di scadenza di una carta di credito).
Tipi correlati:
| Rappresentazione JSON |
{
"year": integer,
"month": integer,
"day": integer
} |
| Campi |
year |
integer
Anno della data. Deve essere compreso tra 1 e 9999 oppure 0 per specificare una data senza anno.
|
month |
integer
Mese di un anno. Deve essere compreso tra 1 e 12 oppure 0 per specificare un anno senza mese e giorno.
|
day |
integer
Giorno di un mese. Deve essere compreso tra 1 e 31 e valido per l'anno e il mese oppure 0 per specificare un anno da solo o un anno e un mese in cui il giorno non è significativo.
|
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: domains.trafficStats.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListTrafficStatsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Date](#Date)\n - [JSON representation](#Date.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nList traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.\n\n### HTTP request\n\n`GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `startDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The earliest day of the metrics to retrieve inclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `endDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The most recent day of the metrics to retrieve exclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `pageSize` | `integer` Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. This is the value of [ListTrafficStatsResponse.next_page_token](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#body.ListTrafficStatsResponse.FIELDS.next_page_token) returned from the previous call to `trafficStats.list` method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for trafficStats.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"trafficStats\": [ { object (/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `trafficStats[]` | `object (`[TrafficStats](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats)`)` The list of TrafficStats. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/postmaster.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nDate\n----\n\nRepresents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:\n\n- A full date, with non-zero year, month, and day values.\n- A month and day, with a zero year (for example, an anniversary).\n- A year on its own, with a zero month and a zero day.\n- A year and month, with a zero day (for example, a credit card expiration date).\n\nRelated types:\n\n- `google.type.TimeOfDay`\n- `google.type.DateTime`\n- [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)\n\n| JSON representation |\n|---------------------------------------------------------------|\n| ``` { \"year\": integer, \"month\": integer, \"day\": integer } ``` |\n\n| Fields ||\n|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `year` | `integer` Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |\n| `month` | `integer` Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |\n| `day` | `integer` Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |"]]
