Creare interfacce di Google Chat

Questa pagina fornisce una panoramica su come creare interfacce utente (UI) per i componenti aggiuntivi di Google Workspace che estendono Google Chat.

In Google Chat, gli utenti vedono i componenti aggiuntivi come app Google Chat. Per saperne di più, consulta la panoramica di Estensione di Google Chat.

Per creare interfacce per le app di chat, utilizza i seguenti componenti aggiuntivi:

  • Trigger: i modi in cui gli utenti di Google Chat possono richiamare un'app Chat, ad esempio aggiungendola a uno spazio o inviandole un messaggio.
  • Oggetti evento: i dati che le app Chat ricevono da attivatori o interazioni con l'interfaccia utente.
  • Azioni: i modi in cui le app di chat possono rispondere alle interazioni, ad esempio inviare messaggi o restituire un'interfaccia utente basata su schede.
L'app Chat riceve un oggetto evento da un trigger Aggiunto allo spazio
Figura 1: quando un utente aggiunge un'app Chat a uno spazio, l'attivatore Aggiunto allo spazio si attiva e invia un oggetto evento. Per rispondere con un messaggio, l'app Chat gestisce l'oggetto evento e restituisce un'azione che crea il messaggio.

Le app di chat possono creare e visualizzare schede nelle seguenti interfacce:

  • Messaggi che possono contenere testo, schede statiche o interattive e pulsanti.
  • Finestre di dialogo, ovvero schede che si aprono in una nuova finestra e in genere richiedono agli utenti di inviare informazioni.
  • Anteprime dei link, ovvero schede che mostrano un'anteprima delle informazioni su un servizio esterno.

Trigger

Questa sezione spiega gli attivatori utilizzati dai componenti aggiuntivi di Google Workspace in Chat.

Gli attivatori sono i modi specifici con cui gli utenti richiamano un'app di Chat utilizzando l'interfaccia utente di Chat, ad esempio utilizzando le @menzioni o i comandi dell'app.

La tabella seguente mostra gli attivatori di Chat, una descrizione e la modalità di risposta tipica delle app di chat:

Trigger Descrizione Risposta tipica
Aggiunto allo spazio

Un utente aggiunge l'app Chat a uno spazio o un amministratore di Google Workspace installa l'app Chat negli spazi di messaggi diretti per gli utenti della sua organizzazione. Per informazioni sulle app di chat installate dagli amministratori, consulta Installare le app del Marketplace nel tuo dominio nella documentazione della Guida per gli amministratori di Google Workspace.

 L'app Chat invia un messaggio di onboarding che spiega cosa fa e come gli utenti dello spazio possono interagire con essa.
Messaggio

Un utente interagisce con l'app Chat in un messaggio in uno dei seguenti modi:

  • Invia un messaggio in uno spazio di messaggi diretti (DM) con l'app Chat.
  • @menziona l'app Chat in qualsiasi tipo di spazio.
  • Invia un messaggio contenente un link che corrisponde al pattern URL per le anteprime dei link.
  • Digita il testo nel menu di selezione multipla di un selectionInput widget.
 L'app Chat risponde in base ai contenuti del messaggio. Ad esempio, un'app di chat risponde al comando slash /about con un messaggio che spiega le attività che l'app di chat può svolgere.
Rimossi dallo spazio

Un utente rimuove l'app Chat da uno spazio o un amministratore di Google Workspace disinstalla l'app Chat per un utente della propria organizzazione.

Gli utenti non possono rimuovere le app di Chat installate dal loro amministratore. Se un utente ha installato in precedenza l'app Chat, l'app Chat rimane installata indipendentemente dal fatto che un amministratore di Google Workspace provi a disinstallarla.

 L'app Chat rimuove le notifiche in arrivo configurate per lo spazio (ad esempio l'eliminazione di un webhook) e libera lo spazio interno. Le app di chat non possono rispondere con messaggi a questo attivatore perché non sono più membri dello spazio.
Comando app

Un utente utilizza un comando dell'app Chat.

 L'app Chat risponde al comando. Ad esempio, risponde con un messaggio o apre una finestra di dialogo.

A differenza di altri componenti aggiuntivi di Google Workspace, devi configurare eventuali funzioni di callback per questi attivatori utilizzando l'API Google Chat. Per indicazioni, consulta Configurare un'app Google Chat.

Per rispondere a un trigger, consulta le seguenti guide:

Eventi

Le app Chat ricevono oggetti evento quando viene attivato un attivatore Chat o quando gli utenti di Chat interagiscono con un'interfaccia utente dell'app Chat (ad esempio facendo clic su un pulsante). L'oggetto evento contiene i dati sull'interazione che l'app Chat può utilizzare per rispondere o aggiornare un'interfaccia utente.

Per informazioni sulla gestione degli oggetti evento, consulta le seguenti guide:

Per informazioni sugli oggetti evento dei componenti aggiuntivi in Chat e in altre applicazioni Google Workspace, consulta Oggetti evento.

Azioni chat

Questa sezione spiega in che modo le app Chat possono utilizzare le azioni dei componenti aggiuntivi per rispondere alle interazioni degli utenti.

Per rispondere con un'azione del componente aggiuntivo, un'app di chat deve rispondere entro 30 secondi e la risposta deve essere pubblicata nello spazio in cui si è verificata l'interazione. In caso contrario, l'app Chat deve configurare l'autenticazione e chiamare l'API Google Chat per rispondere.

Le app di chat possono gestire e rispondere alle interazioni in molti modi. In molti casi, le app di chat rispondono con un messaggio. Le app di chat possono anche cercare alcune informazioni da un'origine data, registrare le informazioni sull'oggetto dell'evento o qualsiasi altra cosa. Questo comportamento di elaborazione è essenzialmente ciò che definisce l'app Google Chat.

Per rispondere alle interazioni degli utenti, le app di Chat devono gestire l'oggetto evento corrispondente e restituire uno dei seguenti oggetti JSON:

Risposta dell'app di chat Azione richiesta per il reso
Inviare o aggiornare un messaggio. DataActions
Apri, aggiorna o chiudi una finestra di dialogo. RenderActions
Per raccogliere informazioni da una scheda o una finestra di dialogo, suggerisci gli elementi di selezione in base a ciò che gli utenti digitano in un menu di selezione multipla. RenderActions
Visualizza l'anteprima dei link nei messaggi inviati dagli utenti di Chat in uno spazio. DataActions

Rispondere utilizzando l'API Google Chat

Anziché restituire un'azione del componente aggiuntivo, le app di Chat potrebbero dover utilizzare l'API Google Chat per rispondere a un' interazione. Ad esempio, le app di chat devono chiamare l'API Google Chat per eseguire una delle seguenti operazioni:

  • Rispondere a un'interazione dopo 30 secondi.
  • Eseguire attività al di fuori dello spazio in cui si è verificata l'interazione.
  • Eseguire in Chat attività non disponibili come azioni dei componenti aggiuntivi. Ad esempio, elencare gli spazi di cui un utente o un'app di Chat è membro o aggiungere utenti allo spazio.
  • Eseguire attività per conto dell'utente di Chat (che richiede l'autenticazione dell'utente).

Per scoprire di più sull'autenticazione e sull'uso dell'API Chat, consulta la panoramica dell'API Chat.