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

标签的不可变 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

 更新指定的标签。