En esta guía, se explica cómo usar el método patch
en el recurso Message
de la API de Google Chat para actualizar un mensaje de texto o de tarjeta en un espacio. Actualiza un mensaje para cambiar los atributos, como lo que dice o el contenido de una tarjeta. También puedes anteponer un mensaje de texto a un mensaje de tarjeta o agregar una tarjeta a un mensaje de texto.
La API de Chat también admite el método update
, pero te recomendamos que llames al método patch
porque usa una solicitud HTTP PATCH
, mientras que update
usa una solicitud HTTP PUT
. Para obtener más información, consulta la sección PATCH
y PUT
de la AIP-134.
El recurso Message
representa un mensaje de texto o tarjeta en Google Chat. Puedes create
, get
, update
o delete
un mensaje en la API de Google Chat si llamas a los métodos correspondientes. Para obtener más información sobre los mensajes de texto y de tarjetas, consulta la descripción general de los mensajes de Google Chat.
Requisitos previos
Python
- Python 3.6 o superior
- La herramienta de administración de paquetes pip
Las bibliotecas cliente de Google más recientes para Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada Para conocer los pasos, consulta Compila una app de Google Chat.
Autorización configurada para la app de Chat:
- La actualización de un mensaje de texto admite ambos de los siguientes métodos de autenticación:
- La autenticación de usuario, con el permiso de autorización
chat.messages
, puede actualizar los mensajes que creó ese usuario. - La autenticación de la app
con el permiso de autorización
chat.bot
puede actualizar los mensajes creados por esa app.
- La autenticación de usuario, con el permiso de autorización
- La actualización de un mensaje de tarjeta requiere autenticación de la app con el alcance de autorización
chat.bot
.
- La actualización de un mensaje de texto admite ambos de los siguientes métodos de autenticación:
Actualiza un mensaje de texto o antepone un mensaje de texto a un mensaje de tarjeta con la autenticación del usuario.
Para actualizar un mensaje de texto con autenticación de usuario, pasa lo siguiente en tu solicitud:
- El alcance de la autorización de
chat.messages
. - El
name
del mensaje que se actualizará. updateMask='text'
- Un
body
que especifique el mensaje actualizado.
Si el mensaje actualizado es un mensaje de tarjeta, el mensaje de texto se antepone al mensaje de la tarjeta (que sigue mostrándose).
A continuación, se explica cómo actualizar un mensaje de texto o anteponer un mensaje de texto a un mensaje de tarjeta con la autenticación de usuario:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_update_text_message_user.py
. Incluye el siguiente código en
chat_update_text_message_user.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # 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 updates 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) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='text', body={'text': 'Updated message!'} ).execute() # Prints details about the updated message. print(result) if __name__ == '__main__': main()
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que puedes obtener del métodospaces.list
en la API de Chat, o bien desde la URL de un espacio.MESSAGE
: Es un nombre de mensaje, que puedes obtener del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en el momento de la creación.
En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_update_text_message_user.py
Usa la autenticación de apps para actualizar un mensaje de texto o anteponer uno a una tarjeta
Para actualizar un mensaje de texto con la autenticación de la app, pasa lo siguiente en la solicitud:
- El alcance de la autorización de
chat.bot
. - El
name
del mensaje que se actualizará. updateMask='text'
- Un
body
que especifique el mensaje actualizado.
Si el mensaje actualizado es un mensaje de tarjeta, el mensaje de texto se antepone al mensaje de la tarjeta (que sigue mostrándose).
A continuación, te indicamos cómo actualizar un mensaje de texto a uno o anteponer un mensaje de texto a un mensaje de tarjeta con la autenticación de la app:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_update_text_message_app.py
. Incluye el siguiente código en
chat_update_text_message_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='text', body={'text': 'Updated message!'} ).execute() # Print Chat API's response in your command line interface. print(result)
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que puedes obtener del métodospaces.list
en la API de Chat, o bien desde la URL de un espacio.MESSAGE
: Es un nombre de mensaje, que puedes obtener del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en el momento de la creación.
En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_update_text_message_app.py
Actualiza un mensaje de tarjeta o agrega un mensaje de tarjeta a un mensaje de texto
Para actualizar un mensaje de tarjeta, pasa lo siguiente en la solicitud:
- El alcance de la autorización de
chat.bot
. La actualización de un mensaje de tarjeta requiere autenticación de app. - El
name
del mensaje que se actualizará. updateMask='cardsV2'
- Un
body
que especifique el mensaje actualizado.
Si el mensaje actualizado es un mensaje de texto, se adjunta una tarjeta al mensaje de texto (que sigue mostrándose). Si el mensaje actualizado es una tarjeta, se actualizará la tarjeta que se muestra.
A continuación, te mostramos cómo actualizar un mensaje a mensaje de tarjeta:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_update_card_message.py
. Incluye el siguiente código en
chat_update_card_message.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='cardsV2', body= { 'cardsV2': [{ 'cardId': 'updateCardMessage', 'card': { 'header': { 'title': 'An Updated Card Message!', 'subtitle': 'Updated with Chat REST API', 'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png', 'imageType': 'CIRCLE' }, 'sections': [ { 'widgets': [ { 'buttonList': { 'buttons': [ { 'text': 'Read the docs!', 'onClick': { 'openLink': { 'url': 'https://developers.google.com/chat' } } } ] } } ] } ] } }] } ).execute() # Print Chat API's response in your command line interface. print(result)
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que puedes obtener del métodospaces.list
en la API de Chat, o bien desde la URL de un espacio.MESSAGE
: Es un nombre de mensaje, que puedes obtener del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en el momento de la creación.
En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_update_card_message.py
La API de Chat muestra una instancia de Message
en la que se detalla el mensaje que se actualiza.
Actualiza un mensaje con varias rutas de campo de manera simultánea
Cuando se actualiza un mensaje, puedes actualizar varias rutas de campo de mensaje al mismo tiempo. Por ejemplo, en una solicitud de actualización de mensaje, puedes especificar un cambio en las rutas de los campos text
y cardsv2
al mismo tiempo, lo que actualiza tanto el texto como la tarjeta del mensaje. Si el mensaje solo incluye texto y ninguna tarjeta, se agregará una tarjeta al mensaje. Para obtener más información sobre las rutas de campo admitidas, consulta los parámetros updateMask
.
Para actualizar el text
y el card
de un mensaje con autenticación de usuario, pasa lo siguiente en la solicitud:
- El alcance de la autorización de
chat.messages
. - El
name
del mensaje que se actualizará. Un
updateMask
que especifica las rutas del campo de mensaje que se actualizarán, separadas por comas:updateMask='text', 'cardsV2'
.Un
body
que especifique el mensaje actualizado, incluidas todas las rutas de campo actualizadas.
A continuación, se detalla cómo actualizar las rutas de campo text
y cardsV2
en un mensaje con la autenticación de usuarios:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_update_text_message_user.py
. Incluye el siguiente código en
chat_update_text_message_user.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # 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 updates 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) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE', updateMask='text,cardsV2', body= {'text': 'Updated message!', 'cardsV2': [{ 'cardId': 'updateCardMessage', 'card': { 'header': { 'title': 'An Updated Card Message!', 'subtitle': 'Updated with Chat REST API', 'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png', 'imageType': 'CIRCLE' }, 'sections': [ { 'widgets': [ { 'buttonList': { 'buttons': [ { 'text': 'Read the docs!', 'onClick': { 'openLink': { 'url': 'https://developers.google.com/chat' } } } ] } } ] } ] } }] } ).execute() # Prints details about the updated message. print(result) if __name__ == '__main__': main()
En el código, reemplaza lo siguiente:
SPACE
: Es un nombre de espacio, que puedes obtener del métodospaces.list
en la API de Chat, o bien desde la URL de un espacio.MESSAGE
: Es un nombre de mensaje, que puedes obtener del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en el momento de la creación.
En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_update_text_message_user.py
Temas relacionados
- Da formato a un mensaje.
- Borra un mensaje.
- Obtén detalles sobre un mensaje.
- Crea una lista de mensajes de un espacio.
- Envíeles un mensaje.