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

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

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

string

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

คุณต้องระบุประเภทเหตุการณ์อย่างน้อย 1 ประเภท (eventType) โดยใช้ตัวดำเนินการ has : หากต้องการกรองตามประเภทเหตุการณ์หลายประเภท ให้ใช้ตัวดำเนินการ 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.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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

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