REST Resource: users.labels

리소스: 라벨

라벨은 사용자의 편지함 내에서 메일과 대화목록을 분류하는 데 사용됩니다. 사용자 편지함에서 지원되는 최대 라벨 수는 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

배경색이 #RRGGBB (예: #000000) 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

메서드

create

 새 라벨을 만듭니다.

delete

 지정된 라벨을 즉시 영구적으로 삭제하고 라벨이 적용된 메시지 및 대화목록에서 라벨을 삭제합니다.

get

 지정된 라벨을 가져옵니다.

list

 사용자의 메일함에 있는 모든 라벨을 나열합니다.

patch

 지정된 라벨을 패치합니다.

update

 지정된 라벨을 업데이트합니다.