Method: users.labels.list

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

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .