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

16 進数文字列で表される、ラベルのテキストの色。このフィールドは、ラベルの色を設定するために必要です。#e0,000, #434347,8a8d870,e1,000,100,000,100,000,000,000,000,000,000,000,000,000,100,000,000
backgroundColor

string

16 進数文字列 #RRGGBB で表される背景色（例: #000000）。このフィールドは、ラベルの色を設定するために必要です。#e0,000, #434347,8a8d870,e1,000,100,000,100,000,000,000,000,000,000,000,000,000,100,000,000

Methods

create

 新しいラベルを作成します。

delete

 指定したラベルを即時かつ完全に削除し、ラベルが適用されているメッセージやスレッドから削除します。

get

 指定されたラベルを取得します。

list

 ユーザーのメールボックス内のすべてのラベルを一覧表示します。

patch

 指定したラベルにパッチを適用します。

update

 指定したラベルを更新します。