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 de mensajes en un espacio que se puede filtrar.
El
Recurso Message
representa un
texto
o
tarjeta
mensaje en Google Chat. Puedes
create
, get
, update
o delete
un mensaje en la API de Google Chat llamando
métodos correspondientes. Para obtener más información sobre los mensajes de texto y de tarjetas, consulta
Descripción general de los mensajes de Google Chat.
Requisitos previos
Python
- Una empresa o empresa de Google Workspace con acceso a Google Chat.
- Python 3.6 o superior
- La herramienta de administración de paquetes pip
- Las bibliotecas cliente de Google más recientes. Para instalarlas o actualizarlas,
Ejecuta el siguiente comando en tu interfaz de línea de comandos:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- 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.
-
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 (
client_secrets.json
) en tu directorio local.
- Elige un alcance de autorización que admita la autenticación de usuarios.
Mostrar mensajes
Para enumerar los mensajes con autenticación de usuarios, pasa lo siguiente en tu solicitud:
- Especifica el permiso de autorización
chat.messages.readonly
ochat.messages
. - Llama al
Método
list
en la RecursoMessage
.
En el siguiente ejemplo, se enumeran los mensajes de un espacio de Chat que se enviaron después 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
: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.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 the list of messages. print(result) if __name__ == '__main__': main()
En el código, reemplaza
SPACE
por un nombre de espacio, que 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_messages_list.py
La API de Chat muestra una lista de los mensajes enviados en el espacio especificado
después del 16 de marzo de 2023. Si no hay mensajes de la solicitud,
La respuesta de la API de Chat muestra un objeto vacío. Cuando se utiliza un
REST/HTTP, la respuesta contiene un objeto JSON vacío, {}
.
Temas relacionados
- Da formato a un mensaje.
- Borra un mensaje.
- Obtener detalles sobre un mensaje
- Actualiza un mensaje.
- Envíeles un mensaje.