Method: spaces.list

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

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

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์ gRPC Transcoding

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

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

integer

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

หากไม่ระบุ ระบบจะแสดงผลพื้นที่ทํางานสูงสุด 100 รายการ

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

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

string

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

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

string

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

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

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

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

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

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

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

หากมีการตรวจสอบสิทธิ์บัญชีบริการ ระบบจะไม่สนใจช่องนี้ และคําค้นหาจะแสดงพื้นที่ทํางานทั้งหมดเสมอ แต่ Chat API จะยังคงตรวจสอบไวยากรณ์การค้นหาด้วยบัญชีบริการ ดังนั้นคําค้นหาที่ไม่ถูกต้องจะถูกปฏิเสธ

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

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

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

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

การแสดง 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

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