REST Resource: users.labels

リソース: Label

ラベルは、ユーザーのメールボックス内のメールやスレッドを分類するために使用されます。ユーザーのメールボックスでサポートされるラベルの最大数は 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

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