Method: spaces.spaceEvents.list

แสดงรายการเหตุการณ์จากพื้นที่ทำงานใน Google Chat เพย์โหลดจะมีทรัพยากร Chat เวอร์ชันล่าสุดสำหรับแต่ละเหตุการณ์ ตัวอย่างเช่น หากคุณแสดงรายการเหตุการณ์เกี่ยวกับสมาชิกใหม่ในพื้นที่ทำงาน เซิร์ฟเวอร์จะแสดงผลทรัพยากร Membership ที่มีรายละเอียดการเป็นสมาชิกล่าสุด หากนําสมาชิกใหม่ออกในช่วงที่ขอ เพย์โหลดเหตุการณ์จะมีทรัพยากร Membership ว่างเปล่า

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

ดูตัวอย่างได้ที่แสดงรายการกิจกรรมจากพื้นที่ใน Google Chat

คำขอ HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

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

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

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

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ใน Google Chat ที่เหตุการณ์เกิดขึ้น

รูปแบบ: spaces/{space}

พารามิเตอร์การค้นหา

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

integer

ไม่บังคับ จํานวนเหตุการณ์ในพื้นที่สูงสุดที่แสดง บริการอาจแสดงผลน้อยกว่าค่านี้

ค่าลบจะแสดงผลข้อผิดพลาด INVALID_ARGUMENT
pageToken

string

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

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุเพื่อแสดงรายการเหตุการณ์ในพื้นที่ทำงานต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ การส่งค่าอื่นไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด
filter

string

ต้องระบุ ตัวกรองข้อความค้นหา

คุณต้องระบุประเภทเหตุการณ์อย่างน้อย 1 ประเภท (eventType) โดยใช้โอเปอเรเตอร์มี : หากต้องการกรองตามเหตุการณ์หลายประเภท ให้ใช้โอเปอเรเตอร์ OR ละเว้นประเภทเหตุการณ์แบบเป็นกลุ่มในตัวกรอง คําขอจะแสดงเหตุการณ์กลุ่มที่เกี่ยวข้องโดยอัตโนมัติ เช่น หากคุณกรองตามความรู้สึกใหม่ (google.workspace.chat.reaction.v1.created) เซิร์ฟเวอร์จะแสดงผลเหตุการณ์ความรู้สึกใหม่แบบเป็นกลุ่ม (google.workspace.chat.reaction.v1.batchCreated) ด้วย ดูรายการประเภทเหตุการณ์ที่รองรับได้ที่SpaceEventsเอกสารอ้างอิง

นอกจากนี้ คุณยังกรองตามเวลาเริ่มต้น (startTime) และเวลาสิ้นสุด (endTime) ได้ด้วย โดยทำดังนี้

  • startTime: การประทับเวลาสุดพิเศษสำหรับเริ่มระบุเหตุการณ์ในพื้นที่ทำงาน คุณสามารถแสดงเหตุการณ์ที่เกิดขึ้นได้สูงสุด 28 วันที่ผ่านมา หากไม่ระบุ จะแสดงเหตุการณ์ที่เกิดขึ้นในพื้นที่ทำงานในช่วง 28 วันที่ผ่านมา
  • endTime: การประทับเวลาที่รวมจนถึงเวลาที่แสดงเหตุการณ์ในพื้นที่ทำงาน หากไม่ได้ระบุ ระบบจะแสดงเหตุการณ์จนถึงเวลาที่ส่งคำขอ

หากต้องการระบุเวลาเริ่มต้นหรือเวลาสิ้นสุด ให้ใช้โอเปอเรเตอร์เท่ากับ = และจัดรูปแบบตาม RFC-3339 หากต้องการกรองตามทั้ง startTime และ endTime ให้ใช้โอเปอเรเตอร์ AND

ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

การค้นหาต่อไปนี้ไม่ถูกต้อง

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด INVALID_ARGUMENT

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

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

ข้อความตอบกลับสำหรับการแสดงกิจกรรมในพื้นที่ทำงาน

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

การแสดง JSON 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
ช่อง
spaceEvents[]

object (SpaceEvent)

ผลลัพธ์จะแสดงตามลำดับเวลา (เหตุการณ์ที่เก่าสุดก่อน) หมายเหตุ: ระบบจะไม่แสดงฟิลด์ permissionSettings ในออบเจ็กต์พื้นที่ทำงานสำหรับคำขอรายการ
nextPageToken

string

โทเค็นการดําเนินการต่อที่ใช้ดึงข้อมูลเหตุการณ์เพิ่มเติม หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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