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

การแสดงรายการข้อความ

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

ระดับการเข้าถึงรายการป้ายกํากับ

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

ประเภท

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

สี

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

string

สีข้อความของป้ายกํากับซึ่งแสดงเป็นสตริงเลขฐานสิบหก จําเป็นต้องระบุช่องนี้เพื่อตั้งค่าสีของป้ายกํากับ แบบใด โปรดดู ร้าน โปรดดูได้รวดเร็ว โปรดดูช่วง ซึ่งเป็น ซึ่งเป็นช่วง ซึ่งเป็น ซึ่งเป็น ซึ่งเป็น อีกทั้งยังข้อได้อีกด้วยข้อ เราจึงข้อ เราจึงข้อพได้แล้วข้อ ด้วยเหตุนี้ได้ไม่เกินข้อได้แล้วข้อข้อได้ไม่เกินข้อข้อภาพรวมของข้อภาพรวมของภาพรวมของข้อภาพรวมของภาพรวมของ อีกทั้งยัง อีกทั้งยัง อีกทั้งยัง อีกทั้งยังภาพรวมของภาพรวมของภาพรวมของภาพรวมของภาพรวมของภาพรวมของ

backgroundColor

string

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

วิธีการ

create

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

delete

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

get

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

list

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

patch

แก้ไขป้ายกํากับที่ระบุ

update

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