添付ファイルからメディアをダウンロードする

このガイドでは、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_NAMEattachmentDataRef.resourceName に置き換えます。attachmentDataRef.resourceName は、次のいずれかの方法で取得できます。

  4. 作業ディレクトリで、サンプルをビルドして実行します。

    python3 chat_media_and_attachment_download.py

成功すると、このメソッドはファイルの内容をバイト単位で返します。

ファイルの内容をダウンロードするには、次のいずれかの方法を選択します。

  • Python の MediaIoBaseDownload クラスを使用することをおすすめします。このクラスには、ファイルをセクションごとにダウンロードし、コンテンツを出力ストリームに保存するメソッドが含まれています。

  • HTTP リクエストを手動で行う必要がある場合は、download メソッドを呼び出し、Range ヘッダーでバイト範囲を使用して、ダウンロードするファイルの部分を指定します(例: Range: bytes=500-999)。