En esta sección, se explica cómo una app de Google Chat puede llamar a la API de Chat, lo que les permite a las apps de Chat crear un espacio, agregarle personas y publicar un mensaje sin que se lo solicite un evento de interacción con la app de Chat.
Autenticación
Se requiere autenticación para llamar a la API de Chat de forma asíncrona. Cada método de la API de Chat requiere autenticación del usuario (para realizar acciones o acceder a los datos en nombre de un usuario) o 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 la autenticación 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, los miembros del espacio, 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 entre un usuario y una app de Chat. Los chats en grupo son conversaciones entre tres o más usuarios y apps de Chat. Los espacios con nombre son lugares persistentes donde las personas envían mensajes, comparten archivos y colaboran.
El recurso
spacesrepresenta un espacio.Los espacios admiten los siguientes métodos:
- Crea un espacio, un lugar donde las personas y las apps puedan conversar y compartir archivos.
- Configura un espacio para crearlo y agregarle personas y apps de Chat.
- Obtén un espacio para ver los detalles de uno.
- Crea una lista de espacios para ver una lista de espacios paginada y filtrable.
- Actualiza un espacio para cambiar sus atributos, como el nombre visible para el usuario, la descripción y los lineamientos.
- Borra un espacio cuando ya no lo necesites.
- Busca un mensaje directo (MD) para mostrar un MD entre dos usuarios o entre un usuario y las apps de Chat que realizan la llamada.
- Miembros
Los miembros son los usuarios y las apps de Chat que se unieron a un espacio o se los invita a él.
El recurso
spaces.membersrepresenta 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 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 de un miembro del espacio a administrador del espacio o de administrador del espacio a miembro del espacio.
- Borra una membresía para quitar un usuario o una app de un espacio.
- Mensajes
Los mensajes incluyen comunicaciones de texto y tarjeta publicadas en espacios. Los mensajes pueden tener archivos adjuntos. Las personas pueden reaccionar a los mensajes agregando emojis a ellos.
El recurso
spaces.messagesrepresenta un mensaje.Mensajes admite los siguientes métodos:
- Crea un mensaje para publicar un mensaje de texto o de tarjeta. También puedes iniciar o responder una conversación.
- Recibir un mensaje para conocer detalles sobre un mensaje, como la fecha de envío o lo que dice
- Enumera mensajes para ver una lista paginada de mensajes en un espacio que se puede filtrar.
- Actualiza un mensaje para cambiar sus atributos, 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 automatizados.
El recurso
spaces.messages.reactionsrepresenta una reacción.Las reacciones admiten los siguientes métodos:
- Crea una reacción para agregar un emoji a un mensaje.
- Enumera reacciones para ver una lista paginada de reacciones a un mensaje que se puede filtrar.
- Borra una reacción para quitar un emoji del mensaje.
- Contenido multimedia y archivos adjuntos
Media representa un archivo subido a Google Chat, como imágenes, videos y documentos.
El recurso
mediarepresenta el contenido multimedia adjunto a los mensajes.Los archivos adjuntos son instancias de contenido multimedia (archivos) adjuntos a mensajes.
El recurso
spaces.messages.attachmentsrepresenta 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 subir contenido multimedia 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 acerca de un archivo adjunto de mensaje.
- Eventos espaciales
Los eventos de espacio representan los cambios que se realizan en un espacio o sus recursos secundarios, incluidos sus miembros, mensajes y reacciones.
El recurso
spaces.spaceEventrepresenta un evento de espacio.Los eventos de espacio admiten los siguientes métodos:
- Obtener un evento espacial para mostrar los detalles sobre un evento que ocurrió en un espacio
- Crea una lista de eventos de espacio para obtener una lista de los eventos que ocurrieron en un espacio.
- Estados de lectura de los usuarios
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.spacesrepresenta el estado de lectura de un usuario en un espacio.El recurso
users.spaces.threadsrepresenta el estado de lectura de un usuario en una conversación.Los estados de lectura de los usuarios admiten los siguientes métodos:
- Obtén el estado de lectura del espacio para mostrar detalles sobre el estado de lectura de un usuario en un espacio.
- Actualiza el estado de lectura del espacio para actualizar el estado de lectura de un usuario en un espacio.
- Obtén el estado de lectura de subprocesos para mostrar detalles sobre el estado de lectura de un usuario dentro de un subproceso.