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)

ラベルに割り当てる色。色を指定できるのは、typeuser に設定されているラベルのみです。

MessageListVisibility

列挙型
show メール リストにこのラベルを表示します。
hide メール リストにラベルを表示しない。

LabelListVisibility

列挙型
labelShow ラベルリストにラベルを表示します。
labelShowIfUnread そのラベルが付いた未読メールがある場合に、そのラベルを表示します。
labelHide ラベルリストにラベルを表示しない。

タイプ

列挙型
system Gmail で作成されたラベル。
user ユーザーまたはアプリケーションによって作成されたカスタムラベル。

JSON 表現
{
  "textColor": string,
  "backgroundColor": string
}
フィールド
textColor

string

16 進文字列で表されるラベルのテキストの色。ラベルの色を設定する場合、このフィールドは必須です。

backgroundColor

string

16 進文字列 #RRGGBB で表される背景色(例: #000000)。ラベルの色を設定する場合、このフィールドは必須です。

メソッド

create

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

delete

指定したラベルを直ちに完全に削除し、そのラベルが適用されているすべてのメッセージとスレッドから削除します。

get

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

list

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

patch

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

update

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