REST Resource: users.labels

资源：标签

标签用于对用户邮箱中的邮件和会话进行分类。用户邮箱支持的标签数上限为 10000。

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 的标签。

消息列表可见性

枚举
show 在邮件列表中显示标签。
hide 不在邮件列表中显示标签。

标签列表可见性

枚举
labelShow 在标签列表中显示相应标签。
labelShowIfUnread 显示带有该标签的未读邮件。
labelHide 不在标签列表中显示标签。

类型

枚举
system Gmail 创建的标签。
user 用户或应用创建的自定义标签。

颜色

JSON 表示法 
{
  "textColor": string,
  "backgroundColor": string
}
字段
textColor

string

标签的文本颜色，表示为十六进制字符串。此字段是必填字段，用于设置标签的颜色。。
backgroundColor

string

以十六进制字符串 #RRGGBB（例如 #000000）表示的背景颜色。此字段是必填字段，用于设置标签的颜色。。

方法

create

 创建新标签。

delete

 立即永久删除指定标签，并将其从所有已应用的标签和邮件中移除。

get

 获取指定的标签。

list

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

patch

 修补指定的标签。

update

 更新指定的标签。