En esta guía, se explica cómo usar el método upload
en el recurso Media
de
la API de Google Chat para subir contenido multimedia (un archivo) a Google Chat y, luego, adjuntarlo
un mensaje.
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 el cuerpo de la solicitud, que es el
Carga útil de JSON que representa el evento de interacción, incluidos los adjuntos. El
datos en el adjunto varían según si el adjunto está
contenido subido (un archivo local) o es 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 Attachment
incluye los metadatos sobre el adjunto, como
donde se guardan.
Requisitos previos
Python
- Una empresa o empresa de Google Workspace 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. y la descripción de tu app de Chat.
- Instala el Python Biblioteca cliente de las APIs de Google
-
Crea credenciales de ID de cliente de OAuth para una aplicación de escritorio. Para ejecutar la muestra
guarda las credenciales como un archivo JSON llamado
client_secrets.json
en tu directorio local.
- Elige un alcance de autorización que admita la autenticación de usuarios.
Subir como archivo adjunto
Para subir contenido multimedia y adjuntarlo a un mensaje, pasa lo siguiente en tu solicitud::
- Especifica el permiso de autorización
chat.messages.create
ochat.messages
. - Llama a los siguientes métodos de Google Chat:
- Para subir el archivo, llama al
Método
upload
en el recursoMedia
.- Configura
parent
como el nombre del espacio en el que se aloja el archivo. - En
body
(el cuerpo de la solicitud), configurafilename
como el nombre del archivo que se subió. de un archivo adjunto. - Configura
media_body
como una instancia del archivo que se subirá.
- Configura
- Para crear un mensaje con el archivo cargado adjunto, llama al
Método
create
en la RecursoMessages
.- Establece
attachment
como la respuesta de la llamada al Métodoupload
en la RecursoMedia
. Elattachment
acepta una lista.
- Establece
- Para subir el archivo, llama al
Método
En el siguiente ejemplo, se sube un archivo de imagen PNG y se adjunta a un mensaje.
Python
- En tu directorio de trabajo, crea un archivo llamado
chat_media_and_attachment_upload.py
Incluye el siguiente código en
chat_media_and_attachment_upload.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.http import MediaFileUpload # 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.create"] def main(): ''' Authenticates with Chat API via user credentials, then uploads a file as media, creates a message, and attaches the file to the 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. service = build('chat', 'v1', credentials=creds) # Upload a file to Google Chat. media = MediaFileUpload('test_image.png', mimetype='image/png') # Create a message and attach the uploaded file to it. attachment_uploaded = service.media().upload( # The space to upload the attachment in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. parent='spaces/SPACE', # The filename of the attachment, including the file extension. body={'filename': 'test_image.png'}, # Media resource of the attachment. media_body=media ).execute() print(attachment_uploaded) # Create a Chat message with attachment. result = service.spaces().messages().create( # The space to create the message in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Must match the space name that the attachment is uploaded to. parent='spaces/SPACE', # The message to create. body={ 'text': 'Hello, world!', 'attachment': [attachment_uploaded] } ).execute() print(result) if __name__ == '__main__': main()
En el código, reemplaza
SPACE
por el nombre del espacio que sube el archivo adjunto, que puedes obtener de la Métodospaces.list
en la API de Chat o desde la URL de un espacio.En tu directorio de trabajo, compila y ejecuta la muestra:
python3 chat_media_and_attachment_upload.py
La API de Chat muestra un cuerpo de respuesta que contiene
attachmentDataRef
con detalles sobre el archivo subido
Límites y consideraciones
Mientras te preparas para subir archivos y adjuntarlos a los mensajes, toma nota de estas y consideraciones clave:
- Puedes subir archivos de hasta 200 MB.
- Algunos tipos de archivos no son compatibles y no se pueden subir. Para obtener más información, consulta Tipos de archivo bloqueados en Google Chat.
- Tu mensaje debe omitir widgets accesorios.
Temas relacionados
- Cómo descargar contenido multimedia como un archivo adjunto
- Cómo obtener metadatos sobre el archivo adjunto de un mensaje