- リソース: Label
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- MessageListVisibility
- LabelListVisibility
- 型
- Color
- メソッド
リソース: Label
ラベルは、ユーザーのメールボックス内のメールやスレッドを分類するために使用します。ユーザーのメールボックスでサポートされるラベルの最大数は 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 進文字列で表されるラベルのテキストの色。ラベルの色を設定する場合、このフィールドは必須です。 |
backgroundColor |
16 進文字列 #RRGGBB で表される背景色(例: #000000)。ラベルの色を設定する場合、このフィールドは必須です。 |
メソッド |
|
---|---|
|
新しいラベルを作成します。 |
|
指定したラベルを直ちに完全に削除し、そのラベルが適用されているすべてのメッセージとスレッドから削除します。 |
|
指定されたラベルを取得します。 |
|
ユーザーのメールボックス内のすべてのラベルを一覧表示します。 |
|
指定されたラベルにパッチを適用します。 |
|
指定されたラベルを更新します。 |