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

รหัสที่เปลี่ยนแปลงไม่ได้ของป้ายกำกับ
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

Enum
show แสดงป้ายกำกับในรายการข้อความ
hide ไม่แสดงป้ายกำกับในรายการข้อความ

LabelListVisibility

Enum
labelShow แสดงป้ายกำกับในรายการป้ายกำกับ
labelShowIfUnread แสดงป้ายกำกับหากมีข้อความที่ยังไม่อ่านซึ่งมีป้ายกำกับนั้น
labelHide ไม่แสดงป้ายกำกับในรายการป้ายกำกับ

ประเภท

Enum
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) คุณต้องกรอกข้อมูลในช่องนี้เพื่อตั้งค่าสีของป้ายกำกับ อนุญาตให้ใช้เฉพาะชุดค่าสีที่กำหนดไว้ล่วงหน้าต่อไปนี้
#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

 อัปเดตป้ายกำกับที่ระบุ