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

标签的文本颜色，以十六进制字符串表示。必须填写此字段，才能设置标签的颜色。只能使用下面这组预定义的颜色值, #0000000, #0000000, #4343e6e#9e6e#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6,#b9a
backgroundColor

string

以十六进制字符串 #RRGGBB 表示的背景颜色（例如 #000000）。必须填写此字段，才能设置标签的颜色。只能使用下面这组预定义的颜色值, #0000000, #0000000, #4343e6e#9e6e#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6#9e6,#b9a

方法

create

 创建新标签。

delete

 立即永久删除指定标签，并将其从应用了该标签的任何邮件和会话中移除。

get

 获取指定的标签。

list

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

patch

 修补指定的标签。

update

 更新指定的标签。