Method: customers.quarantinedMessages.search

پیام‌های قرنطینه‌شده را بااستفاده از پُرسمان‌های جستجوی خاص جستجو می‌کند.

درخواست HTTP

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

این نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
parent

string

الزامی. منبع اصلی که مالک این مجموعه پیام‌ها است. قالب: customers/{customer_id}

متن درخواست

بدنه درخواست حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
فیلدها
pageSize

integer

اختیاری. حداکثر تعداد موارد برای برگرداندن.
pageToken

string

اختیاری. مقدار nextPageToken که از تماس جستجوی قبلی برگردانده شده است.
filter

string

اختیاری. نتایج را براساس وضعیت، جهت، یا قرنطینه فیلتر کنید. این فیلتر شامل سه بخش اختیاری است: status، direction، و quarantine که همیشه بااستفاده از عملگر منطقی AND به هم متصل می‌شوند. عبارت فیلتر باید از نحو AIP-160 پیروی کند. مثال: «status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1»
query

string

اختیاری. پرسمان جستجوی مختص Gmail در قالب پرسمان Caribou.

بدنه پاسخ

پیام پاسخ برای [quarantinedMessages.search][].

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
فیلدها
quarantinedMessages[]

object (QuarantinedMessage)

فهرست پیام‌های قرنطینه‌شده مطابق با پُرسمان جستجو.
nextPageToken

string

نشانه‌ای برای بازیابی صفحه بعدی نتایج.
unreachable[]

string

حساب‌هایی که سرویس نتوانسته است پیام‌های قرنطینه‌شده را برای آن‌ها بازیابی کند.

دامنه‌های مجوز

به یکی از دامنه‌های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، راهنمای مجوز را ببینید.