REST Resource: users.labels

منبع: برچسب

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

نمایندگی 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 )

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

labelListVisibility

enum ( LabelListVisibility )

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

type

enum ( Type )

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

messagesTotal

integer

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

messagesUnread

integer

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

threadsTotal

integer

تعداد کل رشته ها با برچسب.

threadsUnread

integer

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

color

object ( Color )

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

MessageListVisibility

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

LabelListVisibility

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

تایپ کنید

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

رنگ

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

string

رنگ متن برچسب، به صورت رشته هگزا نشان داده شده است. این فیلد برای تنظیم رنگ برچسب لازم است. فقط مجموعه ای از مقادیر رنگی از پیش تعریف شده زیر مجاز است:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #43d692, #43d692, #43d692, #4a698, #4a8 , #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c5,#b6,# ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3dc789, #3dc7,#8,3,#,# f8933، #d5ae49، #0b804b، #2a9c68، #285bac، #653e9b، #b65775، #822111، #a46a21، #aa8831، #076239، #1a764d، #1c4233 #4، #4e 7، #0d3472، #b6cff5، #0d3b44، #98d7e4، #3d188e، #e3d7ff، #711a36، #fbd3e0، #8a1c0a، #f2b2a8، #7a2e0b، #ffc8af، #7a4706، #7a4705، #508، #59، #ffdeb dedc1 , #0b4f30، #b3efd3، #04502e، #a2dcc1، #c2c2c2، #4986e7، #2da2bb، #b99aff، #994a64، #f691b2، #ff7537، #ffad46، #6#2c2c2، #4986e7، #994a64، #f691b2، #ff7537، #ffad46، #6#2c2c2، #662e 42d692، #16a765

backgroundColor

string

رنگ پس‌زمینه به‌عنوان رشته هگزا #RRGGBB (سابق #000000) نشان داده می‌شود. این فیلد برای تنظیم رنگ برچسب لازم است. فقط مجموعه ای از مقادیر رنگی از پیش تعریف شده زیر مجاز است:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #43d692, #43d692, #43d692, #4a698, #4a8 , #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c5,#b6,# ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3dc789, #3dc7,#8,3,#,# f8933، #d5ae49، #0b804b، #2a9c68، #285bac، #653e9b، #b65775، #822111، #a46a21، #aa8831، #076239، #1a764d، #1c4233 #4، #4e 7، #0d3472، #b6cff5، #0d3b44، #98d7e4، #3d188e، #e3d7ff، #711a36، #fbd3e0، #8a1c0a، #f2b2a8، #7a2e0b، #ffc8af، #7a4706، #7a4705، #508، #59، #ffdeb dedc1 , #0b4f30، #b3efd3، #04502e، #a2dcc1، #c2c2c2، #4986e7، #2da2bb، #b99aff، #994a64، #f691b2، #ff7537، #ffad46، #6#2c2c2، #4986e7، #994a64، #f691b2، #ff7537، #ffad46، #6#2c2c2، #662e 42d692، #16a765

روش ها

create

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

delete

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

get

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

list

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

patch

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

update

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