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

本指南介绍了如何在 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 应用配置授权。 下载媒体支持以下两种方法：

通过文件附件下载

如需从文件附件下载媒体内容，请在请求中传递以下内容：

以下示例会下载邮件中附加的文件：

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，您可以通过以下方法之一检索：

  4. 在您的工作目录中，构建并运行示例：

    python3 chat_media_and_attachment_download.py

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

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

  • 我们建议在 Python 中使用 MediaIoBaseDownload 类，其中包含分节下载文件和将内容保存到输出流的方法。

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