Method: customers.quarantines.list

فهرستی از همه قرنطینه‌های تعریف‌شده توسط این مشتری را برمی‌گرداند.

درخواست HTTP

GET https://mailadminquarantine.googleapis.com/v1/{parent=customers/*}/quarantines

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

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

پارامترها
parent

string

الزامی. منبع اصلی که مشتری است.

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

پارامترها
pageSize

integer

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

string

اختیاری. مقدار nextPageToken از درخواست «فهرست» قبلی برگردانده شد.

متن درخواست

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای [quarantines.list][].

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

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

object (Quarantine)

فهرست قرنطینه‌های تعریف‌شده توسط این مشتری.
nextPageToken

string

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

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

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

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

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