Method: users.settings.filters.list

فیلترهای پیام یک کاربر جیمیل را فهرست می کند.

درخواست HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters

URL از دستور GRPC Transcoding استفاده می کند.

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

مولفه های
userId

string

آدرس ایمیل کاربر. مقدار ویژه "me" را می توان برای نشان دادن کاربر تأیید شده استفاده کرد.

درخواست بدن

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

بدن پاسخگو

پاسخ برای روش filters.list.

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

نمایندگی JSON
{
  "filter": [
    {
      object (Filter)
    }
  ]
}
زمینه های
filter[]

object ( Filter )

لیست فیلترهای یک کاربر

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly

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