Download media from a file attachment

Python

• A Business or Enterprise Google Workspace account with access to Google Chat.

• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Install the Python Google API Client Library.
  • Create access credentials based on how you want to authenticate in your Google Chat API request:
    • To authenticate as a Chat user, create OAuth client ID credentials and save the credentials as a JSON file named client_secrets.json to your local directory.
    • To authenticate as the Chat app, create service account credentials and save the credentials as a JSON file named credentials.json.
• Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

Python

1. In your working directory, create a file named chat_media_and_attachment_download.py.

2. Include the following code in 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. In the code, replace RESOURCE_NAME with attachmentDataRef.resourceName, which you can retrieve one of the following ways:

   • The get method on the Attachment resource.
   • The get method on the Message resource.
   • The list method on the Message resource.

4. In your working directory, build and run the sample:

   python3 chat_media_and_attachment_download.py