Hướng dẫn này giải thích cách sử dụng phương thức upload trên tài nguyên Media của Google Chat API để tải tệp đa phương tiện (tệp) lên Google Chat, sau đó đính kèm tệp đó vào một tin nhắn.
Khi người dùng gửi tin nhắn đến ứng dụng của bạn, Google Chat sẽ gửi sự kiện tương tác
MESSAGE.
Sự kiện tương tác mà ứng dụng của bạn nhận được bao gồm một nội dung yêu cầu, là tải trọng JSON đại diện cho sự kiện tương tác, bao gồm mọi tệp đính kèm. Dữ liệu trong tệp đính kèm sẽ khác nhau tuỳ thuộc vào việc tệp đính kèm là nội dung đã tải lên (tệp cục bộ) hay là tệp được lưu trữ trên Drive. Tài nguyên
Media đại diện cho một tệp được tải lên Google Chat, chẳng hạn như hình ảnh, video và tài liệu.
Tài nguyên
Attachment
đại diện cho một thực thể của tệp đa phương tiện (tệp) được đính kèm vào một tin nhắn. Tài nguyên Attachment bao gồm siêu dữ liệu về tệp đính kèm, chẳng hạn như vị trí lưu tệp.
Điều kiện tiên quyết
Python
- 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 Google Chat API 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 API Python.
-
Tạo thông tin xác thực mã ứng dụng khách OAuth cho ứng dụng trên máy tính. Để chạy mẫu trong hướng dẫn này, hãy lưu thông tin xác thực dưới dạng tệp JSON có tên là
credentials.jsonvào thư mục cục bộ.
- Chọn một phạm vi uỷ quyền hỗ trợ xác thực người dùng.
Tải lên dưới dạng tệp đính kèm
Để tải tệp đa phương tiện lên và đính kèm vào một tin nhắn, hãy truyền các thông tin sau trong yêu cầu:
- Chỉ định phạm vi uỷ quyền
chat.messages.createhoặcchat.messages. - Gọi các phương thức sau của Google Chat:
- Để tải tệp lên, hãy gọi phương thức
uploadtrên tài nguyênMedia.- Đặt
parentthành tên không gian của không gian lưu trữ tệp. - Trong
body(nội dung yêu cầu), hãy đặtfilenamethành tên của tệp đính kèm đã tải lên. - Đặt
media_bodylàm một thực thể của tệp cần tải lên.
- Đặt
- Để tạo một tin nhắn có tệp đã tải lên được đính kèm, hãy gọi phương thức
createtrên tài nguyênMessages.
- Để tải tệp lên, hãy gọi phương thức
Ví dụ sau đây tải một tệp hình ảnh PNG lên và đính kèm vào một tin nhắn.
Python
- Trong thư mục làm việc, hãy tạo một tệp có tên là
chat_media_and_attachment_upload.py. Thêm mã sau vào
chat_media_and_attachment_upload.py:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.http import MediaFileUpload # 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.create"] def main(): ''' Authenticates with Chat API via user credentials, then uploads a file as media, creates a message, and attaches the file to the message. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'credentials.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. service = build('chat', 'v1', credentials=creds) # Upload a file to Google Chat. media = MediaFileUpload('test_image.png', mimetype='image/png') # Create a message and attach the uploaded file to it. attachment_uploaded = service.media().upload( # The space to upload the attachment in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. parent='spaces/SPACE', # The filename of the attachment, including the file extension. body={'filename': 'test_image.png'}, # Media resource of the attachment. media_body=media ).execute() print(attachment_uploaded) # Create a Chat message with attachment. result = service.spaces().messages().create( # The space to create the message in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Must match the space name that the attachment is uploaded to. parent='spaces/SPACE', # The message to create. body={ 'text': 'Hello, world!', 'attachment': [attachment_uploaded] } ).execute() print(result) if __name__ == '__main__': main()Trong mã, hãy thay thế
SPACEbằng tên không gian để tải tệp đính kèm lên. Bạn có thể lấy tên này từ phương thứcspaces.listtrong Chat API hoặc từ URL của một không gian.Trong thư mục làm việc, hãy tạo và chạy mẫu:
python3 chat_media_and_attachment_upload.py
Chat API trả về một nội dung phản hồi chứa attachmentDataRef với thông tin chi tiết về tệp đã tải lên.
Giới hạn và lưu ý
Khi chuẩn bị tải tệp lên và đính kèm vào tin nhắn, hãy lưu ý những giới hạn và lưu ý sau:
- Bạn có thể tải tệp có kích thước tối đa 200 MB.
- Một số loại tệp không được hỗ trợ và không thể tải lên. Để biết thông tin chi tiết, hãy xem Các loại tệp bị chặn trong Google Chat.
- Tin nhắn của bạn phải bỏ qua các tiện ích phụ kiện.