Questa pagina spiega come configurare ed eseguire il deployment di un'app Google Chat come componente aggiuntivo di Google Workspace.
Per eseguire il deployment e testare un componente aggiuntivo di Google Workspace che espande Chat, devi attivare e configurare un'app di Chat utilizzando l' API Google Chat. Le impostazioni di configurazione dell'API Chat ti consentono di specificare tutti i dettagli dell'app Chat, tra cui nome, avatar, implementazione e funzionalità interattive che vuoi utilizzare.
Prerequisiti
HTTP
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Abilita le seguenti API Google Workspace:
- API Google Chat
- API Google Workspace Add-ons
- Un endpoint HTTP che ospita l'architettura di servizio per la tua app Chat.
Apps Script
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Abilita l'API Google Chat.
- Crea un progetto Apps Script autonomo e attiva il servizio Chat avanzato.
- Configura Chat nel file manifest,
aggiungendo l'oggetto
addons.chat
e gli eventuali ambiti richiesti (oauthScopes
) o i prefissi degli URL HTTPS (urlFetchWhitelist
).
Scegliere un nome visualizzato, un avatar e una descrizione per l'app Chat
Il nome, l'avatar e la descrizione dell'app Chat vengono visualizzati agli utenti nell'interfaccia utente di Chat. Per interagire con le app di chat, gli utenti visualizzano o utilizzano queste informazioni nei seguenti modi:
- @Menziona l'app Chat per aggiungerla a uno spazio o mandarle un messaggio.
- Trova e avvia un messaggio diretto con l'app Chat. Nel menu App, i messaggi diretti mostrano il nome e l'avatar dell'app Chat.
- Dalla barra di composizione, gli utenti possono sfogliare le app di Chat e vedere il nome, l'avatar e la descrizione.
Prima di configurare un'app di chat, devi preparare le seguenti informazioni:
Campo | Descrizione | Formato |
---|---|---|
Nome dell'app | Il nome visualizzato dell'app Chat. | Fino a 25 caratteri alfanumerici |
URL avatar | L'immagine visualizzata come avatar dell'app Chat. | Un URL HTTPS che rimanda a un'immagine grafica quadrata (PNG o JPEG). Le dimensioni consigliate sono di almeno 256 x 256 pixel. |
Descrizione | Una breve descrizione dello scopo dell'app Chat. | Fino a 40 caratteri alfanumerici |
Nella sezione seguente, specifichi queste informazioni nelle impostazioni di configurazione dell'API Chat.
Configurare l'app Chat nella console Google Cloud
Una volta ottenuti i dettagli dell'app di Chat, apri il progetto Cloud e configura l'API Chat:
Nella console Google Cloud, vai alla pagina dell'API Chat e fai clic sulla pagina Configurazione:
In Informazioni sull'applicazione, compila i campi Nome app, URL avatar e Descrizione.
In Funzionalità interattive, fai clic su Attiva funzionalità interattive per impostare l'opzione su On e completa quanto segue:
Nella sezione Funzionalità, seleziona una o più caselle di controllo per rendere disponibile l'installazione e l'utilizzo della tua app Chat:
Ricevere messaggi 1:1: gli utenti possono installare l'app Chat e inviare messaggi in uno spazio dedicato tra l'utente e l'app Chat.
Partecipa a spazi e conversazioni di gruppo: gli utenti possono aggiungere e interagire con l'app Chat negli spazi con più persone.
In Impostazioni di connessione, seleziona l'architettura che vuoi utilizzare per ricevere gli oggetti evento da Chat:
- Per utilizzare un servizio HTTP, seleziona URL endpoint HTTP e fornisci un URL.
- Per utilizzare un progetto Google Apps Script, seleziona Apps Script e fornisci un ID deployment per il progetto.
(Facoltativo) Per ricevere oggetti evento in più di un endpoint o funzione, vai a Impostazioni avanzate > Attivatori e fornisci o aggiorna le funzioni di callback per i seguenti attivatori di chat:
- ADDED_TO_SPACE: un utente aggiunge l'app Chat a una conversazione di gruppo o a uno spazio oppure installa l'app Chat per i messaggi 1:1.
- MESSAGE: un utente invia un messaggio all'app Chat. Ad esempio, invia un messaggio diretto all'app Chat o menziona l'app Chat in uno spazio con più persone.
- REMOVED_FROM_SPACE: un utente disinstalla o rimuove l'app Chat da uno spazio.
(Facoltativo) Aggiungi altre funzionalità interattive, come i comandi barra o le anteprime dei link.
In Visibilità, specifica il tuo indirizzo email in modo da poter installare e testare l'app di chat prima di pubblicarla su Google Workspace Marketplace. Puoi specificare fino a cinque persone o uno o più gruppi Google della tua organizzazione Google Workspace.
(Facoltativo) In Log, seleziona la casella di controllo Registra gli errori in Logging per utilizzare Google Cloud Logging. Per saperne di più, consulta Eseguire query sui log degli errori per le app Chat nella documentazione dell'API Chat.
Fai clic su Salva.
Dopo aver salvato la configurazione, chiunque tu abbia specificato nell'impostazione Visibilità dell'API Chat può installare, testare o utilizzare l'app Chat. Per iniziare a testare e eseguire il debug dell'app Chat, consulta Testare le funzionalità interattive per le app Google Chat nella documentazione dell'API Chat.
Considerazioni per i componenti aggiuntivi di Google Workspace esistenti
Le app di chat richiedono una configurazione diversa rispetto ai componenti aggiuntivi di Google Workspace che estendono altre applicazioni Google Workspace. Se il tuo componente aggiuntivo estende altre applicazioni Google Workspace, tieni presente i seguenti requisiti per la configurazione dell'app Chat:
- Sia le persone fisiche che gli amministratori di Google Workspace devono essere in grado di installare il tuo componente aggiuntivo da Marketplace. Configura queste impostazioni di installazione nell'SDK di Google Workspace Marketplace.
- Le app di chat non utilizzano il nome e il logo che configuri per altre applicazioni Google Workspace nell'oggetto
addons.common
del file manifest. - Per i componenti aggiuntivi pubblicati su Google Workspace Marketplace, non puoi salvare una bozza delle modifiche apportate alle impostazioni di configurazione dell'API Google Chat. Dopo aver aggiornato e salvato le impostazioni di configurazione dell'API Chat, l'app Chat aggiornata è disponibile per tutti gli utenti esistenti. Per aggiornare la tua scheda del marketplace, puoi creare una bozza prima di inviare le modifiche.
Se hai creato il componente aggiuntivo utilizzando Apps Script:
- Devi utilizzare lo stesso ID deployment di Apps Script che utilizzi per il resto della configurazione del componente aggiuntivo.
- Non puoi utilizzare l'editor di Apps Script per installare implementazioni di test in Chat. Devi invece installarli direttamente dall'UI di Chat.
Se hai creato il componente aggiuntivo utilizzando un servizio HTTP, ometti i dettagli di configurazione dell'app Chat nel manifest e nei deployment che crei utilizzando l'API Componenti aggiuntivi di Google Workspace. I deployment HTTP specificati nell'SDK di Google Workspace Marketplace vengono utilizzati solo per altre applicazioni Google Workspace.
Argomenti correlati
- Per gestire l'accesso all'API Chat, consulta Configurare l'API Google Chat nella documentazione dell'API Google Chat.
- Testare le funzionalità interattive per le app Google Chat
- Pubblicare app di Google Chat