En esta sección, se explica cómo una app de Google Chat puede llamar a la API de Chat, lo que permite que esas apps realicen acciones como crear un espacio, agregar personas a él y publicar un mensaje sin que un evento de interacción con la app de Chat lo solicite.
Proporción de eficiencia energética (EER)
Llamar a la API de Chat de forma asíncrona requiere autenticación. Cada método de la API de Chat requiere la autenticación del usuario (para realizar acciones o acceder a los datos en nombre de un usuario) o la autenticación de la app (para realizar acciones o acceder a los datos como una app de Chat). Algunos métodos admiten la autenticación de usuarios y de apps.
Para obtener más información sobre la autenticación en Chat, consulta Descripción general de la autenticación.
Recursos y métodos de la API
Los recursos y métodos de REST otorgan acceso asíncrono a los espacios de Chat y los miembros de espacios, los mensajes, las reacciones a mensajes y los archivos adjuntos de mensajes.
- Espacios
Los espacios son lugares donde las personas y las apps pueden conversar y compartir archivos. Existen varios tipos de espacios. Los mensajes directos (MD) son conversaciones 1:1 entre dos usuarios o un usuario y una app de Chat. Los chats en grupo son conversaciones entre tres o más usuarios y las apps de chat. Los espacios con nombre son lugares persistentes en los que las personas envían mensajes, comparten archivos y colaboran.
El recurso
spaces
representa un espacio.Los espacios admiten los siguientes métodos:
- Crea un espacio, un lugar en el que las personas y las apps pueden conversar y compartir archivos.
- Configura un espacio para crearlo, y agrégale personas y apps de Chat.
- Obtén un espacio para ver detalles sobre un espacio.
- Crea una lista de espacios para ver una lista de espacios paginada y filtrable.
- Actualiza un espacio para cambiar los atributos de un espacio, como su nombre visible, la descripción y los lineamientos visibles para el usuario.
- Borra un espacio cuando ya no sea necesario.
- Busca un mensaje directo (MD) para mostrar un MD entre dos usuarios o entre un usuario y la app de Chat que realiza la llamada.
- Miembros
Los miembros son los usuarios y las apps de Chat que se unieron a un espacio o que recibieron invitaciones.
El recurso
spaces.members
representa a un miembro.Los miembros admiten los siguientes métodos:
- Crea una membresía para agregar un usuario o una app a un espacio.
- Obtén una membresía para ver sus detalles.
- Enumera las membresías para ver una lista paginada y filtrable de membresías de un espacio.
- Actualiza una membresía para cambiar los atributos de una membresía, como cambiar un miembro del espacio a administrador o administrador del espacio.
- Borra una membresía para quitar a un usuario o una app de un espacio.
- Mensajes
Los mensajes incluyen las comunicaciones de texto y tarjetas publicadas en espacios. Los mensajes pueden tener archivos adjuntos. Las personas pueden reaccionar a los mensajes agregándoles emojis.
El recurso
spaces.messages
representa un mensaje.Los mensajes admiten los siguientes métodos:
- Crea un mensaje para publicar un mensaje de texto o tarjeta. También puedes iniciar una conversación o responder a ella.
- Recibe un mensaje para obtener detalles sobre un mensaje, como cuándo se envió o qué dice.
- Enumera mensajes para ver una lista paginada y filtrable de los mensajes de un espacio.
- Actualiza un mensaje para cambiar los atributos del mensaje, como lo que dice. También puedes agregar texto a un mensaje de tarjeta o una tarjeta a un mensaje de texto.
- Borra un mensaje cuando ya no lo necesites.
- Reacciones
Las reacciones representan los emojis que las personas usan para reaccionar a un mensaje, como 👍, Ъ y pe.
El recurso
spaces.messages.reactions
representa una reacción.Las reacciones admiten los siguientes métodos:
- Crea una reacción para agregar un emoji a un mensaje.
- Enumera las reacciones para ver una lista paginada y filtrable de las reacciones a un mensaje.
- Borra una reacción para quitar un emoji del mensaje.
- Contenido multimedia y archivos adjuntos
Contenido multimedia representa un archivo subido a Google Chat, como imágenes, videos y documentos.
El recurso
media
representa el contenido multimedia adjunto a los mensajes.Los archivos adjuntos son instancias de contenido multimedia (archivos) adjuntos a mensajes.
El recurso
spaces.messages.attachments
representa un adjunto. Un archivo adjunto incluye el contenido multimedia y los metadatos asociados adjuntos a un mensaje.El contenido multimedia y los archivos adjuntos admiten los siguientes métodos:
- Sube contenido multimedia como archivo adjunto para subirlo a Google Chat y, luego, adjúntalo a un mensaje.
- Descarga contenido multimedia como archivo adjunto para descargar contenido multimedia de Google Chat como un archivo binario.
- Obtén un archivo adjunto para recuperar metadatos sobre un archivo adjunto de mensaje.
- Eventos espaciales
Los eventos de espacios representan cambios en un espacio o sus recursos secundarios, incluidos sus miembros, mensajes y reacciones.
El recurso
spaces.spaceEvent
representa un evento espacial.Los eventos espaciales admiten los siguientes métodos:
- Obtener un evento espacial para mostrar detalles sobre un evento que ocurrió en un espacio.
- Enumera los eventos espaciales para obtener una lista de los eventos que ocurrieron en un espacio.
- Estados de lectura del usuario
Los estados de lectura del usuario son recursos singleton que representan detalles sobre el último mensaje leído de un usuario específico en un espacio de Google Chat o una conversación de mensajes.
El recurso
users.spaces
representa el estado de lectura de un usuario en un espacio.El recurso
users.spaces.threads
representa el estado de lectura de un usuario en una conversación de mensajes.Los estados de lectura del usuario admiten los siguientes métodos:
- Obtén el estado de lectura de un espacio para mostrar detalles sobre el estado de lectura de un usuario dentro de un espacio.
- Actualiza el estado de lectura del espacio para actualizar el estado de lectura de un usuario dentro de un espacio.
- Obtén el estado de lectura del subproceso para mostrar detalles sobre el estado de lectura de un usuario dentro de un subproceso.