Method: spaces.members.list

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

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

คำขอ HTTP

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

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

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

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

string

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

รูปแบบ: Spaces/{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 นอกจากนี้ คุณยังกรองหา member.type โดยใช้โอเปอเรเตอร์ != ได้ด้วย

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

ต้องระบุ member.type = "HUMAN" หรือ member.type != "BOT" เมื่อตั้งค่า useAdminAccess เป็น "true" ตัวกรองประเภทสมาชิกอื่นๆ จะถูกปฏิเสธ

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

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

member.type != "BOT"

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

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 ที่ไม่ตรงกับเกณฑ์ตัวกรอง

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

boolean

ไม่บังคับ เมื่อ true วิธีการจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships.readonly หรือ chat.admin.memberships

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

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

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

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

การตอบสนองต่อรายการการเป็นสมาชิกของพื้นที่ทำงาน

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

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

object (Membership)

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

string

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

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

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

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • 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

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