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

标签的文本颜色，以十六进制字符串表示。必须填写此字段，才能设置标签的颜色。您只允许使用下面这组预定义的颜色值。以下这组预定义颜色值集中了以下这组预定义的颜色值，但只允许使用以下这组预定义的以下颜色值：
#0000000000、#434434664474476 之前预定义的这组颜色值
backgroundColor

string

以十六进制字符串 #RRGGBB 表示的背景颜色（例如 #000000）。必须填写此字段，才能设置标签的颜色。您只允许使用下面这组预定义的颜色值。以下这组预定义颜色值集中了以下这组预定义的颜色值。以下这组预定义的颜色值仅允许您允许使用以下这组预定义的颜色值：
#0000000000、#434434436444447676 之前预设的这组预定义颜色值。

方法

create

 创建新标签。

delete

 立即永久删除指定标签，并将其从应用了此标签的所有邮件/消息串中移除。

get

 获取指定的标签。

list

 列出用户邮箱中的所有标签。

patch

 修补指定标签。

update

 更新指定的标签。