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 ไม่แสดงป้ายกำกับในรายการป้ายกำกับ

Type

Enum
system ป้ายกำกับที่สร้างโดย Gmail
user ป้ายกำกับที่กำหนดเองที่ผู้ใช้หรือแอปพลิเคชันสร้างขึ้น

สี

การแสดง JSON 
{
  "textColor": string,
  "backgroundColor": string
}
ช่อง
textColor

string

สีข้อความของป้ายกำกับที่แสดงเป็นสตริงฐานสิบหก ต้องระบุข้อมูลในช่องนี้เพื่อตั้งค่าสีของป้ายกำกับ #1a
backgroundColor

string

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

วิธีการ

create

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

delete

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

get

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

list

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

patch

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

update

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