คู่มือนี้อธิบายวิธีใช้เมธอด
list()
ในทรัพยากร Membership
ของ Google Chat API เพื่อแสดงรายชื่อสมาชิกในพื้นที่ทำงาน
เป็นรายการการเป็นสมาชิกในพื้นที่ทำงานที่กรองได้และมีการแบ่งหน้า
- การแสดงการเป็นสมาชิกด้วย การตรวจสอบสิทธิ์แอป จะแสดงการเป็นสมาชิกในพื้นที่ที่แอป Chat มี สิทธิ์เข้าถึง แต่จะไม่รวมการเป็นสมาชิกของแอป Chat รวมถึงการเป็นสมาชิกของแอปเอง
- การแสดงการเป็นสมาชิกที่มี การตรวจสอบสิทธิ์ผู้ใช้ จะแสดงการเป็นสมาชิกในพื้นที่ที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมีสิทธิ์เข้าถึง
- การแสดงรายการการเป็นสมาชิกในฐานะผู้ดูแลระบบ Google Workspace ที่มีการตรวจสอบสิทธิ์ผู้ใช้โดยใช้สิทธิ์ของผู้ดูแลระบบจะแสดงรายการการเป็นสมาชิกในพื้นที่ทำงานทั้งหมดในองค์กร Google Workspace ของคุณ
ออบเจ็กต์
Membership
แสดงว่าผู้ใช้ที่เป็นมนุษย์หรือแอป Google Chat ได้รับเชิญให้เข้าร่วม
เป็นส่วนหนึ่งของ หรือไม่ได้อยู่ในพื้นที่ทำงาน
ข้อกำหนดเบื้องต้น
Node.js
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อม โดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Node.js Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
ในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
- พื้นที่ใน Google Chat ที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์หรือแอป Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้เพิ่มแอป Chat ลงในพื้นที่ทำงาน
Python
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อม โดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Python Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
ในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
- พื้นที่ใน Google Chat ที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์หรือแอป Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้เพิ่มแอป Chat ลงในพื้นที่ทำงาน
Java
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อม โดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Java Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
ในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
- พื้นที่ใน Google Chat ที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์หรือแอป Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้เพิ่มแอป Chat ลงในพื้นที่ทำงาน
Apps Script
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อม โดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- สร้างโปรเจ็กต์ Apps Script แบบสแตนด์อโลน และเปิดบริการ Chat ขั้นสูง
- ในคู่มือนี้ คุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ หรือแอป หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้สร้าง ข้อมูลเข้าสู่ระบบของบัญชีบริการ ดูขั้นตอนได้ที่ ตรวจสอบสิทธิ์และให้สิทธิ์ในฐานะ แอป Google Chat
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
- พื้นที่ใน Google Chat ที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์หรือแอป Chat ที่โทรเป็นสมาชิก หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้เพิ่มแอป Chat ลงในพื้นที่ทำงาน
แสดงรายชื่อสมาชิกในพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ผู้ใช้
หากต้องการแสดงรายชื่อผู้ใช้ กลุ่ม Google และแอป 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, มนุษย์ และแอปจากพื้นที่ที่ระบุ
แสดงรายชื่อสมาชิกในพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์แอป
หากต้องการแสดงรายชื่อผู้ใช้และแอปใน 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
: โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ list spaces ก่อนหน้า ระบุโทเค็นนี้เพื่อดึงข้อมูลหน้าถัดไป เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิดfilter
: ตัวกรองการค้นหา ต้องมีการตรวจสอบสิทธิ์ของผู้ใช้ ดูรายละเอียดการค้นหาที่รองรับได้ในข้อมูลอ้างอิงของListMembershipsRequest
หัวข้อที่เกี่ยวข้อง
- ดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Chat
- เชิญหรือเพิ่มผู้ใช้หรือแอป Chat ลงในพื้นที่ทำงาน
- อัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ทำงานใน Google Chat
- นำผู้ใช้หรือแอป Chat ออกจากพื้นที่ทำงาน