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

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

backgroundColor

string

צבע הרקע מיוצג כמחרוזת הקסדצימלית #RRGGBB (לדוגמה #000000). השדה הזה נדרש כדי להגדיר את הצבע של תווית. אפשר להשתמש רק בקבוצה מוגדרת מראש ה שהוגדרה מראש של ערכי צבעי צבע שהוגדרו מראש:
!
באפשרותך להשתמש רק בקבוצה מוגדרת

שיטות

create

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

delete

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

get

קבלת התווית שצוינה.

list

בתיבת הדואר הנכנס של המשתמש מופיעה רשימה של כל התוויות בתיבת הדואר של המשתמש.

patch

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

update

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