Desarrolla con Google Chat

En esta página, se proporciona una descripción general de la API de Google Chat y las apps de Google Chat.

Descripción general de la API de Google Chat

La API de Chat consta de servicios de gRPC o recursos y métodos de REST que otorgan acceso a Chat, incluidos los espacios, los miembros de espacios, los mensajes, las reacciones a los mensajes, los archivos adjuntos de los mensajes, los eventos de espacios y los estados de lectura de los usuarios.

Conceptos

En la siguiente sección, se definen los servicios, los recursos y los métodos de la API de Chat:

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 grupales 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.

Referencia del recurso:

Para ver un ejemplo de uso, consulta lo siguiente:

Miembros

Los miembros son los usuarios y las apps de Chat que se unieron a un espacio o que recibieron una invitación para unirse a él.

Referencia del recurso:

Para ver un ejemplo de uso, consulta lo siguiente:

Mensajes

Los mensajes incluyen comunicaciones de texto y tarjetas que se publican en los espacios. Los mensajes pueden tener archivos adjuntos. Las personas pueden reaccionar a los mensajes agregándoles emojis.

Referencia del recurso:

Para ver un ejemplo de uso, consulta lo siguiente:

Reacciones

Las reacciones representan los emojis que las personas usan para reaccionar a un mensaje, como 👍, 🚲 y 🌞.

Referencia del recurso:

Para ver un ejemplo de uso, consulta lo siguiente:

Emojis personalizados

Los emojis personalizados representan los emojis personalizados que se crearon y compartieron dentro de la organización en Google Chat. Los emojis personalizados se pueden incluir en el contenido de un mensaje o usarse para reaccionar a un mensaje.

Referencia del recurso:

Contenido multimedia y archivos adjuntos

Media representa un archivo subido a Google Chat, como imágenes, videos y documentos.

Referencia del recurso multimedia (no disponible en RPC):

Los archivos adjuntos son instancias de contenido multimedia (archivos) adjuntos a los mensajes.

Referencia del recurso:

Para ver un ejemplo de uso, consulta lo siguiente:

Eventos de Space

Los eventos de espacio representan cambios en un espacio o en sus recursos secundarios, incluidos sus miembros, mensajes y reacciones.

Referencia del recurso:

Para ver un ejemplo de uso, consulta lo siguiente:

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 en un hilo de mensajes.

Referencia del recurso de estado de lectura del espacio:

Referencia del recurso de estado de lectura del subproceso:

Para ver un ejemplo de uso, consulta lo siguiente:

Configuración de notificaciones del espacio del usuario

La configuración de notificaciones del espacio del usuario son recursos singleton que representan la configuración de notificaciones de un usuario especificado en un espacio de Google Chat.

Referencia del recurso:

Autenticación

Para llamar a la API de Chat, se requiere autenticación. Cada método de la API de Chat requiere autenticación de usuario (para realizar acciones o acceder a datos en nombre de un usuario) o autenticación de la app (para realizar acciones o acceder a 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.

Bibliotecas cliente

La forma recomendada para que la mayoría de los desarrolladores llamen a la API de Google Chat es con nuestras bibliotecas cliente de Cloud compatibles oficialmente para tu lenguaje preferido, como Python, Java o Node.js.

Si escribes código con Google Apps Script, usa el servicio de Chat avanzado en lugar de instalar una biblioteca cliente.

Compila apps de Chat

La API de Chat te permite crear apps de Google Chat que incorporan tus servicios y recursos directamente en Google Chat. Puedes crear apps de chat para realizar cualquiera de las siguientes acciones:

  • Recupera información según las consultas de texto estructurado o libre que ingresa el usuario.
  • Generar informes de incidentes o artefactos similares con la información proporcionada por el usuario
  • Mejorar la colaboración del equipo, por ejemplo, proporcionando "memoria del equipo" o programando recursos

Puedes diseñar tu app de Chat con varios estilos de arquitectura diferentes, incluidos los siguientes:

  • Apps interactivas: Responden a la interacción del usuario, como las @menciones o los comandos de barra, y presentan información o guían a los usuarios a través de un flujo de trabajo con tarjetas y diálogos.
  • Apps de línea de comandos o webhooks: Envían mensajes proactivos, como alarmas o notificaciones, desde otro sistema a un espacio. Los usuarios no pueden interactuar directamente con este tipo de app.
  • Apps basadas en eventos: Suscríbete a la actividad en un espacio de Chat y reacciona a ella, por ejemplo, cuando se une un miembro nuevo. En respuesta a un evento, la app puede enviar un mensaje o realizar otra acción.

Para obtener detalles sobre el diseño de tu app de Chat, consulta Elige una arquitectura de app de Google Chat.

¿Quieres ver la API de Google Chat en acción?
El canal de Google Workspace Developers ofrece videos con sugerencias, trucos y las funciones más recientes.