Method: domains.trafficStats.list

Menampilkan daftar statistik traffic untuk semua hari yang tersedia. Menampilkan PERMISSION_DENIED jika pengguna tidak memiliki izin untuk mengakses TrafficStats untuk domain.

Permintaan HTTP

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Nama resource domain yang statistik lalu lintasnya ingin dicantumkan. Domainnya akan berformat domains/{domain_name}, dengan domain_name adalah nama domain yang sepenuhnya memenuhi syarat.

Parameter kueri

Parameter
startDate

object (Date)

Hari paling awal metrik untuk mengambil metrik inklusif. startDate dan endDate harus ditentukan atau keduanya tidak ditentukan. Jika hanya satu yang ditentukan, atau endDate lebih awal dari startDate, maka INVALID_ARGUMENT akan ditampilkan.

endDate

object (Date)

Metrik hari terakhir untuk diambil secara eksklusif. startDate dan endDate harus ditentukan atau keduanya tidak ditentukan. Jika hanya satu yang ditentukan, atau endDate lebih awal dari startDate, maka INVALID_ARGUMENT akan ditampilkan.

pageSize

integer

Ukuran halaman yang diminta. Server mungkin menampilkan lebih sedikit TrafficStats dari yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.

pageToken

string

Nilai nextPageToken yang ditampilkan dari permintaan Daftar sebelumnya, jika ada. Ini adalah nilai ListTrafficStatsResponse.next_page_token yang ditampilkan dari panggilan sebelumnya ke metode trafficStats.list.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk trafficStats.list.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
Kolom
trafficStats[]

object (TrafficStats)

Daftar TrafficStats.

nextPageToken

string

Token untuk mengambil halaman hasil berikutnya, atau kosong jika tidak ada lagi hasil dalam daftar.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

Tanggal

Mewakili seluruh atau sebagian tanggal kalender, seperti ulang tahun. Waktu dan zona waktu ditentukan di tempat lain atau tidak signifikan. Tanggal ini relatif terhadap Kalender Gregorian. ID ini dapat mewakili salah satu dari hal berikut:

  • Tanggal lengkap, dengan nilai tahun, bulan, dan hari bukan nol.
  • Bulan dan hari, dengan tahun nol (misalnya, hari jadi).
  • Tahun saja, dengan bulan nol dan hari nol.
  • Tahun dan bulan, dengan hari nol (misalnya, tanggal habis masa berlaku kartu kredit).

Jenis terkait:

Representasi JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Kolom
year

integer

Tahun dalam tanggal. Harus dari 1 hingga 9999, atau 0 untuk menentukan tanggal tanpa tahun.

month

integer

Bulan dalam setahun. Harus dari 1 hingga 12, atau 0 untuk menentukan tahun tanpa bulan dan hari.

day

integer

Hari dalam sebulan. Harus dari 1 hingga 31 dan berlaku untuk tahun dan bulan, atau 0 untuk menentukan tahun saja atau tahun dan bulan jika hari dianggap tidak signifikan.