Fazer o download de mídia de um arquivo anexado

Este guia explica como usar o método download no recurso Media da API Google Chat para fazer o download de mídia (um arquivo) de uma mensagem no Google Chat.

Quando o usuário envia uma mensagem para seu app, o Google Chat envia um evento de interação MESSAGE. O evento de interação recebido pelo app inclui um corpo da solicitação, que é o payload JSON que representa o evento de interação, incluindo todos os anexos. Os dados no anexo serão diferentes se for conteúdo enviado por upload (um arquivo local) ou armazenado no Drive. O recurso Media representa um arquivo enviado para o Google Chat, como imagens, vídeos e documentos. O recurso Attachment representa uma instância de mídia (um arquivo) anexada a uma mensagem. O recurso Attachment inclui os metadados sobre o anexo, como o local em que ele é salvo.

Pré-requisitos

Python

  • Python 3.6 ou superior
  • A ferramenta de gerenciamento de pacotes pip
  • As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    
  • Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.
  • Autorização configurada para o app do Chat. O download de mídia é compatível com:

Fazer o download a partir de um arquivo anexado

Para fazer o download de mídia de um anexo, transmita o seguinte na solicitação:

No exemplo a seguir, é feito o download de um arquivo anexado a uma mensagem:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_media_and_attachment_download.py.
  2. Inclua o seguinte código em 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. No código, substitua RESOURCE_NAME por attachmentDataRef.resourceName, que pode ser recuperado de uma das seguintes maneiras:

  4. No diretório de trabalho, crie e execute a amostra:

    python3 chat_media_and_attachment_download.py
    

Se for bem-sucedido, esse método retornará o conteúdo do arquivo como bytes.

Para fazer o download do conteúdo do arquivo, escolha uma das seguintes abordagens:

  • Recomendamos usar a classe MediaIoBaseDownload no Python, que contém métodos para fazer o download do arquivo em seções e salvar o conteúdo em um stream de saída.

  • Se for necessário fazer a solicitação HTTP manualmente, chame o método download e especifique a parte do arquivo que você quer transferir por download usando um intervalo de bytes com o cabeçalho Range. Por exemplo: Range: bytes=500-999.