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 進文字列で表されます）。このフィールドは、ラベルの色を設定するために必要です。使用できる色値は、次の事前定義されたセットのみです。
#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

16 進文字列 #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

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