REST Resource: users.labels

משאב: תווית

תוויות משמשות לסווג הודעות ושרשורות בתיבת הדואר של המשתמש. מספר התוויות המקסימלי שנתמך בתיבת הדואר של משתמש הוא 10,000.

ייצוג ב-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

טיפוסים בני מנייה (enum)
show הצגת התווית ברשימת ההודעות.
hide לא להציג את התווית ברשימת ההודעות.

LabelListVisibility

טיפוסים בני מנייה (enum)
labelShow הצגת התווית ברשימת התווית.
labelShowIfUnread הצגת התווית אם יש הודעות שלא נקראו עם התווית הזו.
labelHide לא להציג את התווית ברשימת התוויות.

סוג

טיפוסים בני מנייה (enum)
system תוויות שנוצרו על ידי Gmail.
user תוויות בהתאמה אישית שנוצרו על ידי המשתמש או האפליקציה.

צבע

ייצוג ב-JSON 
{
  "textColor": string,
  "backgroundColor": string
}
שדות
textColor

string

צבע הטקסט של התווית, שמוצג כמחרוזת הקסדצימלית. השדה הזה נדרש כדי להגדיר את הצבע של תווית. מותר להשתמש רק בערכים הבאים של ערכי צבעים שהוגדרו מראש:
#000000,‏ #434343,‏ #666666,‏ #999999,‏ #cccccc,‏ #efefef,‏ #f3f3f3,‏ #ffffff,‏ #fb4c2f,‏ #ffad47,‏ #fad165,‏ #16a766,‏ #43d692,‏ #4a86e8,‏ #a479e2,‏ #f691b3,‏ #f6c5be,‏ #ffe6c7,‏ #fef1d1,‏ #b9e4d0,‏ #c6f3de,‏ #c9daf8,‏ #e4d7f5,‏ #fcdee8,‏ #efa093,‏ #ffd6a2,‏ #fce8b3,‏ #89d3b2,‏ #a0eac9,‏ #a4c2f4,‏ #d0bcf1,‏ #fbc8d9,‏ #e66550,‏ #ffbc6b,‏ #fcda83,‏ #44b984,‏ #68dfa9,‏ #6d9eeb,‏ #b694e8,‏ #f7a7c0,‏ #cc3a21,‏ #eaa041,‏ #f2c960,‏ #149e60,‏ #3dc789,‏ #3c78d8,‏ #8e63ce,‏ #e07798,‏ #ac2b16,‏ #cf8933,‏ #d5ae49,‏ #0b804b,‏ #2a9c68,‏ #285bac,‏ #653e9b,‏ #b65775,‏ #822111,‏ #a46a21,‏ #aa8831,‏ #076239,‏ #1a764d,‏ #1c4587,‏ #41236d,‏ #83334c #464646,‏ #e7e7e7,‏ #0d3472,‏ #b6cff5,‏ #0d3b44,‏ #98d7e4,‏ #3d188e,‏ #e3d7ff,‏ #711a36,‏ #fbd3e0,‏ #8a1c0a,‏ #f2b2a8,‏ #7a2e0b,‏ #ffc8af,‏ #7a4706,‏ #ffdeb5,‏ #594c05,‏ #fbe983,‏ #684e07,‏ #fdedc1,‏ #0b4f30,‏ #b3efd3,‏ #04502e,‏ #a2dcc1,‏ #c2c2c2,‏ #4986e7,‏ #2da2bb,‏ #b99aff,‏ #994a64,‏ #f691b2,‏ #ff7537,‏ #ffad46,‏ #662e37,‏ #ebdbde,‏ #cca6ac,‏ #094228,‏ #42d692,‏ #16a765
backgroundColor

string

צבע הרקע מיוצג כמחרוזת הקסדצימלית #RRGGBB (למשל #000000). השדה הזה נדרש כדי להגדיר את הצבע של תווית. מותר להשתמש רק בערכים הבאים של ערכי צבעים שהוגדרו מראש:
#000000,‏ #434343,‏ #666666,‏ #999999,‏ #cccccc,‏ #efefef,‏ #f3f3f3,‏ #ffffff,‏ #fb4c2f,‏ #ffad47,‏ #fad165,‏ #16a766,‏ #43d692,‏ #4a86e8,‏ #a479e2,‏ #f691b3,‏ #f6c5be,‏ #ffe6c7,‏ #fef1d1,‏ #b9e4d0,‏ #c6f3de,‏ #c9daf8,‏ #e4d7f5,‏ #fcdee8,‏ #efa093,‏ #ffd6a2,‏ #fce8b3,‏ #89d3b2,‏ #a0eac9,‏ #a4c2f4,‏ #d0bcf1,‏ #fbc8d9,‏ #e66550,‏ #ffbc6b,‏ #fcda83,‏ #44b984,‏ #68dfa9,‏ #6d9eeb,‏ #b694e8,‏ #f7a7c0,‏ #cc3a21,‏ #eaa041,‏ #f2c960,‏ #149e60,‏ #3dc789,‏ #3c78d8,‏ #8e63ce,‏ #e07798,‏ #ac2b16,‏ #cf8933,‏ #d5ae49,‏ #0b804b,‏ #2a9c68,‏ #285bac,‏ #653e9b,‏ #b65775,‏ #822111,‏ #a46a21,‏ #aa8831,‏ #076239,‏ #1a764d,‏ #1c4587,‏ #41236d,‏ #83334c #464646,‏ #e7e7e7,‏ #0d3472,‏ #b6cff5,‏ #0d3b44,‏ #98d7e4,‏ #3d188e,‏ #e3d7ff,‏ #711a36,‏ #fbd3e0,‏ #8a1c0a,‏ #f2b2a8,‏ #7a2e0b,‏ #ffc8af,‏ #7a4706,‏ #ffdeb5,‏ #594c05,‏ #fbe983,‏ #684e07,‏ #fdedc1,‏ #0b4f30,‏ #b3efd3,‏ #04502e,‏ #a2dcc1,‏ #c2c2c2,‏ #4986e7,‏ #2da2bb,‏ #b99aff,‏ #994a64,‏ #f691b2,‏ #ff7537,‏ #ffad46,‏ #662e37,‏ #ebdbde,‏ #cca6ac,‏ #094228,‏ #42d692,‏ #16a765

Methods

create

 יצירת תווית חדשה.

delete

 המחיקה מיידית ופונקציית המחיקה הסופית של התווית שצוינה, והסרת התווית מכל ההודעות והשרשורים שבהם היא חלה.

get

 אחזור התווית שצוינה.

list

 הצגת כל התוויות בתיבה של המשתמש.

patch

 תיקון התווית שצוינה.

update

 עדכון התווית שצוינה.