คู่มือนี้จะอธิบายวิธีใช้เมธอด list()
ในทรัพยากร Membership
ของ Google Chat API เพื่อแสดงรายชื่อสมาชิกในพื้นที่ทำงานเป็นรายการการเป็นสมาชิกแบบแบ่งหน้าและกรองได้ในพื้นที่ทำงาน
- การแสดงการเป็นสมาชิกด้วยการตรวจสอบสิทธิ์ของแอปจะแสดงการเป็นสมาชิกในพื้นที่ทำงานที่แอป Chat มีสิทธิ์เข้าถึง แต่ไม่รวมการเป็นสมาชิกของแอป Chat รวมถึงการเป็นสมาชิกของแอปเอง
- การแสดงข้อมูลการเป็นสมาชิกที่มีการตรวจสอบสิทธิ์ผู้ใช้จะแสดงข้อมูลการเป็นสมาชิกในพื้นที่ทำงานที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมีสิทธิ์เข้าถึง
- การระบุการเป็นสมาชิกในฐานะผู้ดูแลระบบ Google Workspace ที่มีการตรวจสอบสิทธิ์ผู้ใช้โดยใช้สิทธิ์ของผู้ดูแลระบบจะแสดงการเป็นสมาชิกในพื้นที่ทำงานทั้งหมดในองค์กร Google Workspace
Membership
ทรัพยากรแสดงว่าผู้ใช้หรือแอป Google Chat ได้รับเชิญให้เข้าร่วม เป็นส่วนหนึ่งของ หรือไม่ได้อยู่ในพื้นที่ทำงาน
ข้อกำหนดเบื้องต้น
Node.js
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Cloud สำหรับ Node.js
- สร้างข้อมูลเข้าสู่ระบบการเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์เป็นแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ที่มีชื่อว่า
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
- พื้นที่ทำงาน Google Chat ที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วหรือแอป Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอปแชท ให้เพิ่มแอปแชทไปยังพื้นที่ทำงาน
Python
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Cloud สำหรับ Python
- สร้างข้อมูลเข้าสู่ระบบการเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์เป็นแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ที่มีชื่อว่า
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
- พื้นที่ทำงาน Google Chat ที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์หรือแอป Google Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอปแชท ให้เพิ่มแอปแชทในพื้นที่ทำงาน
Java
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Java สำหรับ Cloud
- สร้างข้อมูลเข้าสู่ระบบการเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์เป็นแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ที่มีชื่อว่า
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
- พื้นที่ทำงาน Google Chat ที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์หรือแอป Google Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอปแชท ให้เพิ่มแอปแชทในพื้นที่ทำงาน
Apps Script
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- สร้างโปรเจ็กต์ Apps Script แบบสแตนด์อโลน และเปิดบริการแชทขั้นสูง
- ในคู่มือนี้ คุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้หรือแอป หากต้องการตรวจสอบสิทธิ์ในฐานะแอปใน Chat ให้สร้างข้อมูลเข้าสู่ระบบบัญชีบริการ ดูขั้นตอนได้ที่หัวข้อตรวจสอบสิทธิ์และให้สิทธิ์ในฐานะแอป Google Chat
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
- พื้นที่ทำงานใน Google Chat ที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์หรือแอป Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอปแชท ให้เพิ่มแอปแชทไปยังพื้นที่ทำงาน
แสดงรายชื่อสมาชิกในพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ผู้ใช้
หากต้องการแสดงรายการผู้ใช้, Google Groups และแอป Chat ในพื้นที่ทำงานที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมีสิทธิ์เข้าถึง ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- เมื่อใช้การตรวจสอบสิทธิ์ของผู้ใช้ ให้ระบุขอบเขตการให้สิทธิ์
chat.memberships.readonly
หรือchat.memberships
- เรียกใช้เมธอด
ListMemberships()
- หากต้องการแสดงรายการ Google Groups ให้ตั้งค่าพารามิเตอร์การค้นหา
showGroups
เป็นtrue
ตัวอย่างต่อไปนี้แสดงสมาชิก Google Groups, บุคคล และแอปที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมองเห็น
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ SPACE_NAME
ด้วยรหัสจากช่องname
ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอด ListSpaces()
หรือจาก URL ของพื้นที่ทำงาน
Google Chat API จะแสดงรายการสมาชิก Google Group, บุคคล และแอปจากพื้นที่ทำงานที่ระบุ
แสดงรายการสมาชิกในพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ของแอป
หากต้องการแสดงรายการผู้ใช้และแอปใน Chat ในพื้นที่ทำงานที่แอปที่ตรวจสอบสิทธิ์เข้าถึงได้ ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- เมื่อใช้การตรวจสอบสิทธิ์ของแอป ให้ระบุขอบเขตการให้สิทธิ์
chat.bot
- เรียกใช้เมธอด
ListMemberships()
- หากต้องการแสดงรายการ Google Groups ให้ตั้งค่าพารามิเตอร์การค้นหา
showGroups
เป็นtrue
ตัวอย่างต่อไปนี้แสดงสมาชิกพื้นที่ทำงานที่เป็นบุคคล (ไม่ใช่ผู้จัดการพื้นที่ทำงาน) ที่มองเห็นได้ในแอป Chat
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ SPACE_NAME
ด้วยรหัสจากช่องname
ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอด ListSpaces()
หรือจาก URL ของพื้นที่ทำงาน
Google Chat API จะแสดงรายการสมาชิกพื้นที่ทำงานที่เป็นบุคคล (ยกเว้นผู้จัดการพื้นที่ทำงาน) จากพื้นที่ทำงานที่ระบุ
แสดงรายการสมาชิกในฐานะผู้ดูแลระบบ Google Workspace
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเรียกใช้เมธอด ListMemberships()
เพื่อแสดงข้อมูลการเป็นสมาชิกของพื้นที่ทำงานใดก็ได้ในองค์กร Google Workspace Chat API จะแสดงเฉพาะการเป็นสมาชิกเกี่ยวกับผู้ใช้ (ทั้งภายในและภายนอก) หรือ Google Groups จากองค์กรของคุณ จึงจะไม่แสดงการเป็นสมาชิกของแอป Chat
หากต้องการเรียกใช้เมธอดนี้ในฐานะผู้ดูแลระบบ Google Workspace ให้ทำดังนี้
- เรียกใช้เมธอดโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ และระบุขอบเขตการให้สิทธิ์ที่รองรับการเรียกใช้เมธอดโดยใช้สิทธิ์ของผู้ดูแลระบบ
- ในคําขอ ให้ระบุพารามิเตอร์การค้นหาต่อไปนี้
- ตั้งค่า
useAdminAccess
เป็นtrue
- หากต้องการแสดงเฉพาะผู้ใช้ ให้ตั้งค่า
filter
สำหรับmember.type
เป็นHUMAN
- หากต้องการแสดงผู้ใช้และกลุ่ม ให้ตั้งค่า
filter
สำหรับmember.type
ไม่เท่ากับBOT
AND
showGroups
เท่ากับtrue
- ตั้งค่า
โปรดดูข้อมูลเพิ่มเติมและตัวอย่างที่หัวข้อจัดการพื้นที่ทำงานของ Google Chat ในฐานะผู้ดูแลระบบ Google Workspace
ปรับแต่งการแบ่งหน้าหรือกรองรายการ
หากต้องการแสดงรายการการเป็นสมาชิก ให้ส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อปรับแต่งการแบ่งหน้าหรือกรองการเป็นสมาชิกที่แสดง
pageSize
: จำนวนการเป็นสมาชิกสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 100 ช่องว่าง ค่าสูงสุดคือ 1,000 ระบบจะเปลี่ยนค่าที่มากกว่า 1,000 เป็น 1,000 โดยอัตโนมัติpageToken
: โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้พื้นที่ทำงานรายการก่อนหน้า ระบุโทเค็นนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับคอลที่ระบุโทเค็นหน้า การส่งค่าอื่นอาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิดfilter
: ตัวกรองข้อความค้นหา ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้ ดูรายละเอียดการค้นหาที่รองรับได้ที่ข้อมูลอ้างอิงListMembershipsRequest
หัวข้อที่เกี่ยวข้อง
- ดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Chat
- เชิญหรือเพิ่มผู้ใช้หรือแอป Chat ไปยังพื้นที่ทำงาน
- อัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ใน Google Chat
- นำผู้ใช้หรือแอป Chat ออกจากพื้นที่ทำงาน