Method: users.labels.list

تمام برچسب های موجود در صندوق پستی کاربر را فهرست می کند.

درخواست HTTP

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

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

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

مولفه های
userId

string

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

درخواست بدن

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

بدن پاسخگو

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

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

object ( Label )

لیست برچسب ها توجه داشته باشید که هر منبع برچسب فقط شامل id ، name ، messageListVisibility ، labelListVisibility و type است. روش labels.get می‌تواند جزئیات برچسب اضافی را واکشی کند.

محدوده مجوز

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

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.labels
  • https://www.googleapis.com/auth/gmail.metadata

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