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)

標籤的擁有者類型。使用者標籤是由使用者建立,可由使用者修改及刪除,也可套用至任何郵件或討論串。系統標籤是在內部建立,無法新增、修改或刪除。在某些情況下,你或許可以對郵件和討論串套用系統標籤,或是從郵件和討論串中移除系統標籤,但不保證一定會如此。舉例來說,使用者可以為郵件和討論串套用及移除 INBOXUNREAD 標籤,但無法為郵件或討論串套用或移除 DRAFTSSENT 標籤。

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

標籤的文字顏色,以十六進位字串表示。您必須填寫這個欄位,才能設定標籤的顏色。#cfad47,ca4,c72016,c73,016,182,123,162,123,162,22562-54-527,120.92722224422-842702022c24222222 分別 3443220220222882 服務 88 記錄-8 合=2282888888228882888088088989289892889298989898989298989248924898925254552488855559253488525252545569868525455525645525256252562525256252532565255552566 級

backgroundColor

string

背景顏色以十六進位字串 #RRGGBB (例如 #000000) 表示。您必須填寫這個欄位,才能設定標籤的顏色。#ffad47,ca4,c72016,016,082,123,162,123,2256,252,25.92,123,2252727275

方法

create

建立新標籤。

delete

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

get

取得指定標籤。

list

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

patch

修補指定的標籤。

update

更新指定標籤。