Method: domains.domainStats.query

Mengambil daftar statistik domain untuk domain dan jangka waktu tertentu. Menampilkan PERMISSION_DENIED jika Anda tidak memiliki izin untuk mengakses DomainStats untuk domain.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Kolom
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.

Isi respons

Jika berhasil, isi respons memuat instance QueryDomainStatsResponse.

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.