REST Resource: users.labels

منبع: برچسب

برچسب‌ها برای دسته‌بندی پیام‌ها و موضوعات درون صندوق پستی کاربر استفاده می‌شوند. حداکثر تعداد برچسب‌های پشتیبانی‌شده برای صندوق پستی یک کاربر ۱۰۰۰۰ است.

نمایش JSON 
{
  "id": string,
  "name": string,
  "messageListVisibility": enum (MessageListVisibility),
  "labelListVisibility": enum (LabelListVisibility),
  "type": enum (Type),
  "messagesTotal": integer,
  "messagesUnread": integer,
  "threadsTotal": integer,
  "threadsUnread": integer,
  "color": {
    object (Color)
  }
}
فیلدها
id

string

شناسه تغییرناپذیر برچسب.

name

string

نام نمایشی برچسب.

messageListVisibility

enum ( MessageListVisibility )

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

labelListVisibility

enum ( LabelListVisibility )

قابلیت مشاهده برچسب در فهرست برچسب‌ها در رابط وب جیمیل.

type

enum ( Type )

نوع مالک برای برچسب. برچسب‌های کاربر توسط کاربر ایجاد می‌شوند و می‌توانند توسط کاربر اصلاح و حذف شوند و می‌توانند برای هر پیام یا رشته‌ای اعمال شوند. برچسب‌های سیستم به صورت داخلی ایجاد می‌شوند و نمی‌توان آنها را اضافه، اصلاح یا حذف کرد. برچسب‌های سیستم ممکن است تحت برخی شرایط بتوانند برای پیام‌ها و رشته‌ها اعمال یا از آنها حذف شوند، اما این تضمین شده نیست. به عنوان مثال، کاربران می‌توانند برچسب‌های INBOX و UNREAD را از پیام‌ها و رشته‌ها اعمال و حذف کنند، اما نمی‌توانند برچسب‌های DRAFTS یا SENT را از پیام‌ها یا رشته‌ها اعمال یا حذف کنند.

messagesTotal

integer

تعداد کل پیام‌های دارای برچسب.

messagesUnread

integer

تعداد پیام‌های خوانده نشده با برچسب.

threadsTotal

integer

تعداد کل نخ‌های دارای برچسب.

threadsUnread

integer

تعداد تاپیک‌های خوانده نشده با برچسب.

color

object ( Color )

رنگی که به برچسب اختصاص داده می‌شود. رنگ فقط برای برچسب‌هایی که type آنها روی user تنظیم شده است، در دسترس است.

قابلیت مشاهده لیست پیام

انوم‌ها
show نمایش برچسب در لیست پیام‌ها.
hide برچسب را در لیست پیام‌ها نشان نده.

قابلیت مشاهده لیست برچسب

انوم‌ها
labelShow برچسب را در لیست برچسب‌ها نمایش بده.
labelShowIfUnread اگر پیام‌های خوانده‌نشده‌ای با آن برچسب وجود دارد، آن برچسب را نمایش دهید.
labelHide برچسب را در لیست برچسب‌ها نشان نده.

نوع

انوم‌ها
system برچسب‌های ایجاد شده توسط Gmail.
user برچسب‌های سفارشی ایجاد شده توسط کاربر یا برنامه.

رنگ

نمایش JSON 
{
  "textColor": string,
  "backgroundColor": string
}
فیلدها
textColor

string

رنگ متن برچسب، که به صورت رشته هگز نمایش داده می‌شود. این فیلد برای تنظیم رنگ برچسب الزامی است. فقط مجموعه مقادیر رنگ از پیش تعریف شده زیر مجاز هستند:
#000000، #434343، #666666، #999999، #cccccc، #efefef، #f3f3f3، #ffffff، #fb4c2f، #ffad47، #fad165، #16a766، #43d692، #43d692، #2a4، #4a47 #f6c5be، #ffe6c7، #fef1d1، #b9e4d0، #c6f3de، #c9daf8، #e4d7f5، #fcdee8، #efa093، #ffd6a2، #fce8b3، #89d3b2، #a0eac2fc، #1، #a0eac2fc، #4،4، #e66550، #ffbc6b، #fcda83، #44b984، #68dfa9، #6d9eeb، #b694e8، #f7a7c0، #cc3a21، #eaa041، #f2c960، #149e60، #3dc789، #3dc789، #3dc789، #3dc707 #ac2b16، #cf8933، #d5ae49، #0b804b، #2a9c68، #285bac، #653e9b، #b65775، #822111، #a46a21، #aa8831، #076234، #076234، #834، #17 #83334c، #464646، #e7e7e7، #0d3472، #b6cff5، #0d3b44، #98d7e4، #3d188e، #e3d7ff، #711a36، #fbd3e0، #8a1c0a، #f2b2a8، #7a2e0b، #5،4، #7a2e0b، #5،4 #594c05، #fbe983، #684e07، #fdedc1، #0b4f30، #b3efd3، #04502e، #a2dcc1، #c2c2c2، #4986e7، #2da2bb، #b99aff، #994 #ff34، #994aff34، #994. #662e37، #ebdbde، #cca6ac، #094228، #42d692، #16a765

backgroundColor

string

رنگ پس‌زمینه به صورت رشته هگز #RRGGBB (مثلاً #000000) نمایش داده می‌شود. این فیلد برای تنظیم رنگ برچسب الزامی است. فقط مجموعه مقادیر رنگ از پیش تعریف شده زیر مجاز هستند:
#000000، #434343، #666666، #999999، #cccccc، #efefef، #f3f3f3، #ffffff، #fb4c2f، #ffad47، #fad165، #16a766، #43d692، #43d692، #2a4، #4a47 #f6c5be، #ffe6c7، #fef1d1، #b9e4d0، #c6f3de، #c9daf8، #e4d7f5، #fcdee8، #efa093، #ffd6a2، #fce8b3، #89d3b2، #a0eac2fc، #1، #a0eac2fc، #4،4، #e66550، #ffbc6b، #fcda83، #44b984، #68dfa9، #6d9eeb، #b694e8، #f7a7c0، #cc3a21، #eaa041، #f2c960، #149e60، #3dc789، #3dc789، #3dc789، #3dc707 #ac2b16، #cf8933، #d5ae49، #0b804b، #2a9c68، #285bac، #653e9b، #b65775، #822111، #a46a21، #aa8831، #076234، #076234، #834، #17 #83334c، #464646، #e7e7e7، #0d3472، #b6cff5، #0d3b44، #98d7e4، #3d188e، #e3d7ff، #711a36، #fbd3e0، #8a1c0a، #f2b2a8، #7a2e0b، #5،4، #7a2e0b، #5،4 #594c05، #fbe983، #684e07، #fdedc1، #0b4f30، #b3efd3، #04502e، #a2dcc1، #c2c2c2، #4986e7، #2da2bb، #b99aff، #994 #ff34، #994aff34، #994. #662e37، #ebdbde، #cca6ac، #094228، #42d692، #16a765

روش‌ها

create

 یک برچسب ایجاد می‌کند.

delete

 بلافاصله و برای همیشه برچسب مشخص شده را حذف می‌کند و آن را از هرگونه پیام و رشته‌ای که روی آن اعمال شده است، حذف می‌کند.

get

 برچسب مشخص شده را دریافت می‌کند.

list

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

patch

 برچسب مشخص شده را وصله بزنید.

update

 برچسب مشخص شده را به‌روزرسانی می‌کند.