Method: spaces.members.list

แสดงรายการการเป็นสมาชิกในพื้นที่ทํางาน ดูตัวอย่างได้ที่การเป็นสมาชิกในรายการ ข้อมูลการเป็นสมาชิกที่มีการตรวจสอบสิทธิ์แอปจะแสดงการเป็นสมาชิกในพื้นที่ทํางานที่แอป Chat มีสิทธิ์เข้าถึง แต่จะยกเว้นการเป็นสมาชิกของแอป Chat รวมถึงการเป็นสมาชิกของตนเอง ข้อมูลการเป็นสมาชิกที่มีการตรวจสอบสิทธิ์ผู้ใช้จะแสดงรายการการเป็นสมาชิกในพื้นที่ทํางานที่ผู้ใช้ที่ตรวจสอบสิทธิ์มีสิทธิ์เข้าถึง

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

คำขอ HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

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

พารามิเตอร์เส้นทาง

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

string

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

รูปแบบ: พื้นที่ทํางาน/{space}

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

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

integer

จํานวนการเป็นสมาชิกสูงสุดที่จะส่งคืน บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลการเป็นสมาชิกได้สูงสุด 100 รายการ

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

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

string

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

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

string

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

คุณกรองการเป็นสมาชิกได้ตามบทบาท (role) ของสมาชิกและประเภท (member.type)

หากต้องการกรองตามบทบาท ให้ตั้งค่า role เป็น ROLE_MEMBER หรือ ROLE_MANAGER

หากต้องการกรองตามประเภท ให้ตั้งค่า member.type เป็น HUMAN หรือ BOT

หากต้องการกรองตามบทบาทและประเภท ให้ใช้โอเปอเรเตอร์ AND หากต้องการกรองตามบทบาทหรือประเภท ให้ใช้โอเปอเรเตอร์ OR

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

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

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

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

boolean

ไม่บังคับ เมื่อ true จะส่งคืนการเป็นสมาชิกที่เชื่อมโยงกับสมาชิก invited ด้วย นอกเหนือจากการเป็นสมาชิกประเภทอื่นๆ หากตั้งค่าตัวกรอง ระบบจะไม่แสดงผลการเป็นสมาชิก invited ที่ไม่ตรงกับเกณฑ์ตัวกรอง

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

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

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

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

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

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

object (Membership)

รายการการเป็นสมาชิกในหน้าที่ขอ (หรือหน้าแรก)
nextPageToken

string

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

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

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

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

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