Method: domains.domainStats.query

Pobiera listę statystyk domeny dla danej domeny i okresu. Zwraca PERMISSION_DENIED, jeśli nie masz uprawnień dostępu do DomainStats w przypadku domeny.

Żądanie HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Nazwa zasobu nadrzędnego, w którym są wysyłane zapytania o statystyki. Format: domains/{domain}

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Pola
metricDefinitions[]

object (MetricDefinition)

Wymagane. Konkretne dane, o które chcesz wysłać zapytanie. Możesz zdefiniować niestandardową nazwę każdego rodzaju danych, która będzie używana w odpowiedzi.
timeQuery

object (TimeQuery)

Wymagane. Zakres czasu lub konkretne daty, dla których chcesz pobrać dane.
pageSize

integer

Opcjonalnie: Maksymalna liczba zasobów DomainStats do zwrócenia w odpowiedzi. Serwer może zwrócić mniej niż ta wartość. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 10. Maksymalna wartość to 200.
pageToken

string

Opcjonalnie: Wartość nextPageToken zwrócona z poprzedniego żądania List (jeśli występuje). Jeśli szczegółowość agregacji to DAILY, token strony będzie zakodowaną datą + „/” + nazwą danych. Jeśli poziom agregacji to OVERALL, token strony będzie zakodowaną nazwą danych.
aggregationGranularity

enum (AggregationGranularity)

Opcjonalnie: Stopień szczegółowości, na którym mają być agregowane statystyki. Jeśli nie określono inaczej, domyślnie jest to DAILY.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu QueryDomainStatsResponse.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.