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 và có thể lọc trong một không gian.
Tài nguyên Message
đại diện cho một thông báo văn bản hoặc thẻ trong Google Chat. Bạn có thể create
, get
, update
hoặc delete
cho tin nhắn trong API Google Chat bằng cách gọi các phương thức tương ứng. Để tìm hiểu thêm về tin nhắn văn bản và tin nhắn bằng thẻ, hãy xem bài viết Tổng quan về tin nhắn trong Google Chat.
Điều kiện tiên quyết
Python
- Python 3.6 trở lên
- Công cụ quản lý gói pip
Các thư viện ứng dụng mới nhất của Google dành cho Python. Để cài đặt hoặc cập nhật các công cụ này, hãy chạy lệnh sau trong giao diện dòng lệnh của bạn:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Một dự án trên Google Cloud đã bật và thiết lập API Google Chat. Để biết các bước, hãy xem bài viết Tạo ứng dụng Google Chat.
Đã định cấu hình hoạt động uỷ quyền cho ứng dụng Chat. Việc liệt kê các thông báo yêu cầu Xác thực người dùng trong phạm vi uỷ quyền
chat.messages.readonly
hoặcchat.messages
.
Liệt kê tin nhắn
Để liệt kê các thông báo được xác thực người dùng, hãy chuyển thông tin sau đây trong 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ên tài nguyênMessage
.
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ã, hãy thay thế
SPACE
bằng tên không gian. Bạn có thể lấy tên này từ phương thứcspaces.list
trong API Chat hoặc từ URL của 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 Google Chat trả về danh sách tin nhắn được gửi trong không gian chỉ định sau ngày 16 tháng 3 năm 2023.