Hướng dẫn này giải thích cách sử dụng phương thức list()
trên tài nguyên Membership
của API Google Chat để liệt kê các thành viên trong một không gian dưới dạng danh sách thành viên có thể lọc và phân trang trong một không gian.
- Liệt kê thành viên bằng xác thực ứng dụng, liệt kê thành viên trong những không gian mà ứng dụng Chat có quyền truy cập, nhưng không bao gồm thành viên của ứng dụng Chat, kể cả thành viên của chính ứng dụng đó.
- Liệt kê tư cách thành viên bằng xác thực người dùng. Liệt kê tư cách thành viên trong những không gian mà người dùng đã xác thực có quyền truy cập.
- Việc liệt kê tư cách thành viên với tư cách là quản trị viên Google Workspace có xác thực người dùng bằng đặc quyền quản trị viên sẽ liệt kê tư cách thành viên trong tất cả các không gian trong tổ chức Google Workspace của bạn.
Tài nguyên Membership
cho biết liệu người dùng là con người hay ứng dụng Google Chat được mời, có tham gia hay không tham gia một không gian.
Điều kiện tiên quyết
Node.js
- Tài khoản Google Workspace Business hoặc Enterprise có quyền truy cập vào Google Chat.
- Thiết lập môi trường:
- Tạo một dự án trên Google Cloud.
- Định cấu hình màn hình đồng ý OAuth.
- Bật và định cấu hình Google Chat API bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat của bạn.
- Cài đặt Thư viện ứng dụng Cloud Node.js.
- Tạo thông tin đăng nhập để truy cập dựa trên cách bạn muốn xác thực trong yêu cầu Google Chat API:
- Để xác thực với tư cách là người dùng Chat, hãy tạo thông tin xác thực mã ứng dụng OAuth và lưu thông tin xác thực dưới dạng tệp JSON có tên là
credentials.json
vào thư mục cục bộ của bạn. - Để xác thực dưới dạng ứng dụng Chat, hãy tạo thông tin đăng nhập tài khoản dịch vụ và lưu thông tin đăng nhập dưới dạng tệp JSON có tên là
credentials.json
.
- Để xác thực với tư cách là người dùng Chat, hãy tạo thông tin xác thực mã ứng dụng OAuth và lưu thông tin xác thực dưới dạng tệp JSON có tên là
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực với tư cách là người dùng hay ứng dụng Chat.
- Một không gian trên Google Chat mà người dùng đã xác thực hoặc ứng dụng Chat gọi là thành viên. Để xác thực dưới dạng ứng dụng Chat, hãy thêm ứng dụng Chat vào không gian.
Python
- Tài khoản Google Workspace Business hoặc Enterprise có quyền truy cập vào Google Chat.
- Thiết lập môi trường:
- Tạo một dự án trên Google Cloud.
- Định cấu hình màn hình đồng ý OAuth.
- Bật và định cấu hình Google Chat API bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat của bạn.
- Cài đặt Thư viện ứng dụng đám mây Python.
- Tạo thông tin đăng nhập để truy cập dựa trên cách bạn muốn xác thực trong yêu cầu Google Chat API:
- Để xác thực với tư cách là người dùng Chat, hãy tạo thông tin xác thực mã ứng dụng OAuth và lưu thông tin xác thực dưới dạng tệp JSON có tên là
credentials.json
vào thư mục cục bộ của bạn. - Để xác thực dưới dạng ứng dụng Chat, hãy tạo thông tin đăng nhập tài khoản dịch vụ và lưu thông tin đăng nhập dưới dạng tệp JSON có tên là
credentials.json
.
- Để xác thực với tư cách là người dùng Chat, hãy tạo thông tin xác thực mã ứng dụng OAuth và lưu thông tin xác thực dưới dạng tệp JSON có tên là
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực với tư cách là người dùng hay ứng dụng Chat.
- Một không gian trên Google Chat mà người dùng đã xác thực hoặc ứng dụng Chat gọi là thành viên. Để xác thực dưới dạng ứng dụng Chat, hãy thêm ứng dụng Chat vào không gian.
Java
- Tài khoản Google Workspace Business hoặc Enterprise có quyền truy cập vào Google Chat.
- Thiết lập môi trường:
- Tạo một dự án trên Google Cloud.
- Định cấu hình màn hình đồng ý OAuth.
- Bật và định cấu hình Google Chat API bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat của bạn.
- Cài đặt Thư viện ứng dụng đám mây Java.
- Tạo thông tin đăng nhập để truy cập dựa trên cách bạn muốn xác thực trong yêu cầu Google Chat API:
- Để xác thực với tư cách là người dùng Chat, hãy tạo thông tin xác thực mã ứng dụng OAuth và lưu thông tin xác thực dưới dạng tệp JSON có tên là
credentials.json
vào thư mục cục bộ của bạn. - Để xác thực dưới dạng ứng dụng Chat, hãy tạo thông tin đăng nhập tài khoản dịch vụ và lưu thông tin đăng nhập dưới dạng tệp JSON có tên là
credentials.json
.
- Để xác thực với tư cách là người dùng Chat, hãy tạo thông tin xác thực mã ứng dụng OAuth và lưu thông tin xác thực dưới dạng tệp JSON có tên là
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực với tư cách là người dùng hay ứng dụng Chat.
- Một không gian trên Google Chat mà người dùng đã xác thực hoặc ứng dụng Chat gọi là thành viên. Để xác thực dưới dạng ứng dụng Chat, hãy thêm ứng dụng Chat vào không gian.
Apps Script
- Tài khoản Google Workspace Business hoặc Enterprise có quyền truy cập vào Google Chat.
- Thiết lập môi trường:
- Tạo một dự án trên Google Cloud.
- Định cấu hình màn hình đồng ý OAuth.
- Bật và định cấu hình Google Chat API bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat của bạn.
- Tạo một dự án Apps Script độc lập và bật Dịch vụ Chat nâng cao.
- Trong hướng dẫn này, bạn phải sử dụng quy trình xác thực người dùng hoặc ứng dụng. Để xác thực dưới dạng ứng dụng Chat, hãy tạo thông tin đăng nhập tài khoản dịch vụ. Để biết các bước, hãy xem phần Xác thực và uỷ quyền dưới dạng ứng dụng Google Chat.
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực với tư cách là người dùng hay ứng dụng Chat.
- Một không gian trên Google Chat mà người dùng đã xác thực hoặc ứng dụng Chat gọi là thành viên. Để xác thực dưới dạng ứng dụng Chat, hãy thêm ứng dụng Chat vào không gian.
Liệt kê các thành viên trong một không gian có xác thực người dùng
Để liệt kê người dùng, Nhóm Google và ứng dụng Chat trong một không gian mà người dùng đã xác thực có quyền truy cập, hãy truyền các thông tin sau trong yêu cầu của bạn:
- Với xác thực người dùng, hãy chỉ định phạm vi uỷ quyền
chat.memberships.readonly
hoặcchat.memberships
. - Gọi phương thức
ListMemberships()
. - Để liệt kê các Nhóm trên Google, hãy đặt tham số truy vấn
showGroups
thànhtrue
.
Ví dụ sau đây liệt kê các thành viên là nhóm trên Google, người dùng và ứng dụng mà người dùng đã xác thực có thể thấy.
Node.js
Python
Java
Apps Script
Để chạy mẫu này, hãy thay thế SPACE_NAME
bằng mã nhận dạng trong trường name
của không gian. Bạn có thể lấy mã nhận dạng bằng cách gọi phương thức ListSpaces()
hoặc từ URL của không gian.
Google Chat API trả về một danh sách gồm các thành viên là Google Group, người dùng và ứng dụng trong không gian được chỉ định.
Liệt kê các thành viên trong một không gian có xác thực ứng dụng
Để liệt kê người dùng và ứng dụng Chat trong một không gian mà ứng dụng đã xác thực có quyền truy cập, hãy truyền các thông tin sau trong yêu cầu của bạn:
- Với xác thực ứng dụng, hãy chỉ định phạm vi uỷ quyền
chat.bot
. - Gọi phương thức
ListMemberships()
. - Để liệt kê các Nhóm trên Google, hãy đặt tham số truy vấn
showGroups
thànhtrue
.
Ví dụ sau đây liệt kê các thành viên (không phải người quản lý) trong không gian mà ứng dụng Chat có thể nhìn thấy:
Node.js
Python
Java
Apps Script
Để chạy mẫu này, hãy thay thế SPACE_NAME
bằng mã nhận dạng trong trường name
của không gian. Bạn có thể lấy mã nhận dạng bằng cách gọi phương thức ListSpaces()
hoặc từ URL của không gian.
Google Chat API trả về một danh sách thành viên là người dùng (không bao gồm người quản lý không gian) trong không gian đã chỉ định.
Liệt kê thành viên với tư cách là quản trị viên Google Workspace
Nếu là quản trị viên Google Workspace, bạn có thể gọi phương thức ListMemberships()
để liệt kê tư cách thành viên của mọi không gian trong tổ chức Google Workspace của mình. Chat API chỉ trả về thông tin về thành viên (cả nội bộ và bên ngoài) hoặc Nhóm Google trong tổ chức của bạn, do đó, API này sẽ bỏ qua thông tin về thành viên của mọi ứng dụng Chat.
Để gọi phương thức này với tư cách là quản trị viên Google Workspace, hãy làm như sau:
- Gọi phương thức bằng cách sử dụng quy trình xác thực người dùng và chỉ định một phạm vi uỷ quyền hỗ trợ việc gọi phương thức bằng đặc quyền quản trị viên.
- Trong yêu cầu của bạn, hãy chỉ định các tham số truy vấn sau:
- Đặt
useAdminAccess
thànhtrue
. - Để chỉ trả về người dùng, hãy đặt
filter
chomember.type
bằngHUMAN
. - Để trả về người dùng và nhóm, hãy đặt
filter
chomember.type
không bằngBOT
AND
showGroups
bằngtrue
.
- Đặt
Để biết thêm thông tin và ví dụ, hãy xem bài viết Quản lý không gian trong Google Chat với tư cách là quản trị viên Google Workspace.
Tuỳ chỉnh phân trang hoặc lọc danh sách
Để liệt kê các thành viên, hãy truyền các tham số truy vấn sau để tuỳ chỉnh việc phân trang hoặc lọc các thành viên được liệt kê:
pageSize
: Số lượng tối đa các gói thành viên cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 100 không gian. Giá trị tối đa là 1.000; các giá trị lớn hơn 1.000 sẽ tự động thay đổi thành 1.000.pageToken
: Mã thông báo trang, nhận được từ một lệnh gọi danh sách không gian trước đó. Cung cấp mã thông báo này để truy xuất trang tiếp theo. Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc truyền một giá trị khác có thể dẫn đến kết quả không mong muốn.filter
: Bộ lọc truy vấn. Yêu cầu xác thực người dùng. Để biết thông tin chi tiết về truy vấn được hỗ trợ, hãy xem tài liệu tham khảoListMembershipsRequest
.
Chủ đề có liên quan
- Lấy thông tin chi tiết về tư cách thành viên của người dùng hoặc ứng dụng Chat.
- Mời hoặc thêm người dùng hoặc ứng dụng Chat vào một không gian.
- Cập nhật tư cách thành viên của người dùng trong một không gian trên Google Chat.
- Xoá người dùng hoặc ứng dụng Chat khỏi không gian.