Lavorare con gli eventi di Google Chat

In questa pagina viene spiegato in che modo le app Google Chat possono ricevere e rispondere in Google Chat.

Un evento di Google Chat rappresenta un'attività o una modifica in Chat. ad esempio un nuovo messaggio in uno spazio. L'app Chat può utilizzare eventi per capire cosa è successo e agire o rispondere in modo per i tuoi utenti.

Ecco alcuni esempi di come utilizzare gli eventi:

  • Monitora e rispondi ai nuovi messaggi in uno spazio, ad esempio controllando la chiave parole o frasi.
  • Invia un messaggio di benvenuto agli utenti quando si uniscono allo spazio per spiegare lo spazio linee guida o condividere suggerimenti su come utilizzare in modo efficace App Chat.
  • Monitorare e analizzare l'attività di Chat. Ad esempio, per inviare un report mensile sui nuovi membri o sui messaggi più popolari reazioni o risposte.
  • Comunicare su più piattaforme di messaggistica. Ad esempio, gli utenti possono inviare e ricevere messaggi dagli utenti su una piattaforma di messaggistica diversa, senza abbandona Chat.

Come funzionano gli eventi

Ogni volta che succede qualcosa in Google Chat, viene generata una risorsa dell'API Google Chat creato, aggiornato o eliminato. Chat usa gli eventi per pubblicare informazioni sulla tua app Chat sul tipo di all'attività che si è verificata e alla risorsa dell'API Chat interessata.

Esempio di come un messaggio pubblicato in uno spazio di Google Chat attiva un evento.
Figura 1. Un utente pubblica un messaggio in un spazio di Chat, che crea una risorsa Message. Chat crea quindi un evento che contiene i dati sul nuovo .

Chat classifica gli eventi per tipo. I tipi di evento ti aiutano a filtrare ricevere solo il tipo di informazioni di cui avete bisogno e consentirvi di gestire le attività allo stesso modo.

La tabella seguente mostra in che modo un'attività in Chat influisce su un risorsa dell'API Chat correlata e il tipo di evento L'app Chat riceve:

Attività Risorsa API Chat Tipo di evento
Un utente pubblica un messaggio in uno spazio di Chat Viene creata una risorsa Message. Nuovo messaggio
Un utente diventa un gestore dello spazio. Una risorsa Membership è stata aggiornata. Abbonamento aggiornato
Un utente reagisce a un messaggio. Viene creata una risorsa Reaction. Nuova reazione
Un utente abbandona uno spazio. Una risorsa Membership viene eliminata. Abbonamento eliminato

Ricevi eventi da Google Chat

Per ricevere eventi, l'app Chat può eseguire una delle due seguenti operazioni seguenti:

  • Iscriviti agli eventi utilizzando l'API Google Workspace Events per riceverli a mano a mano che si presentano.
  • Query sugli eventi recenti chiamando l'API Chat.

La tabella seguente spiega la differenza e i motivi per l'esecuzione di query o Iscrizione agli eventi:

Iscriviti agli eventi Query sugli eventi
Casi d'uso
  • Elabora o rispondi agli eventi in tempo reale.
  • Monitora gli utenti attività di adesione e scoprire nuovi spazi per monitoraggio.
  • Elabora o rispondi agli eventi periodicamente o tramite un attivatore.
  • Recupera gli eventi persi da un abbonamento (a causa di un'interruzione o abbonamento inattivo).
API API Google Workspace Events Chat API
Origine degli eventi Spazi e utenti Solo spazi
Eventi supportati
  • Messaggi
  • Abbonamenti
  • Reazioni
  • Spazio

Per un elenco dei tipi di eventi supportati, consulta Tipi di eventi per la creazione di abbonamenti nel documentazione dell'API Google Workspace Events.
  • Messaggi
  • Abbonamenti
  • Reazioni
  • Spazio

Per un elenco dei tipi di eventi supportati, consulta Risorsa spaceEvents nell'API Chat documentazione di riferimento.
Formato degli eventi Un messaggio Google Cloud Pub/Sub, formattato in base specifica CloudEvent. Per maggiori dettagli, vedi Struttura degli eventi di Google Workspace. Una risorsa dell'API Chat ( spaces.spaceEvent)
Dati sugli eventi Stringa con codifica Base64 con o senza dati delle risorse. Ad esempio, vedi Dati sugli eventi. Payload JSON che contiene i dati delle risorse. Alcuni tipi di eventi includono solo determinati campi delle risorse. Per esempio di payload, vedi documentazione di riferimento.

Esempio: eseguire una query o iscriversi a eventi sulle iscrizioni a uno spazio

In questo esempio, un'app di Chat vuole ricevere informazioni sulle modifiche ai membri di uno spazio di Chat. Nella dello spazio, si verifica la seguente attività di appartenenza:

  • Un utente entra a far parte dello spazio, creando una risorsa Membership e attivando una evento per nuovi membri.
  • Un utente diventa un gestore dello spazio, che aggiorna la risorsa Membership per dell'utente e attiva un evento membro aggiornato.
  • Un utente abbandona lo spazio, il che comporta l'eliminazione della risorsa Membership per un utente e attiva un evento membro eliminato.

Iscriviti agli eventi di abbonamento

Per ricevere eventi in tempo reale, L'app di chat chiama l'API Google Workspace Events subscriptions.create() per iscriversi allo spazio per tutti i tipi di eventi di appartenenza. Dopo il giorno creando l'abbonamento, l'app Chat può iniziare ricevere eventi di adesione.

L'app di chat che si iscrive agli eventi utilizzando API Google Workspace Events.
Figura 2. Un'app di Chat riceve gli eventi di appartenenza tramite un abbonamento utilizzando l'API Google Workspace Events.

Nella Figura 2, l'app Chat ha un abbonamento attivo a Lo spazio, in modo che l'app riceva un evento ogni volta che partecipa allo spazio modifiche. L'app Chat può quindi elaborare o rispondere in tempo reale a una qualsiasi delle attività, come la pubblicazione di un messaggio di benvenuto privato il membro che si è unito allo spazio.

Per scoprire di più sulla creazione di abbonamenti utilizzando l'API Google Workspace Events, consulta la documentazione dell'API Google Workspace Events.

Query sugli eventi di appartenenza recenti

Invece di ricevere gli eventi di appartenenza nel momento in cui si verificano, viene L'app Chat può chiamare l'API Chat per elencare eventi recenti dello spazio correlati alle attività di appartenenza.

App di chat che esegue query sugli eventi utilizzando API Chat.
Figura 3. R L'app Chat riceve gli eventi recenti relativi agli abbonamenti per gli eventi dello spazio usando l'API Chat.

Nella figura 3, un'app di Chat chiama l'API Chat spaces.spaceEvents.list() dopo che si sono verificate tutte le attività di appartenenza e filtra la query per gli eventi di iscrizione nuovi, aggiornati ed eliminati. L'API Chat restituisce un elenco di spaceEvent risorse che rappresentano ogni modifica dell'appartenenza. L'app Chat può quindi elaborare o rispondere in base al attività recenti, come la pubblicazione di un messaggio settimanale con un riepilogo attività di appartenenza allo spazio negli ultimi 7 giorni.

Per eseguire query sugli eventi utilizzando l'API Chat, vedi Elencare gli eventi da uno spazio di Google Chat.

Limitazioni
  • Per le iscrizioni agli utenti, gli eventi relativi ai nuovi membri in messaggi diretti o chat di gruppo senza nome (google.workspace.chat.membership.v1.created), si attivano solo dopo la pubblicazione del primo messaggio.
  • Per ricevere eventi di iscrizione, l'utente deve essere un membro diretto dello spazio. Se un utente è stato aggiunto, aggiornato o rimosso indirettamente a uno spazio tramite un gruppo Google, l'abbonamento non riceveranno gli eventi associati ai membri. Per capire come funzionano le iscrizioni ai gruppi Google, vedi Aggiungere un gruppo Google a uno spazio.