En esta guía, se explica cómo usar el método list
en el recurso Message
de la API de Google Chat para ver una lista paginada y filtrada de mensajes en un espacio.
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 la interfaz de línea de comandos:
pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client
Una app de Chat publicada. Para crear y publicar una app de Chat, consulta Cómo compilar una app de Google Chat.
Autorización configurada para la app de Chat. Para enumerar mensajes, se requiere la autenticación de usuarios con el permiso de autorización
chat.messages.readonly
ochat.messages
.
Mostrar mensajes
Para mostrar una lista de mensajes con la autenticación de usuarios, pasa lo siguiente en tu solicitud:
- Especifica el alcance de autorización de
chat.messages.readonly
ochat.messages
. - Llama al método
list
en el recursoMessage
.
En el siguiente ejemplo, se enumeran los mensajes de un espacio de Chat enviados después del 16 de marzo de 2023:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_messages_list.py
. Incluye el siguiente código en
chat_messages_list.py
:import os.path from google.auth.transport.requests import Request from google.oauth2.credentials import Credentials from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.errors import HttpError # 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.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists messages in a space sent after March 16, 2023. ''' # 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().list( # The space for which to list messages. parent = 'spaces/SPACE', # An optional filter that returns messages # created after March 16, 2023. filter = 'createTime > "2023-03-16T00:00:00-00:00"' ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
En el código, reemplaza
SPACE
por el nombre de un espacio, que puedes obtener del métodospaces.list
en la API de Chat, o bien desde la URL de un espacio.En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_messages_list.py
La API de Google Chat muestra una lista de los mensajes enviados en el espacio especificado después del 16 de marzo de 2023.
Temas relacionados
- Da formato a un mensaje.
- Cómo borrar un mensaje
- Obtén detalles sobre un mensaje.
- Actualiza un mensaje.
- Envíeles un mensaje.