En esta guía, se explica cómo usar el método delete
en el recurso Message
de la API de Google Chat para borrar un mensaje de texto o de tarjeta.
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 llamando a los métodos correspondientes. Para obtener más información sobre los mensajes de texto y 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.
La autorización configurada para la app de Chat. Borrar un mensaje admite los siguientes métodos de autenticación:
- La autenticación de usuarios, con el permiso de autorización
chat.messages
, puede borrar los mensajes que crea ese usuario. Si eres administrador del espacio, es posible que puedas borrar otros mensajes. Para obtener más información, consulta Obtén más información sobre tu rol como administrador de un espacio. - La autenticación de apps, con el permiso de autorización
chat.bot
, puede borrar los mensajes que crea esa app con su cuenta de servicio.
- La autenticación de usuarios, con el permiso de autorización
Borra un mensaje con autenticación de usuario
Para borrar un mensaje con autenticación de usuario, pasa lo siguiente en tu solicitud:
- Especifica el alcance de la autorización
chat.messages
. - Llama al método
delete
en el recursoMessage
. - Establece
name
en el nombre del recurso del mensaje que deseas borrar.
En el siguiente ejemplo, se borra un mensaje con autenticación de usuario:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_message_delete_user.py
. Incluye el siguiente código en
chat_message_delete_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 deletes 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) # Use the service endpoint to call Chat API. result = chat.spaces().messages().delete( # The message to delete. # # 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' ).execute() # Prints response to the Chat API call. # When deleting a message, the response body is empty. print(result) if __name__ == '__main__': main()
En el código, reemplaza lo siguiente:
SPACE
: Es el nombre del espacio, que puedes obtener del métodospaces.list
en la API de Chat o de la URL de un espacio.MESSAGE
: Es un nombre del 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 su creación.
En tu directorio de trabajo, compila y ejecuta la muestra:
python3 chat_message_delete_user.py
Si se ejecuta de forma correcta, el cuerpo de la respuesta estará vacío, lo que indica que el mensaje se borró.
Borra un mensaje con autenticación de app
Para borrar un mensaje con la autenticación de apps, pasa lo siguiente en la solicitud:
- Especifica el alcance de la autorización
chat.bot
. - Llama al método
delete
en el recursoMessage
. - Establece
name
en el nombre del recurso del mensaje que deseas borrar.
En el siguiente ejemplo, se borra un mensaje con autenticación de app:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_delete_message_app.py
. Incluye el siguiente código en
chat_delete_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) # Delete a Chat message. result = chat.spaces().messages().delete( # The message to delete. # # 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' ).execute() # Print Chat API's response in your command line interface. # When deleting a message, the response body is empty. print(result)
En el código, reemplaza lo siguiente:
SPACE
: Es elname
del espacio en el que se publica el mensaje, que puedes obtener del métodospaces.list
en la API de Chat o de la URL de un espacio.MESSAGE
: Es el nombre del 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 su creación.
En tu directorio de trabajo, compila y ejecuta la muestra:
python3 chat_delete_message_app.py
Si se ejecuta de forma correcta, el cuerpo de la respuesta estará vacío, lo que indica que el mensaje se borró.
Temas relacionados
- Da formato a un mensaje.
- Obtener detalles sobre un mensaje
- Crea una lista de los mensajes de un espacio.
- Actualiza un mensaje.
- Envíeles un mensaje.