本指南介绍了如何使用 Google Chat API 的 Media
资源中的 download
方法下载 Google Chat 消息中的媒体内容(文件)。
当用户向您的应用发送消息时,Google Chat 会分派 MESSAGE
互动事件。应用收到的互动事件包括请求正文,这是表示互动事件(包括所有附件)的 JSON 载荷。根据附件是上传的内容(本地文件)还是存储在云端硬盘中的文件,附件中的数据会有所不同。Media
资源表示上传到 Google Chat 的文件,例如图片、视频和文档。Attachment
资源表示附加到消息的媒体(即文件)实例。Attachment
资源包含有关连接的元数据,例如其保存位置。
前提条件
Python
- Python 3.6 或更高版本
- pip 软件包管理工具
适用于 Python 的最新 Google 客户端库。如需安装或更新它们,请在命令行界面中运行以下命令:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- 一个已启用并配置了 Google Chat API 的 Google Cloud 项目。如需了解相关步骤,请参阅构建 Google Chat 应用。
为 Chat 应用配置的授权。 媒体下载支持:
通过文件附件下载
如需从文件附件下载媒体内容,请在请求中传递以下内容:
- 使用用户身份验证时,指定
chat.messages.readonly
或chat.messages
授权范围。使用应用身份验证时,请指定chat.bot
授权范围。 - 调用以下 Google Chat 方法:
- 通过调用以下方法之一来获取
attachmentDataRef
:- 针对
Attachment
资源的get
方法。 - 针对
Message
资源的get
方法或list
方法。
- 针对
- 对
Media
资源调用download
方法,并将之前检索的attachmentDataRef.resourceName
指定为media.download.resourceName
。
- 通过调用以下方法之一来获取
以下示例会下载附加到邮件的文件:
Python
- 在您的工作目录中,创建一个名为
chat_media_and_attachment_download.py
的文件。 在
chat_media_and_attachment_download.py
中添加以下代码:import io from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.http import MediaIoBaseDownload # 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"] def main(): ''' Authenticates with Chat API via user credentials, then downloads a file attached to a 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. chat = build('chat', 'v1', credentials=creds) # Download media resource. request = chat.media().download_media( resourceName=RESOURCE_NAME, ) file = io.BytesIO() downloader = MediaIoBaseDownload(file, request) done = False while done is False: status, done = downloader.next_chunk() if status.total_size: print(f'Total size: {status.total_size}') print(f'Download {int(status.progress() * 100)}') if __name__ == '__main__': main()
在代码中,将
RESOURCE_NAME
替换为attachmentDataRef.resourceName
,您可以通过以下某种方式检索其内容:- 针对
Attachment
资源的get
方法。 - 针对
Message
资源的get
方法。 - 针对
Message
资源的list
方法。
- 针对
在您的工作目录中,构建并运行该示例:
python3 chat_media_and_attachment_download.py
如果成功,此方法会以字节形式返回文件内容。
如需下载文件内容,请选择以下方法之一:
建议使用 Python 中的
MediaIoBaseDownload
类,该类包含按部分下载文件并将内容保存到输出流的方法。如果必须手动发出 HTTP 请求,请调用
download
方法,并使用带有Range
标头的字节范围指定要下载的文件部分,例如:Range: bytes=500-999
。
相关主题
- 如果消息是云端硬盘文件,请使用 Drive API 获取文件的访问权限。
- 以文件附件的形式上传媒体内容
- 将媒体内容下载为文件附件
- 获取邮件附件的相关元数据