本指南說明如何在 Google Chat API 的 Media
資源上使用 upload
方法,將媒體 (檔案) 上傳至 Google Chat,然後附加至訊息。
當使用者傳送訊息給您的應用程式時,Google Chat 會調度 MESSAGE
互動事件。應用程式收到的互動事件包含要求內文,也就是代表互動事件的 JSON 酬載,包括任何附件。附件中的資料會因附件是上傳內容 (本機檔案) 或儲存在雲端硬碟中的檔案而有所不同。Media
資源代表上傳至 Google Chat 的檔案,例如圖片、影片和文件。Attachment
資源代表附加至訊息的媒體例項 (檔案)。Attachment
資源包含附件的中繼資料,例如儲存位置。
必要條件
Python
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Python Google API 用戶端程式庫。
-
為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要執行本指南中的範例,請將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至本機目錄。
- 選擇支援使用者驗證的授權範圍。
上傳為檔案附件
如要上傳媒體並附加至訊息,請在要求中傳遞以下內容:
- 指定
chat.messages.create
或chat.messages
授權範圍。 - 呼叫下列 Google Chat 方法:
以下範例會上傳 PNG 圖片檔案,並將其附加至訊息。
Python
- 在工作目錄中,建立名為
chat_media_and_attachment_upload.py
的檔案。 在
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( 'client_secrets.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()
在程式碼中,將
SPACE
替換為上傳附件的聊天室名稱,您可以透過 Chat API 中的spaces.list
方法或聊天室網址取得該名稱。在工作目錄中建構並執行範例:
python3 chat_media_and_attachment_upload.py
Chat API 會傳回回應主體,其中包含 attachmentDataRef
,內含上傳檔案的詳細資料。
限制和注意事項
準備上傳檔案並附加至訊息時,請注意下列限制和注意事項:
- 上傳的檔案大小上限為 200 MB。
- 系統不支援部分檔案類型,因此無法上傳。詳情請參閱「Google Chat 封鎖的檔案類型」。
- 訊息中不得出現配件小工具。