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

สีพื้นหลังที่แสดงเป็นสตริงฐาน 16 #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

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