REST Resource: users.labels

リソース: Label

ラベルを使用して、ユーザーのメールボックス内のメールやスレッドを分類します。1 つのメールボックスで使用できるラベルは 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 メッセージ リストにラベルを表示しません。

ラベルリストの公開設定

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

タイプ

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

色

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

string

ラベルのテキストの色（16 進数文字列）。ラベルの色を設定するには、このフィールドを指定する必要があります。<ph type="x-smartling-placeholder">
</ph>
backgroundColor

string

16 進数文字列 #RRGGBB で表される背景色（例: #000000）。ラベルの色を設定するには、このフィールドを指定する必要があります。<ph type="x-smartling-placeholder">
</ph>

Methods

create

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

delete

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

get

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

list

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

patch

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

update

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