Method: domainStats.batchQuery

Mengeksekusi batch permintaan QueryDomainStats untuk beberapa domain. Menampilkan PERMISSION_DENIED jika Anda tidak memiliki izin untuk mengakses DomainStats untuk salah satu domain yang diminta.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Kolom
requests[]

object (QueryDomainStatsRequest)

Wajib. Daftar permintaan kueri individual. Setiap permintaan dapat ditujukan untuk domain yang berbeda. Maksimal 100 permintaan dapat disertakan dalam satu batch.

Isi respons

Pesan respons untuk domainStats.batchQuery.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Kolom
results[]

object (BatchQueryDomainStatsResult)

Daftar respons, satu untuk setiap kueri di BatchQueryDomainStatsRequest. Urutan respons akan sesuai dengan urutan permintaan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.

QueryDomainStatsRequest

Pesan permintaan untuk QueryDomainStats.

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

string

Wajib. Nama resource induk tempat statistik dikueri. Format: domains/{domain}
metricDefinitions[]

object (MetricDefinition)

Wajib. Metrik spesifik yang akan dikueri. Anda dapat menentukan nama kustom untuk setiap metrik, yang akan digunakan dalam respons.
timeQuery

object (TimeQuery)

Wajib. Rentang waktu atau tanggal tertentu untuk mengambil metrik.
pageSize

integer

Opsional. Jumlah maksimum resource DomainStats yang akan ditampilkan dalam respons. Server mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, nilai default 10 akan digunakan. Nilai maksimumnya adalah 200.
pageToken

string

Opsional. Nilai nextPageToken yang ditampilkan dari permintaan Daftar sebelumnya, jika ada. Jika perincian agregasi adalah HARIAN, token halaman akan berupa tanggal yang dienkode + "/" + nama metrik. Jika perincian agregasi adalah OVERALL, token halaman akan menjadi nama metrik yang dienkode.
aggregationGranularity

enum (AggregationGranularity)

Opsional. Tingkat perincian untuk mengagregasi statistik. Jika tidak ditentukan, setelan defaultnya adalah DAILY.

BatchQueryDomainStatsResult

Mewakili hasil satu QueryDomainStatsRequest dalam batch.

Representasi 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.
}
Kolom
Kolom union result. Hasil kueri individual. result hanya dapat berupa salah satu dari berikut:
response

object (QueryDomainStatsResponse)

Respons yang berhasil untuk kueri individual.
error

object (Status)

Status error jika kueri individual gagal.

Status

Jenis Status menentukan model error logis yang cocok untuk berbagai lingkungan pemrograman, termasuk REST API dan RPC API. Jenis error ini digunakan oleh gRPC. Setiap pesan Status berisi tiga bagian data: kode error, pesan error, dan detail error.

Anda dapat mengetahui selengkapnya tentang model error ini dan penanganannya di Panduan Desain API.

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

integer

Kode status yang harus berupa nilai enum dari google.rpc.Code.
message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.
details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.