Method: domainStats.batchQuery

Wykonuje partię żądań QueryDomainStats dotyczących wielu domen. Zwraca błąd PERMISSION_DENIED, jeśli nie masz uprawnień dostępu do DomainStats w przypadku żadnej z żądanych domen.

Żądanie HTTP

POST https://gmailpostmastertools.googleapis.com/v2/domainStats:batchQuery

Adres URL używa składni transkodowania gRPC.

Treść żądania

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

Zapis JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Pola
requests[]

object (QueryDomainStatsRequest)

Wymagane. Lista pojedynczych próśb o zapytanie. Każda prośba może dotyczyć innej domeny. Jeden pakiet może zawierać maksymalnie 100 żądań.

Treść odpowiedzi

Komunikat odpowiedzi dla domainStats.batchQuery.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Pola
results[]

object (BatchQueryDomainStatsResult)

Lista odpowiedzi, po jednej dla każdego zapytania w żądaniu BatchQueryDomainStatsRequest. Kolejność odpowiedzi będzie odpowiadać kolejności żądań.

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.

QueryDomainStatsRequest

Wiadomość z prośbą o wywołanie funkcji QueryDomainStats.

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

string

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

object (MetricDefinition)

Wymagane. Konkretne dane, o które chcesz zapytać. 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ż tę 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.

BatchQueryDomainStatsResult

Reprezentuje wynik pojedynczego zapytania QueryDomainStatsRequest w ramach pakietu.

Zapis JSON 
{

  // Union field result can be only one of the following:
  "response": {
    object (QueryDomainStatsResponse)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Pola
Pole zbiorcze result. Wynik pojedynczego zapytania. result może mieć tylko jedną z tych wartości:
response

object (QueryDomainStatsResponse)

Odpowiedź na pojedyncze zapytanie w przypadku powodzenia.
error

object (Status)

Stan błędu, jeśli poszczególne zapytanie nie powiodło się.

Stan

Typ Status definiuje model błędu logicznego, który jest odpowiedni dla różnych środowisk programistycznych, w tym interfejsów API typu REST i RPC. Jest używany przez gRPC. Każdy komunikat Status zawiera 3 rodzaje danych: kod błędu, komunikat o błędzie i szczegóły błędu.

Więcej informacji o tym modelu błędów i sposobie pracy z nim znajdziesz w przewodniku API Design Guide.

Zapis JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Pola
code

integer

Kod stanu, który powinien być wartością wyliczeniową google.rpc.Code.
message

string

Komunikat o błędzie widoczny dla programisty, który powinien być w języku angielskim. Wszelkie komunikaty o błędach dla użytkowników powinny być zlokalizowane i wysyłane w polu google.rpc.Status.details lub zlokalizowane przez klienta.
details[]

object

Lista wiadomości zawierających szczegóły błędu. Na potrzeby interfejsów API dostępny jest wspólny zestaw typów wiadomości.