Method: spaces.spaceEvents.list

แสดงรายการกิจกรรมจากพื้นที่ใน Google Chat payloadของแต่ละเหตุการณ์จะมีทรัพยากร 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

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

คุณต้องระบุประเภทเหตุการณ์ (eventType) อย่างน้อย 1 ประเภทโดยใช้โอเปอเรเตอร์ : หากต้องการกรองตามเหตุการณ์หลายประเภท ให้ใช้โอเปอเรเตอร์ 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)

ระบบจะแสดงผลลัพธ์ตามลำดับเวลา (เหตุการณ์เก่าสุดก่อน)
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

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