Method: spaces.list

แสดงพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก แชทเป็นกลุ่มและ DM จะไม่ปรากฏจนกว่าจะมีการส่งข้อความแรก ดูตัวอย่างได้ที่แสดงพื้นที่ทำงาน

ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้

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

คำขอ HTTP

GET https://chat.googleapis.com/v1/spaces

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

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

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

integer

ไม่บังคับ จำนวนสูงสุดของพื้นที่ว่างที่จะแสดงผล บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลเว้นวรรคไม่เกิน 100 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1,000 ระบบจะเปลี่ยนเป็น 1,000 โดยอัตโนมัติ

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

pageToken

string

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

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

filter

string

ไม่บังคับ ตัวกรองข้อความค้นหา

คุณกรองพื้นที่ทำงานตามประเภทพื้นที่ทำงานได้ (spaceType)

หากต้องการกรองตามประเภทพื้นที่ทำงาน คุณต้องระบุค่า enum ที่ถูกต้อง เช่น SPACE หรือ GROUP_CHAT (spaceType เป็น SPACE_TYPE_UNSPECIFIED ไม่ได้) หากต้องการค้นหาพื้นที่ทำงานหลายประเภท ให้ใช้โอเปอเรเตอร์ OR

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

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

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

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

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

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

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

object (Space)

รายชื่อพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก)

nextPageToken

string

คุณส่งโทเค็นเป็น pageToken เพื่อดึงผลการค้นหาหน้าถัดไปได้ หากว่างเปล่า จะไม่มีหน้าที่ตามมา

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

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

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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