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ê 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.
- Việc liệt kê gói thành viên bằng tính năng xác thực ứng dụng sẽ liệt kê các gói thành viên trong những không gian mà ứng dụng Chat có quyền truy cập, nhưng loại trừ các gói thành viên của ứng dụng Chat, bao gồm cả gói thành viên của chính ứng dụng đó.
- Tính năng liệt kê gói thành viên có quy trình xác thực người dùng sẽ liệt kê các gói 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.
- Liệt kê tư cách thành viên trong vai trò quản trị viên Google Workspace có phương thức xác thực người dùng bằng đặc quyền của quản trị viên sẽ liệt kê tư cách thành viên trên mọi 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 hoặc ứng dụng Google Chat có được mời tham gia, có tham gia hay không tham gia không gian hay không.
Điều kiện tiên quyết
Node.js
- Tài khoản Google Workspace dành cho doanh nghiệp hoặc doanh nghiệp lớn có quyền truy cập vào Google Chat.
- Thiết lập môi trường:
- Tạo dự án trên Google Cloud.
- Định cấu hình màn hình xin phép bằng OAuth.
- Bật và định cấu hình API Google Chat bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat.
- Cài đặt Thư viện ứng dụng đám mây Node.js.
- Tạo thông tin xác thực quyền truy cập dựa trên cách bạn muốn xác thực trong yêu cầu API Google Chat:
- Để xác thực là người dùng Chat, hãy tạo thông tin đăng nhập cho mã ứng dụng OAuth rồi lưu thông tin đăng nhập dưới dạng tệp JSON có tên
client_secrets.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 xác thực tài khoản dịch vụ và lưu thông tin xác thực dưới dạng tệp JSON có tên
credentials.json
.
- Để xác thực là người dùng Chat, hãy tạo thông tin đăng nhập cho mã ứng dụng OAuth rồi lưu thông tin đăng nhập dưới dạng tệp JSON có tên
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực dưới dạng người dùng hay ứng dụng Chat.
- Phòng Google Chat trong đó người dùng đã xác thực hoặc gọi ứng dụng Chat 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 dành cho doanh nghiệp hoặc doanh nghiệp 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 xin phép bằng OAuth.
- Bật và định cấu hình API Google Chat bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat.
- Cài đặt Python Thư viện ứng dụng đám mây.
- Tạo thông tin xác thực quyền truy cập dựa trên cách bạn muốn xác thực trong yêu cầu API Google Chat:
- Để xác thực là người dùng Chat, hãy tạo thông tin đăng nhập cho mã ứng dụng OAuth rồi lưu thông tin đăng nhập dưới dạng tệp JSON có tên
client_secrets.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 xác thực tài khoản dịch vụ và lưu thông tin xác thực dưới dạng tệp JSON có tên
credentials.json
.
- Để xác thực là người dùng Chat, hãy tạo thông tin đăng nhập cho mã ứng dụng OAuth rồi lưu thông tin đăng nhập dưới dạng tệp JSON có tên
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực dưới dạng người dùng hay ứng dụng Chat.
- Phòng Google Chat trong đó người dùng đã xác thực hoặc gọi ứng dụng Chat 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 dành cho doanh nghiệp hoặc doanh nghiệp 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 xin phép bằng OAuth.
- Bật và định cấu hình API Google Chat bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat.
- Cài đặt Thư viện ứng dụng đám mây Java.
- Tạo thông tin xác thực quyền truy cập dựa trên cách bạn muốn xác thực trong yêu cầu API Google Chat:
- Để xác thực dưới dạng 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
client_secrets.json
vào thư mục cục bộ. - Để xác thực dưới dạng ứng dụng Chat, hãy tạo thông tin xác thực tài khoản dịch vụ và lưu thông tin xác thực dưới dạng tệp JSON có tên
credentials.json
.
- Để xác thực dưới dạng 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
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực là người dùng hay ứng dụng Chat.
- Một không gian 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 dành cho doanh nghiệp hoặc doanh nghiệp lớn có quyền truy cập vào Google Chat.
- Thiết lập môi trường:
- Tạo dự án trên Google Cloud.
- Định cấu hình màn hình xin phép bằng OAuth.
- Bật và định cấu hình API Google Chat bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat.
- Tạo một dự án Apps Script độc lập và bật Dịch vụ trò chuyện 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 xác thực tài khoản dịch vụ. Để biết các bước, hãy xem bài viết 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 là người dùng hay ứng dụng Chat.
- Một không gian 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ê 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, Google Groups và ứng dụng Chat trong không gian mà người dùng đã xác thực có quyền truy cập, hãy truyền nội dung sau vào yêu cầu của bạn:
- Với tính năng 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ê Google Groups, hãy đặt tham số truy vấn
showGroups
thànhtrue
.
Ví dụ sau đây liệt kê các thành viên Google Group, thành viên là người dùng và thành viên là ứ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.
API Google Chat trả về một danh sách các thành viên là người dùng, ứng dụng và Google Groups trong không gian đã chỉ định.
Liệt kê thành viên trong một không gian có tính năng xác thực bằng ứ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 nội dung sau vào yêu cầu của bạn:
- Với tính năng 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ê Google Groups, 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 gian là con người (không phải người quản lý không gian) mà ứng dụng Chat 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.
API Google Chat trả về một danh sách thành viên không gian là con người (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 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ê gói thành viên cho bất kỳ không gian nào trong tổ chức Google Workspace của mình. API Chat chỉ trả về thông tin về tư cách thành viên của người dùng (cả nội bộ và bên ngoài) hoặc Google Groups trong tổ chức của bạn, do đó bỏ qua tư cách 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 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 quyền quản trị viên.
- Trong yêu cầu, 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 Google Chat với tư cách là quản trị viên Google Workspace.
Tuỳ chỉnh tính năng phân trang hoặc lọc danh sách
Để liệt kê các gói thành viên, hãy truyền các tham số truy vấn sau để tuỳ chỉnh tính năng phân trang hoặc lọc các gói thành viên được liệt kê:
pageSize
: Số lượng gói thành viên tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, hệ thống sẽ trả về tối đa 100 dấu cách. 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 không gian danh sách 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 chuyể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ảo vềListMembershipsRequest
.
Chủ đề có liên quan
- Tìm hiểu thông tin chi tiết về gói 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 trong Chat vào không gian.
- Cập nhật gói thành viên của người dùng trong phòng Google Chat.
- Xoá người dùng hoặc ứng dụng Chat khỏi không gian.