Method: users.availability.markAsActive

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

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

วิธีนี้จะอัปเดตความพร้อมใช้งานของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์แล้วเท่านั้น

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability

คำขอ HTTP

POST https://chat.googleapis.com/v1/{name=users/*/availability}:markAsActive

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ต้องระบุ ชื่อทรัพยากรของความพร้อมใช้งานที่จะทำเครื่องหมายเป็นใช้งานอยู่ รูปแบบ: users/{user}/availability

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

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

เนื้อหาคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{

  "expireTime": string,
  "ttl": string
}
ช่อง
ฟิลด์ Union expiration เวลาหมดอายุสำหรับสถานะความพร้อมใช้งาน ACTIVE ระบบจะทำเครื่องหมายผู้ใช้เป็นไม่อยู่หลังจากหมดอายุ หากไม่ได้ระบุเวลาหมดอายุ สถานะ ACTIVE จะหมดอายุ 30 นาทีจากเวลาปัจจุบัน expiration จะเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
expireTime

string (Timestamp format)

การประทับเวลาแบบสัมบูรณ์เมื่อสถานะ ACTIVE หมดอายุ
ttl

string (Duration format)

ระยะเวลาจากเวลาปัจจุบันจนกว่าสถานะ ACTIVE จะหมดอายุ การใช้ TTL สั้นๆ จะรีเซ็ตสถานะของผู้ใช้ให้เป็นไปตามกิจกรรมหลังจากระยะเวลาสั้นๆ นี้ได้อย่างมีประสิทธิภาพ

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Availability

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์