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

string

สีพื้นหลังจะแสดงเป็นสตริงฐานสิบหก #RRGGBB (เช่น #000000) ต้องกรอกข้อมูลในช่องนี้เพื่อตั้งค่าสีของป้ายกำกับ อนุญาตให้ใช้เฉพาะค่าสีค่าสีที่กำหนดไว้ล่วงหน้า

เมธอด

create

 สร้างป้ายกำกับใหม่

delete

 ลบป้ายกำกับที่ระบุอย่างถาวรทันที รวมถึงนำออกจากข้อความและชุดข้อความที่ใช้ป้ายกำกับนั้นอยู่

get

 รับป้ายกำกับที่ระบุ

list

 แสดงป้ายกำกับทั้งหมดในกล่องจดหมายของผู้ใช้

patch

 แพตช์ป้ายกำกับที่ระบุ

update

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