Method: customers.quarantinedMessages.search

Menelusuri pesan yang dikarantina menggunakan kueri penelusuran tertentu.

Permintaan HTTP

POST https://mailadminquarantine.googleapis.com/v1/{parent=customers/*}/quarantinedMessages:search

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Resource induk, yang memiliki kumpulan pesan ini. Format: customers/{customer_id}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Kolom
pageSize

integer

Opsional. Jumlah maksimum item untuk ditampilkan.
pageToken

string

Opsional. Nilai nextPageToken yang ditampilkan dari panggilan penelusuran sebelumnya.
filter

string

Opsional. Filter hasil menurut status, arah, atau karantina. Filter ini mencakup tiga bagian opsional: status, direction, dan quarantine, yang selalu terhubung menggunakan operator logis AND. Ekspresi filter harus mengikuti sintaksis AIP-160. Contoh: "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

Opsional. Kueri penelusuran khusus Gmail dalam format kueri Caribou.

Isi respons

Pesan respons untuk [quarantinedMessages.search][].

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Kolom
quarantinedMessages[]

object (QuarantinedMessage)

Daftar pesan yang dikarantina yang cocok dengan kueri penelusuran.
nextPageToken

string

Token untuk mengambil halaman hasil berikutnya.
unreachable[]

string

Akun yang pesan karantinanya tidak dapat diambil oleh layanan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/gmail.admin.quarantine
  • https://www.googleapis.com/auth/gmail.admin.quarantine.readonly

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.