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 Message
của
API Google Chat để xem danh sách tin nhắn được phân trang, có thể lọc trong một không gian.
Chiến lược phát hành đĩa đơn
Tài nguyên Message
biểu thị một
văn bản
hoặc
thẻ
tin nhắn trong Google Chat. Bạn có thể
create
, get
, update
hoặc delete
một tin nhắn trong API Google Chat bằng cách gọi
tương ứng. Để tìm hiểu thêm về tin nhắn văn bản và tin nhắn thẻ, hãy xem
Tổng quan về tin nhắn trong Google Chat.
Điều kiện tiên quyết
Python
- Doanh nghiệp Tài khoản Google Workspace có quyền truy cập vào Google Chat.
- Python 3.6 trở lên
- Công cụ quản lý gói pip
- Thư viện ứng dụng mới nhất của Google. Cách cài đặt hoặc cập nhật các tính năng này:
chạy lệnh sau trong giao diện dòng lệnh:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- 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.
-
Tạo thông tin xác thực mã ứng dụng khách OAuth cho một ứng dụng dành cho máy tính. Để chạy mẫu trong
hãy lưu thông tin đăng nhập dưới dạng tệp JSON (
client_secrets.json
) vào thư mục nội bộ.
- Chọn phạm vi uỷ quyền có hỗ trợ việc xác thực người dùng.
Liệt kê tin nhắn
Để liệt kê thông báo bằng xác thực người dùng, chuyển nội dung sau vào yêu cầu của bạn:
- Chỉ định phạm vi uỷ quyền
chat.messages.readonly
hoặcchat.messages
. - Gọi
Phương thức
list
trênMessage
tài nguyên.
Ví dụ sau đây liệt kê các tin nhắn trong một phòng Chat được gửi sau Ngày 16 tháng 3 năm 2023:
Python
- Trong thư mục đang làm việc, hãy tạo một tệp có tên
chat_messages_list.py
. Đưa mã sau vào
chat_messages_list.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists messages in a space sent after March 16, 2023. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().messages().list( # The space for which to list messages. parent = 'spaces/SPACE', # An optional filter that returns messages # created after March 16, 2023. filter = 'createTime > "2023-03-16T00:00:00-00:00"' ).execute() # Prints the list of messages. print(result) if __name__ == '__main__': main()
Trong mã, thay thế
SPACE
bằng tên không gian, mà bạn có thể lấy từ Phương thứcspaces.list
trong API Chat hoặc qua URL của một không gian.Trong thư mục đang làm việc, hãy tạo và chạy mẫu:
python3 chat_messages_list.py
API Chat trả về danh sách tin nhắn được gửi trong không gian được chỉ định
sau ngày 16 tháng 3 năm 2023. Nếu không có tin nhắn nào từ yêu cầu,
Phản hồi của API Chat trả về một đối tượng trống. Khi sử dụng
Giao diện REST/HTTP, phản hồi có chứa đối tượng JSON trống, {}
.