下载文件附件中的媒体内容

本指南介绍了如何对 Google Chat API 的 Media 资源使用 download 方法,从 Google Chat 中的消息下载媒体内容(文件)。

当用户向您的应用发送消息时,Google Chat 会分派 MESSAGE 互动事件。您的应用收到的互动事件包含请求正文,即表示互动事件的 JSON 载荷,包括所有附件。附件中的数据因附件是上传内容(本地文件)还是存储在云端硬盘中的文件而异。Media 资源表示上传到 Google Chat 的文件,例如图片、视频和文档。Attachment 资源表示附加到消息中的媒体实例(文件)。Attachment 资源包含有关附件的元数据,例如其保存位置。

前提条件

Python

从文件附件下载

如需下载文件附件中的媒体内容,请在请求中传递以下内容:

以下示例会下载消息附加的文件:

Python

  1. 在工作目录中,创建一个名为 chat_media_and_attachment_download.py 的文件。
  2. 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()
    
  3. 在代码中,将 RESOURCE_NAME 替换为 attachmentDataRef.resourceName,您可以通过以下任一方式检索 attachmentDataRef.resourceName

  4. 在工作目录中,构建并运行示例:

    python3 chat_media_and_attachment_download.py

如果成功,此方法会以字节形式返回文件内容。

如需下载文件内容,请选择以下方法之一:

  • 我们建议在 Python 中使用 MediaIoBaseDownload 类,该类包含用于分段下载文件并将内容保存到输出流的方法。

  • 如果您必须手动发出 HTTP 请求,请调用 download 方法,并使用 Range 标头中的字节范围指定要下载的文件部分,例如:Range: bytes=500-999