Este guia explica como usar o método download
no recurso Media
da
a API Google Chat para fazer o download da mídia (um arquivo) de uma mensagem no Google Chat.
Quando o usuário envia uma mensagem para seu app, o Google Chat envia uma
Evento de interação MESSAGE
.
O evento de interação recebido pelo seu aplicativo inclui um corpo de solicitação, que é o
Payload JSON que representa o evento de interação, incluindo qualquer anexo. A
os dados no anexo serão diferentes se ele for
conteúdo enviado por upload (arquivo local) ou armazenado no Drive. A
Recurso Media
representa um arquivo enviado para o Google Chat, como imagens, vídeos e documentos.
A
Recurso Attachment
representa uma instância de mídia (um arquivo) anexada a uma mensagem. O Attachment
recurso inclui os metadados sobre o anexo, como
onde eles serão salvos.
Pré-requisitos
Python
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome. o ícone e a descrição do app do Chat.
- Instale o Python biblioteca de cliente das APIs do Google.
- Crie credenciais de acesso com base em como você quer autenticar sua API Google Chat
solicitação:
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credenciais e salvá-las como um arquivo JSON chamado
client_secrets.json
ao diretório local. - Para autenticar como o app do Chat, faça o seguinte:
criar conta de serviço
credenciais e salvá-las como um arquivo JSON chamado
credentials.json
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credenciais e salvá-las como um arquivo JSON chamado
- Escolha um escopo de autorização para autenticar como usuário ou como App Chat.
Fazer o download de um anexo de arquivo
Para fazer o download de mídia de um anexo, transmita o seguinte no seu solicitação:
- Com a autenticação do usuário, especifique
escopo de autorização
chat.messages.readonly
ouchat.messages
. Com autenticação de apps especificar 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(a) RecursoAttachment
. - O método
get
ou o Métodolist
no(a) RecursoMessage
.
- O método
- Chame o método
download
. no(a)Media
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
- Em seu 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 recuperar um dos da seguinte maneira:- 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 o uso do A classe
MediaIoBaseDownload
no Python, que contém métodos para fazer o download o 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 deseja baixar usando um byte intervalo com o cabeçalhoRange
, por exemplo:Range: bytes=500-999
.
Temas relacionados
- Se a mensagem for um arquivo do Drive, use o API Drive para ter acesso ao 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