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 các không gian có thể lọc và được 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 giữa một người dùng và một ứ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à các ứng dụng Chat.
- Không gian có tên là những nơi cố định để mọi người gửi tin nhắn, chia sẻ tệp và cộng tác.
Việc liệt kê các 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. Việc liệt kê các không gian bằng tính năng xác thực người dùng sẽ liệt kê những 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 Business hoặc Enterprise có quyền truy cập vào Google Chat.
- Thiết lập môi trường của bạn:
- 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 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 API Google Chat:
- Để xác thực với tư cách là người dùng Chat,
hãy tạo thông tin đăng nhập mã ứng dụng OAuth và lưu thông tin đăng nhập dưới dạng tệp JSON có tên
credentials.jsonvào thư mục cục bộ. - Để xác thực với tư cách là ứ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 đăng nhập mã ứng dụng OAuth và 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 với tư cách là người dùng hay ứng dụng Chat.
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 của bạn:
- 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 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 API Google Chat:
- Để xác thực với tư cách là người dùng Chat,
hãy tạo thông tin đăng nhập mã ứng dụng OAuth và lưu thông tin đăng nhập dưới dạng tệp JSON có tên
credentials.jsonvào thư mục cục bộ. - Để xác thực với tư cách là ứ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 đăng nhập mã ứng dụng OAuth và 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 với tư cách là người dùng hay ứng dụng Chat.
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 của bạn:
- 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 đă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 API Google Chat:
- Để xác thực với tư cách là người dùng Chat,
hãy tạo thông tin đăng nhập mã ứng dụng OAuth và lưu thông tin đăng nhập dưới dạng tệp JSON có tên
credentials.jsonvào thư mục cục bộ. - Để xác thực với tư cách là ứ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 đăng nhập mã ứng dụng OAuth và 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 với tư cách là người dùng hay ứng dụng Chat.
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 của bạn:
- 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.
- Tạo một dự án Apps Script độc lập, và bật Dịch vụ nâng cao của Chat.
- Trong hướng dẫn này, bạn phải sử dụng tính năng xác thực người dùng hoặc ứng dụng. Để xác thực với tư cách là ứ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 bài viết Xác thực và uỷ quyền với tư cách là ứ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.
Liệt kê các không gian bằng tính năng xác thực người dùng
Để liệt kê các không gian trong Google Chat, hãy truyền các thông tin sau trong 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.readonlyhoặ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 liệt kê cuộc trò chuyện nhóm và tin nhắn trực tiếp, vì các không gian này đã được lọc ra) mà người dùng đã xác thực có thể nhìn thấy:
Node.js
Python
Java
Apps Script
API Chat trả về một danh sách các không gian được phân trang.
Liệt kê các không gian bằng tính năng xác thực ứng dụng
Để liệt kê các không gian trong Google Chat, hãy truyền các thông tin sau trong 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 liệt kê cuộc trò chuyện nhóm và tin nhắn trực tiếp) mà ứng dụng Chat có thể nhìn thấy:
Node.js
Python
Java
Apps Script
API Chat trả về một danh sách các 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 tham số truy vấn không bắt buộc sau đây để tuỳ chỉnh tính năng phân trang hoặc lọc các không gian được liệt kê:
pageSize: Số lượng không gian 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 không gian. 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 liệt kê 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. Để biết thông tin chi tiết về truy vấn được hỗ trợ, hãy xem tài liệu tham khảoListSpacesRequest.
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.