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 Space
của API Google Chat để liệt kê các không gian. Việc liệt kê các không gian sẽ trả về một danh sách không gian có thể lọc và phân trang.
Tài nguyên Space
đại diện cho một nơi mà mọi người và ứng dụng Chat có thể gửi tin nhắn, chia sẻ tệp và cộng tác. Có một số loại không gian:
- Tin nhắn trực tiếp (DM) là cuộc trò chuyện giữa hai người dùng hoặc một người dùng và ứng dụng Chat.
- Cuộc trò chuyện nhóm là cuộc trò chuyện giữa 3 người dùng trở lên và ứng dụng Chat.
- Không gian được đặt tên là những nơi ổn định để mọi người gửi tin nhắn, chia sẻ tệp và cộng tác.
Liệt kê không gian bằng tính năng xác thực ứng dụng sẽ liệt kê những không gian mà ứng dụng Chat có quyền truy cập. Liệt kê các không gian có Xác thực người dùng sẽ liệt kê các không gian mà người dùng đã xác thực có quyền truy cập.
Đ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 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 khách 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 khách 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 dưới dạng người dùng hay ứng dụng Chat.
Python
- 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 Google Cloud cho Python.
- Tạo thông tin xác thực 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 khách 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 khách 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 dưới dạng người dùng hay ứng dụng Chat.
Java
- 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 Google Cloud cho Java.
- Tạo thông tin xác thực 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 khách 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 khách 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 dưới dạng người dùng hay ứng dụng Chat.
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 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 dưới dạng người dùng hay ứng dụng Chat.
Liệt kê các không gian có xác thực người dùng
Để liệt kê các không gian trong Google Chat, hãy truyền nội dung sau vào yêu cầu:
- 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.spaces.readonly
hoặcchat.spaces
. - Gọi phương thức
ListSpaces()
.
Ví dụ sau đây liệt kê các không gian có tên (nhưng không phải cuộc trò chuyện nhóm và tin nhắn trực tiếp, các không gian này bị lọc ra) mà người dùng đã xác thực có thể thấy:
Node.js
Python
Java
Apps Script
Chat API trả về một danh sách không gian được phân trang.
Liệt kê không gian có xác thực ứng dụng
Để liệt kê các không gian trong Google Chat, hãy truyền nội dung sau vào yêu cầu:
- 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
ListSpaces()
.
Ví dụ sau đây liệt kê các không gian có tên (nhưng không phải cuộc trò chuyện nhóm và tin nhắn trực tiếp) mà ứng dụng Chat có thể thấy:
Node.js
Python
Java
Apps Script
Chat API trả về một danh sách không gian được phân trang.
Tuỳ chỉnh tính năng phân trang hoặc lọc danh sách
Để liệt kê các không gian trong Google Chat, hãy truyền các thông số truy vấn không bắt buộc sau đây để tuỳ chỉnh phân trang hoặc lọc các không gian được liệt kê:
pageSize
: Số lượng khoảng trắng 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ị cao hơn 1.000 sẽ tự động được thay đổi thành 1.000.pageToken
: Mã thông báo trang, nhận được 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 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. Để 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ềListSpacesRequest
.
Chủ đề có liên quan
- Tạo không gian.
- Thiết lập không gian.
- Xem thông tin chi tiết về một không gian.
- Cập nhật không gian.
- Xoá không gian.
- Tìm không gian tin nhắn trực tiếp.