本指南介绍了如何使用 Google Chat API 的 Media
资源中的 download
方法从 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 客户端库。
- 根据您希望在 Google Chat API 请求中进行身份验证的方式,创建访问凭据:
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
credentials.json
的 JSON 文件,保存到本地目录。 - 如需以 Chat 应用的身份进行身份验证,请创建服务账号凭据,并将凭据保存为名为
credentials.json
的 JSON 文件。
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
- 选择授权范围,具体取决于您是想以用户身份还是以 Chat 应用身份进行身份验证。
从文件附件下载
如需从文件附件中下载媒体,请在请求中传递以下内容:
- 使用用户身份验证时,请指定
chat.messages.readonly
或chat.messages
授权范围。使用应用身份验证,指定chat.bot
授权范围。 - 调用以下 Google Chat 方法:
- 通过调用以下方法之一来获取
attachmentDataRef
: - 对
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( 'credentials.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
,您可以通过以下任一方式检索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 获取文件访问权限。
- 以文件附件形式上传媒体
- 以文件附件的形式下载媒体
- 获取有关邮件附件的元数据