REST Resource: users.labels

資源：Label

標籤的用途是將使用者信箱中的郵件和討論串分類。使用者信箱支援的標籤數量上限為 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

標籤的不可變更 ID。
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

列舉
show 在郵件清單中顯示標籤。
hide 不要在郵件清單中顯示標籤。

LabelListVisibility

列舉
labelShow 在標籤清單中顯示標籤。
labelShowIfUnread 如果有任何未讀取的郵件具有該標籤，則顯示該標籤。
labelHide 不在標籤清單中顯示標籤。

類型

列舉
system Gmail 建立的標籤。
user 使用者或應用程式建立的自訂標籤。

顏色

JSON 表示法 
{
  "textColor": string,
  "backgroundColor": string
}
欄位
textColor

string

標籤的文字顏色，以十六進位字串表示。必須填寫此欄位，才能設定標籤的顏色。
backgroundColor

string

以十六進位字串 #RRGGBB 表示的背景顏色 (例如 #000000)。必須填寫此欄位，才能設定標籤的顏色。

方法

create

 建立新標籤。

delete

 立即永久刪除指定標籤，並將該標籤從已套用的郵件和討論串中移除。

get

 取得指定標籤。

list

 列出使用者信箱中的所有標籤。

patch

 修補指定標籤。

update

 更新指定標籤。