Method: spaces.members.list

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

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

  • การตรวจสอบสิทธิ์แอปที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (เฉพาะพื้นที่ทำงานโหมดการนำเข้า)
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ useAdminAccess true และใช้ขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

คำขอ HTTP

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

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

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

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

string

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

รูปแบบ: spaces/{space}

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

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

integer

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

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

ค่าสูงสุดคือ 1000 หากใช้ค่ามากกว่า 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 เป็น "จริง" ระบบจะปฏิเสธตัวกรองประเภทสมาชิกอื่นๆ

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

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 ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

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

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

เนื้อความของคำขอ

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

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

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

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

การแสดง 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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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