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 de solicitação, que é o
payload JSON que representa o evento de interação, incluindo quaisquer anexos. Os
dados no anexo serão diferentes se o anexo for um
conteúdo enviado por upload (um arquivo local) ou se for um arquivo 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
- pip (em inglês)
As bibliotecas de cliente mais recentes do Google para Python. Para instalá-los ou atualizá-los, execute o seguinte comando 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. Para ver as etapas, consulte Criar um app do Google Chat.
Autorização configurada para o app do Chat. O download de mídia oferece suporte a:
- Autenticação do usuário com o escopo de autorização
chat.messages.readonly
ouchat.messages
. - Autenticação de apps
com o escopo de autorização
chat.bot
.
- Autenticação do usuário com o escopo de autorização
Fazer o download de um anexo de arquivo
Para fazer o download de mídia de um anexo de arquivo, transmita o seguinte na solicitação:
- Com a autenticação do usuário, especifique o escopo de autorização
chat.messages.readonly
ouchat.messages
. Com a autenticação de apps, especifique o escopo de autorizaçãochat.bot
. - Chame os seguintes métodos do Google Chat:
- Receba
attachmentDataRef
chamando um dos seguintes métodos:- O método
get
no recursoAttachment
. - O método
get
ou o métodolist
no recursoMessage
.
- O método
- Chame o método
download
no recursoMedia
e especifique oattachmentDataRef.resourceName
recuperado anteriormente comomedia.download.resourceName
.
- Receba
O exemplo a seguir faz o download de um arquivo anexado a uma mensagem:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_media_and_attachment_download.py
. 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()
No código, substitua
RESOURCE_NAME
porattachmentDataRef.resourceName
, que é possível extrair de uma das seguintes maneiras:- O método
get
no recursoAttachment
. - O método
get
no recursoMessage
. - O método
list
no recursoMessage
.
- O método
No diretório de trabalho, crie e execute o exemplo:
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 você precisar 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çalhoRange
, por exemplo:Range: bytes=500-999
.
Temas relacionados
- Se a mensagem for um arquivo do Drive, use a API Drive para acessar o arquivo.
- Fazer upload de mídia como um anexo de arquivo
- Fazer o download de mídia como um anexo de arquivo
- Acessar metadados sobre um anexo de mensagem