REST Resource: users.availability

แหล่งข้อมูล: ความพร้อมจำหน่ายสินค้า

แสดงข้อมูลความพร้อมของผู้ใช้ปัจจุบันใน Google Chat ซึ่งรวมถึงสถานะ (เช่น ใช้งานอยู่ ไม่อยู่ ห้ามรบกวน) และสถานะที่กำหนดเอง

การแสดง JSON 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของเวลาว่างของผู้ใช้

รูปแบบ: users/{user}/availability

{user} คือรหัสของบุคคลใน People API หรือ Admin SDK Directory API เช่น users/123456789

นอกจากนี้ คุณยังใช้อีเมลของผู้ใช้หรือmeเป็นชื่อแทนเพื่ออ้างอิงถึงผู้โทรได้ด้วย เช่น users/user@example.com หรือ users/me
state

enum (State)

เอาต์พุตเท่านั้น สถานะเวลาว่างปัจจุบันของผู้ใช้
customStatus

object (CustomStatus)

ไม่บังคับ สถานะที่กำหนดเองของผู้ใช้
ฟิลด์ Union state_metadata ข้อมูลเมตาเพิ่มเติมที่เชื่อมโยงกับสถานะความพร้อมของผู้ใช้ state_metadata ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
doNotDisturbMetadata

object (DoNotDisturbMetadata)

เอาต์พุตเท่านั้น ข้อมูลเมตาหากตั้งค่าสถานะผู้ใช้เป็น DO_NOT_DISTURB

รัฐ

แสดงสถานะความพร้อมใช้งานปัจจุบันของผู้ใช้

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น ไม่ได้ระบุสถานะ
ACTIVE ผู้ใช้ใช้งานอยู่ ณ ปัจจุบัน โดยอิงตามกิจกรรมล่าสุด
IDLE ผู้ใช้ไม่ได้ใช้งานในขณะนี้ สถานะนี้บ่งบอกถึงช่วงเวลาที่ไม่มีการใช้งานหลังจากสถานะเป็น "ใช้งานอยู่" ก่อนที่จะเปลี่ยนเป็น "ไม่อยู่"
AWAY ผู้ใช้ไม่อยู่ในขณะนี้ ซึ่งอาจตั้งค่าโดยอัตโนมัติหลังจากไม่มีการใช้งานเป็นระยะเวลาหนึ่งในสถานะ "ใช้งานอยู่" หรือ "ไม่ได้ใช้งาน" หรือผู้ใช้จะตั้งค่าด้วยตนเองก็ได้ เมื่อตั้งค่าด้วยตนเองผ่าน availability.markAsAway สถานะนี้จะยังคงอยู่ไม่ว่าผู้ใช้จะทำกิจกรรมใดก็ตาม
DO_NOT_DISTURB ผู้ใช้อยู่ในสถานะห้ามรบกวน ซึ่งตั้งค่าด้วยตนเอง

DoNotDisturbMetadata

ข้อมูลเมตาที่เชื่อมโยงกับDO_NOT_DISTURBสถานะความพร้อมจำหน่ายสินค้า ซึ่งระบุเวลาที่ตั้งค่าสถานะให้หมดอายุ

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

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาจนกว่าจะมีการทำเครื่องหมายผู้ใช้เป็น DO_NOT_DISTURB โดยต้องไม่เกิน 1 ปีนับจากปัจจุบัน

CustomStatus

แสดงสถานะที่กำหนดเองของผู้ใช้ใน Google Chat ซึ่งรวมถึงข้อความสั้นๆ พร้อมอิโมจิ (ไม่บังคับ) ที่ผู้ใช้ตั้งค่าไว้เพื่อให้บริบทเพิ่มเติมเกี่ยวกับความพร้อมของตน

การแสดง JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
ช่อง
text

string

ต้องระบุ ข้อความของสถานะที่กำหนดเอง ซึ่งจะเป็นสตริงที่มีความยาวสูงสุด 64
emoji

object (Emoji)

ต้องระบุ อีโมจิของสถานะที่กำหนดเอง รองรับเฉพาะอีโมจิ Unicode แต่ไม่รองรับอีโมจิที่กำหนดเอง
ฟิลด์ Union expiration เวลาหมดอายุของสถานะที่กำหนดเอง โดยสามารถระบุเป็นทั้งการประทับเวลาแบบสัมบูรณ์หรือระยะเวลา Time-To-Live expiration ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
expireTime

string (Timestamp format)

การประทับเวลาเมื่อสถานะที่กำหนดเองหมดอายุ
ttl

string (Duration format)

อินพุตเท่านั้น ระยะเวลา Time-To-Live หลังจากที่สถานะที่กำหนดเองหมดอายุ

เมธอด

get

 แสดงข้อมูลความพร้อมของผู้ใช้ที่เป็นบุคคลใน Google Chat

markAsActive

 ทำเครื่องหมายผู้ใช้เป็น ACTIVE ใน Google Chat

markAsAway

 ทำเครื่องหมายผู้ใช้เป็น AWAY ใน Google Chat

markAsDoNotDisturb

 ทำเครื่องหมายผู้ใช้เป็นDO_NOT_DISTURBใน Google Chat

patch

 อัปเดตข้อมูลความพร้อมของผู้ใช้ที่เป็นบุคคล