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

標籤的文字顏色，以十六進位字串表示。如要設定標籤的顏色，則必須填入這個欄位。僅允許使用下列預先定義的顏色值：
#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

方法

create

 建立新標籤。

delete

 立即永久刪除指定的標籤，並從套用的所有訊息和會話中移除。

get

 取得指定的標籤。

list

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

patch

 修補指定的標籤。

update

 更新指定的標籤。