Method: domains.trafficStats.list

Wyświetlać statystyki ruchu ze wszystkich dostępnych dni. Zwraca wartość PERMISSION_DENIED, jeśli użytkownik nie ma uprawnień dostępu do statystyk TrafficStats w domenie.

Żą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 chcesz wyświetlić. Powinien mieć format domains/{domain_name}, gdzie nazwa_domeny jest w pełni kwalifikowaną nazwą domeny.

Parametry zapytania

Parametry
startDate

object (Date)

Najwcześniejszy dzień danych do pobrania włącznie. Zarówno startDate, jak i endDate muszą być określone lub oba nieokreślone. Jeśli określono tylko jeden element lub data zakończenia jest wcześniejsza niż data początkowa, zwracana jest wartość Nieprawidłowa.

endDate

object (Date)

Ostatni dzień wskaźników, które mają zostać pobrane na wyłączność. Zarówno startDate, jak i endDate muszą być określone lub oba nieokreślone. Jeśli określono tylko jedną z tych wartości lub data zakończenia jest wcześniejsza od daty rozpoczęcia, zwracana jest wartość INVALID_AR.

pageSize

integer

Żądany rozmiar strony. Serwer może zwrócić mniej statystyk ruchu, niż zażądano. Jeśli nie określono inaczej, serwer wybierze odpowiednią wartość domyślną.

pageToken

string

Wartość nextPageToken zwrócona z poprzedniego żądania listy (jeśli miało to miejsce). To jest wartość parametru ListTrafficStatsResponse.next_page_token zwrócona z poprzedniego wywołania metody trafficStats.list.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat z odpowiedzią na temat 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 ruchu.

nextPageToken

string

Token pobierający następną stronę wyników lub pusty, jeśli na liście nie ma więcej wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

Data

Reprezentuje całą datę lub jej część, na przykład datę urodzin. Pora dnia i strefa czasowa zostały określone w innym miejscu lub są nieistotne. Data zależy od kalendarza gregoriańskiego. Może to być jedna z tych wartości:

  • Pełna data z wartościami niezerowymi dotyczącymi roku, miesiąca i dnia.
  • Miesiąc i dzień bez roku (np. rocznica).
  • Sam rok z zerowym miesiącem i zerowym dniem.
  • Rok i miesiąc z zerową datą ważności (np. data ważności karty kredytowej).

Podobne typy:

Zapis JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Pola
year

integer

Rok daty. Wartość musi mieścić się w zakresie od 1 do 9999 lub od 0 do określenia daty bez roku.

month

integer

Miesiąc w roku. Wartość musi mieścić się w zakresie od 1 do 12 lub od 0, jeśli chcesz określić rok bez miesiąca i dnia.

day

integer

Dzień miesiąca. Wartość musi należeć do zakresu od 1 do 31 i jest ważna dla roku i miesiąca. Wartość 0 pozwala określić pojedynczy rok lub rok i miesiąc, w którym dzień nie jest istotny.