Trabaja con eventos de Google Chat

En esta página, se explica cómo las apps de Google Chat pueden recibir y responder eventos en Google Chat.

Un evento de Google Chat representa una actividad o un cambio en Chat como un mensaje nuevo en un espacio. Tu app de Chat puede usar eventos para comprender lo que sucedió y tomar medidas o responder de manera para los usuarios.

Estos son algunos ejemplos de cómo puedes usar los eventos:

  • Supervisa los mensajes nuevos en un espacio y respóndelos, por ejemplo, para verificar si hay claves palabras o frases.
  • Envía un mensaje de bienvenida a los usuarios a medida que se unan al espacio para explicarles el motivo. o compartir sugerencias sobre cómo utilizar el App de Chat
  • Haz un seguimiento de la actividad de Chat y analízala. Por ejemplo, para enviar un informe mensual sobre miembros nuevos o los mensajes que más reciben reacciones o respuestas.
  • Comunícate en todas las plataformas de mensajería. Por ejemplo, los usuarios pueden enviar y recibir mensajes de usuarios en una plataforma de mensajería diferente sin saliendo de Chat.

Cómo funcionan los eventos

Cuando sucede algo en Google Chat, un recurso de la API de Google Chat se crear, actualizar o borrar. Chat usa eventos para enviar información a la app de Chat sobre el tipo de la actividad registrada y el recurso de la API de Chat afectado.

Ejemplo de cómo un mensaje publicado en un espacio de Google Chat activa un evento.
Figura 1. Un usuario publica un mensaje en una Espacio de Chat, que crea un recurso Message A continuación, Chat crea un evento que contiene datos sobre el nuevo mensaje.

Chat clasifica los eventos por tipo. Los tipos de eventos te ayudan a filtrar y recibir solo el tipo de información que necesitas y permitirte manejar las actividades de la misma manera.

En la siguiente tabla, se muestra cómo una actividad en Chat afecta a una recurso de la API de Chat relacionado y el tipo de evento que La app de Chat recibe lo siguiente:

Actividad Recurso de la API de Chat Tipo de evento
Un usuario publica un mensaje en un espacio de Chat Se crea un recurso Message. Mensaje nuevo
Un usuario se convierte en administrador del espacio. Se actualiza un recurso Membership. Membresía actualizada
Un usuario reacciona a un mensaje. Se crea un recurso Reaction. Reacción nueva
Un usuario abandona un espacio. Se borra un recurso Membership. Membresía borrada

Recibe eventos de Google Chat

Para recibir eventos, la app de Chat puede realizar cualquiera de las siguientes acciones: lo siguiente:

  • Suscríbete a eventos con la API de Google Workspace Events para recibir eventos. a medida que ocurren.
  • Llama a la API de Chat para consultar eventos recientes.

En la siguiente tabla, se explican la diferencia y los motivos para realizar consultas o suscripción a eventos:

Suscríbete a eventos Consulta de eventos
Casos de uso
  • Procesa eventos o responde a ellos en tiempo real.
  • Supervisa las métricas de los usuarios la actividad de membresías y descubrir nuevos espacios para supervisar.
  • Procesa eventos o responde a ellos de forma periódica o mediante un activador.
  • Recupera eventos perdidos de una suscripción (debido a interrupciones o suscripción inactiva).
API API de Google Workspace Events Chat API
Fuente de los eventos Espacios y usuarios Solo espacios
Eventos admitidos
  • Mensajes
  • Membresías
  • Reacciones
  • Espacio

Para obtener una lista de los tipos de eventos admitidos, consulta Tipos de eventos para crear suscripciones en el Documentación de la API de Google Workspace Events.
  • Mensajes
  • Membresías
  • Reacciones
  • Espacio

Para obtener una lista de los tipos de eventos admitidos, consulta la Recurso spaceEvents en la API de Chat documentación de referencia.
Formato del evento Un mensaje de Google Cloud Pub/Sub, con un formato acorde al especificación de CloudEvent. Para obtener más información, consulta Estructura de los eventos de Google Workspace. Un recurso de la API de Chat ( spaces.spaceEvent)
Datos de eventos String codificada en base64 con o sin datos de recursos. Para ver ejemplos de cargas útiles, consulta Datos de eventos. Carga útil de JSON que contiene datos de recursos. Algunos tipos de eventos solo incluyen ciertos campos de recursos. Para ver ejemplos de cargas útiles, consulta la documentación de referencia.

Ejemplo: Consulta eventos sobre las membresías de un espacio o suscríbete a ellos

En este ejemplo, una app de Chat quiere recibir información sobre los cambios realizados en los miembros de un espacio de Chat. En el espacio, tendrá lugar la siguiente actividad de membresía:

  • Un usuario se une al espacio, lo que crea un recurso Membership y activa un evento para miembros nuevos.
  • Un usuario se convierte en administrador del espacio, lo que actualiza el recurso Membership por para el usuario y activa un evento de miembro actualizado.
  • Un usuario abandona el espacio, lo que borra el recurso Membership de la usuario y activa un evento de miembro borrado.

Suscríbete a eventos de membresía

Para recibir eventos en tiempo real, el La app de Chat llama a la API de Google Workspace Events subscriptions.create() para suscribirse al espacio a todos los tipos de eventos de membresía. Después del creando la suscripción, la app de Chat puede comenzar a pueden recibir eventos de membresía.

Chat que se suscribe a eventos con el
      API de Google Workspace Events.
Figura 2: Una app de Chat recibe eventos de membresía a través de una suscripción con la API de Google Workspace Events.

En la figura 2, la app de Chat tiene una suscripción activa a el espacio, por lo que la app recibe un evento cada vez que se solicita una membresía cambios. La app de Chat puede procesar o responder en tiempo real a cualquiera de las actividades, como publicar un mensaje de bienvenida privado para el miembro que se unió al espacio.

Para obtener información sobre cómo crear suscripciones con la API de Google Workspace Events, consulta la documentación de la API de Google Workspace Events.

Consulta sobre los eventos de membresía recientes

En lugar de recibir los eventos de membresía a medida que ocurren, un La app de Chat puede llamar a la API de Chat para enumerar Eventos del espacio recientes relacionados con la actividad de membresías.

App de Chat que consulta eventos con el
        API de Chat.
Figura 3: R La app de Chat recibe los eventos de membresía recientes consultas de eventos del espacio con la API de Chat

En la Figura 3, una app de Chat llama a la API de Chat spaces.spaceEvents.list() una vez que ocurren todas las actividades de membresía y filtra la consulta para ver los eventos de membresía nuevos, actualizados y borrados. La API de Chat muestra una lista de recursos spaceEvent que representan cada uno de los cambios de membresía. La app de Chat puede procesar o responder según el la actividad reciente, como publicar un mensaje semanal con un resumen del la actividad de membresías del espacio en los últimos 7 días.

Para consultar eventos con la API de Chat, visita Enumera eventos de un espacio de Google Chat.

Limitaciones

  • En el caso de las suscripciones de usuarios, eventos sobre miembros nuevos en mensajes directos o chats en grupo sin nombre (google.workspace.chat.membership.v1.created) solo se activa después de que se publica el primer mensaje.
  • Para recibir eventos de membresía, el usuario debe ser un miembro directo del espacio. Si se agregó un usuario, se actualiza o se quita de forma indirecta en un espacio a través de un Grupo de Google, la suscripción no pueden recibir esos eventos de membresía. Para comprender cómo funcionan las membresías de Grupos de Google, consulta Agrega un Grupo de Google a un espacio.