En esta guía, se explica cómo usar el método download
en el recurso Media
de la API de Google Chat para descargar contenido multimedia (un archivo) de un mensaje en Google Chat.
Cuando el usuario envía un mensaje a tu app, Google Chat envía un evento de interacción MESSAGE
.
El evento de interacción que recibe tu app incluye un cuerpo de solicitud, que es la carga útil de JSON que representa el evento de interacción, incluidos los archivos adjuntos. Los datos del archivo adjunto son diferentes según si se trata de contenido subido (un archivo local) o de un archivo almacenado en Drive. El recurso Media
representa un archivo subido a Google Chat, como imágenes, videos y documentos.
El recurso Attachment
representa una instancia de contenido multimedia (un archivo) adjunto a un mensaje. El recurso Attachment
incluye los metadatos sobre el archivo adjunto, como dónde se guarda.
Requisitos previos
Python
- Una cuenta de Google Workspace para empresas o empresas con acceso a Google Chat
- Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
- Instala la biblioteca cliente de la API de Google para Python.
- Crea credenciales de acceso según la forma en que deseas autenticarte en tu solicitud a la API de Google Chat:
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
client_secrets.json
en tu directorio local. - Para autenticarte como la app de Chat,
crea credenciales de cuenta de servicio y guárdalas como un archivo JSON con el nombre
credentials.json
.
- Para autenticarte como usuario de Chat,
crea credenciales de ID de cliente de
OAuth y guárdalas como un archivo JSON llamado
- Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.
Cómo descargar desde un archivo adjunto
Para descargar contenido multimedia de un archivo adjunto, pasa lo siguiente en tu solicitud:
- Con la autenticación de usuarios, especifica el permiso de autorización
chat.messages.readonly
ochat.messages
. Con la autenticación de apps, especifica el alcance de autorización dechat.bot
. - Llama a los siguientes métodos de Google Chat:
- Para obtener
attachmentDataRef
, llama a uno de los siguientes métodos:- El método
get
en el recursoAttachment
- El método
get
o el métodolist
en el recursoMessage
- El método
- Llama al método
download
en el recursoMedia
y especifica elattachmentDataRef.resourceName
recuperado anteriormente comomedia.download.resourceName
.
- Para obtener
En el siguiente ejemplo, se descarga un archivo adjunto a un mensaje:
Python
- En tu directorio de trabajo, crea un archivo llamado
chat_media_and_attachment_download.py
. Incluye el siguiente código en
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()
En el código, reemplaza
RESOURCE_NAME
porattachmentDataRef.resourceName
, que puedes recuperar de una de las siguientes maneras:- El método
get
en el recursoAttachment
- El método
get
en el recursoMessage
- El método
list
en el recursoMessage
- El método
En tu directorio de trabajo, compila y ejecuta la muestra:
python3 chat_media_and_attachment_download.py
Si se realiza correctamente, este método muestra el contenido del archivo como bytes.
Para descargar el contenido del archivo, elige uno de los siguientes enfoques:
Te recomendamos que uses la clase
MediaIoBaseDownload
en Python, que contiene métodos para descargar el archivo en secciones y guardar el contenido en un flujo de salida.Si debes realizar la solicitud HTTP de forma manual, llama al método
download
y especifica la parte del archivo que deseas descargar con un rango de bytes con el encabezadoRange
, por ejemplo:Range: bytes=500-999
.
Temas relacionados
- Si el mensaje es un archivo de Drive, usa la API de Drive para obtener acceso al archivo.
- Cómo subir contenido multimedia como archivo adjunto
- Cómo descargar contenido multimedia como archivo adjunto
- Obtén metadatos sobre un archivo adjunto de un mensaje