Method: spaces.list

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

หากต้องการแสดงพื้นที่ทำงานที่มีชื่อตามองค์กร Google Workspace ให้ใช้เมธอด spaces.search() โดยใช้สิทธิ์ของผู้ดูแลระบบ Workspace แทน

คำขอ 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)

รายการพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก) หมายเหตุ: ระบบจะไม่แสดงฟิลด์ permissionSettings ในออบเจ็กต์พื้นที่ทำงานสำหรับคำขอรายการ
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

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