Method: domains.trafficStats.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Lista statystyk ruchu z wszystkich dostępnych dni. Zwraca wartość PERMISSION_DENIED, jeśli użytkownik nie ma uprawnień dostępu do statystyk ruchu w przypadku danej domeny.
Żądanie HTTP
GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
parent |
string
Nazwa zasobu domeny, której statystyki ruchu chcemy wyświetlić. Musi mieć postać domains/{domain_name}, gdzie domain_name to pełna i jednoznaczna nazwa domeny.
|
Parametry zapytania
| Parametry |
startDate |
object (Date)
Najwcześniejszy dzień, w którym mają być pobrane dane. Musisz podać zarówno startDate, jak i endDate albo nie podawać żadnej z tych wartości. Jeśli podano tylko jedną wartość lub wartość endDate jest wcześniejsza niż startDate, zwracany jest błąd INVALID_ARGUMENT.
|
endDate |
object (Date)
Najnowszy dzień danych, które mają być pobrane. Musisz podać zarówno startDate, jak i endDate, albo nie podawać żadnej z tych wartości. Jeśli podano tylko jedną wartość lub data endDate jest wcześniejsza niż data startDate, zwracany jest błąd INVALID_ARGUMENT.
|
pageSize |
integer
Żądany rozmiar strony. Serwer może zwrócić mniej danych TrafficStats niż żądana liczba. Jeśli nie zostanie określone, serwer wybierze odpowiedni domyślny.
|
pageToken |
string
Wartość nextPageToken zwrócona z poprzedniego żądania List (jeśli takie było). Jest to wartość ListTrafficStatsResponse.next_page_token zwrócona z poprzedniego wywołania metody trafficStats.list.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź na trafficStats.list.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"trafficStats": [
{
object (TrafficStats)
}
],
"nextPageToken": string
} |
| Pola |
trafficStats[] |
object (TrafficStats)
Lista statystyk dotyczących ruchu.
|
nextPageToken |
string
Token do pobierania następnej strony wyników lub pusty, jeśli na liście nie ma już żadnych wyników.
|
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/postmaster.readonly
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
Data
Reprezentuje całą lub częściową datę kalendarzową, np. urodziny. Godzina i strefa czasowa są określone w innym miejscu lub nie mają znaczenia. Data jest podawana w kalendarzu gregoriańskim. Może to być:
- Pełna data z wartościami roku, miesiąca i dnia innymi niż 0.
- miesiąc i dzień z zerowym rokiem (np. rocznica).
- Rok bez miesiąca i dnia.
- Rok i miesiąc z zerowym dniem (np. data ważności karty kredytowej).
Powiązane typy:
| Zapis JSON |
{
"year": integer,
"month": integer,
"day": integer
} |
| Pola |
year |
integer
Rok daty. Musi być liczbą z zakresu 1–9999 lub 0, jeśli chcesz podać datę bez roku.
|
month |
integer
Miesiąc w roku. Wartość musi mieścić się w przedziale od 1 do 12, lub 0, jeśli chcesz określić rok bez miesiąca i dnia.
|
day |
integer
Dzień miesiąca. Musi zawierać wartość od 1 do 31 i być prawidłową dla roku lub miesiąca albo 0, aby określić tylko rok lub rok i miesiąc, w których przypadku dzień nie ma znaczenia.
|
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
