Method: spaces.members.list

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

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

คำขอ HTTP

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

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

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

พารามิเตอร์
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
showGroups

boolean

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

boolean

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

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

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

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

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

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

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

object (Membership)

รายการที่ไม่เรียงลำดับ รายการการเป็นสมาชิกในหน้าที่ขอ (หรือหน้าแรก)
nextPageToken

string

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

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

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

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

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