リソース: ラベル
ラベルは、ユーザーのメールボックス内のメッセージやスレッドを分類するために使用されます。ユーザーのメールボックスでサポートされるラベルの最大数は 10,000 です。
JSON 表現 |
---|
{ "id": string, "name": string, "messageListVisibility": enum ( |
フィールド | |
---|---|
id |
ラベルの不変の ID。 |
name |
ラベルの表示名。 |
messageListVisibility |
Gmail ウェブ インターフェースのメール リストで、このラベルが付けられたメールの公開設定。 |
labelListVisibility |
Gmail のウェブ インターフェースのラベルリストでのラベルの表示。 |
type |
ラベルのオーナータイプ。ユーザーラベルはユーザーが作成し、ユーザーが変更、削除したり、任意のメッセージやスレッドに適用したりできます。システムラベルは内部で作成され、追加、変更、削除はできません。状況によっては、メッセージやスレッドにシステムラベルを適用したり、システムラベルを削除したりできますが、保証はできません。たとえば、ユーザーはメッセージとスレッドに対して |
messagesTotal |
ラベルが付いたメールの合計数。 |
messagesUnread |
ラベルが付いた未読メールの数。 |
threadsTotal |
ラベルが付いたスレッドの合計数。 |
threadsUnread |
ラベルが付いた未読スレッドの数。 |
color |
ラベルに割り当てる色。色は、 |
MessageListVisibility
列挙型 | |
---|---|
show |
メールリストにラベルを表示します。 |
hide |
メール リストにこのラベルを表示しません。 |
LabelListVisibility
列挙型 | |
---|---|
labelShow |
ラベルリストにラベルを表示します。 |
labelShowIfUnread |
そのラベルが付いた未読メールがある場合に、そのラベルを表示します。 |
labelHide |
ラベルリストにラベルを表示しません。 |
種類
列挙型 | |
---|---|
system |
Gmail によって作成されたラベル。 |
user |
ユーザーまたはアプリケーションによって作成されたカスタムラベル。 |
色
JSON 表現 |
---|
{ "textColor": string, "backgroundColor": string } |
フィールド | |
---|---|
textColor |
16 進数文字列で表される、ラベルのテキストの色。このフィールドは、ラベルの色を設定するために必要です。#e0,000, #434347,8a8d870,e1,000,100,000,100,000,000,000,000,000,000,000,000,000,100,000,000 |
backgroundColor |
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 |
|
---|---|
|
新しいラベルを作成します。 |
|
指定したラベルを即時かつ完全に削除し、ラベルが適用されているメッセージやスレッドから削除します。 |
|
指定されたラベルを取得します。 |
|
ユーザーのメールボックス内のすべてのラベルを一覧表示します。 |
|
指定したラベルにパッチを適用します。 |
|
指定したラベルを更新します。 |