In questa pagina viene descritto in che modo l'app Google Chat può ricevere e Rispondere alle interazioni degli utenti, noto anche come app Google Chat eventi di interazione.
In questa pagina viene descritto come effettuare le seguenti operazioni:
- Configura l'app Chat per ricevere l'interazione eventi.
- Elabora l'evento di interazione nella tua infrastruttura.
- Se opportuno, rispondi agli eventi di interazione.
Prerequisiti
Un'app di Google Chat abilitata per le funzionalità interattive. Per creare un interattiva di Chat, completa una delle seguenti guide rapide basate nell'architettura dell'app che vuoi utilizzare:
- Servizio HTTP con Google Cloud Functions
- Script di Google Apps
- Google Cloud Dialogflow CX
- Google Cloud Pub/Sub
Come funzionano gli eventi di interazione
Un evento di interazione con l'app di Google Chat rappresenta qualsiasi azione l'utente impiega per richiamare o interagire con un'app di Chat, ad esempio utilizzando la @menzione di un'app di Chat o l'aggiunta a un spazio. Quando gli utenti interagiscono con un'app di Chat, Google Chat invia all'app Chat un evento di interazione. L'app Chat può utilizzare l'evento per elaborare un'interazione e creare una risposta.
Ad esempio, le app di chat utilizzano gli eventi di interazione per eseguire una qualsiasi seguenti:
Esempio di evento di interazione | Risposta tipica da un'app di Chat |
---|---|
Un utente richiama un'app di Chat @menzionandola o utilizzando un comando slash. | La
L'app Chat elabora ciò che dice il messaggio
per creare un messaggio. Ad esempio, un'app di Chat risponde
il comando /about con un messaggio che spiega le attività
dell'app Chat. |
Un utente aggiunge un'app di Chat a uno spazio. | L'app Chat invia una richiesta di onboarding che spiega cosa fa e come gli utenti nello spazio possono interagire li annotino. |
Un utente rimuove un Chat da uno spazio. | La L'app Chat rimuove tutte le notifiche in arrivo configurato per lo spazio (ad esempio, eliminando un webhook) e cancella qualsiasi memoria interna. |
Un utente fa clic su un pulsante in una scheda o finestra di dialogo inviata dal Chat. | L'app Chat elabora e archivia qualsiasi dati inviati dall'utente o che restituisce un'altra scheda o finestra di dialogo. |
Per ogni tipo di interazione utente, Google Chat invia un tipo diverso di
evento di interazione che aiuta l'app di Chat a gestire ogni
tipo di evento di conseguenza. Ad esempio, Google Chat utilizza il tipo di evento
ADDED_TO_SPACE
per qualsiasi interazione in cui un utente aggiunge il
Chat in uno spazio, in modo che
L'app di chat è in grado di gestire una risposta, ad esempio la pubblicazione
messaggio di benvenuto nello spazio. Per visualizzare tutti gli eventi di interazione supportati, consulta la
Riferimento EventType
documentazione.
Ricevi eventi di interazione con l'app di Chat
Questa sezione descrive come ricevere ed elaborare gli eventi di interazione per il tuo Chat.
Configura l'app Chat per ricevere eventi di interazione
Non tutte le app di chat sono interattive. Ad esempio: i webhook in arrivo possono inviare solo messaggi in uscita non può rispondere agli utenti. Se stai creando un modello interattivo Chat, devi scegliere un endpoint che permetta L'app di chat riceve, elabora e risponde alle interazioni eventi. Per scoprire di più sulla progettazione della tua app di Chat, vedi Architetture di implementazione delle app di Chat.
Per ciascuna delle funzionalità interattive che vuoi creare, devi aggiornare la tua configurazione nell'API Chat in modo che Google Chat possa inviare eventi di interazione correlati alla tua app di Chat:
Nella console Google Cloud, vai alla pagina dell'API Chat e fai clic sull'icona Pagina Configurazione:
Nella sezione Funzionalità interattive, controlla le impostazioni e aggiorna in base ai le caratteristiche che vuoi creare:
Campo Descrizione Funzionalità Obbligatorio. Un insieme di campi che determinano in che modo l'app di Chat può interagire con gli utenti: - Ricevere messaggi 1:1: gli utenti possono trovare e inviare messaggi all'app Chat direttamente in Google Chat.
- Partecipare a spazi e conversazioni di gruppo: gli utenti possono aggiungere l'app Chat agli spazi e alle conversazioni di gruppo.
Impostazioni di connessione Obbligatorio. L'endpoint per l'app Chat, che è uno dei seguenti: - URL app: un endpoint HTTPS che ospita l'implementazione dell'app Chat.
- Progetto Apps Script: un ID deployment per un progetto Apps Script che implementa un'app di Chat.
- Nome argomento Cloud Pub/Sub: un argomento Pub/Sub a cui l'app di Chat si abbona come endpoint.
- Dialogflow: registra l'app Chat con un'integrazione Dialogflow. Per saperne di più, consulta Creare un'app Google Chat Dialogflow che capisce il linguaggio naturale.
Comandi slash (Facoltativo) Comandi che possono essere mostrati agli utenti all'interno di Google Chat. Consente agli utenti di visualizzare le azioni principali della tua app Chat in Google Chat e di scegliere un'azione specifica con cui vogliono interagire. Per ulteriori informazioni, vedi Rispondere ai comandi slash come app di chat. Anteprime link (Facoltativo) Pattern URL che l'app Chat riconosce e fornisce contenuti aggiuntivi per quando gli utenti inviano link. Per ulteriori informazioni, consulta la sezione Link di anteprima. Visibilità (Facoltativo) Fino a cinque persone o uno o più gruppi Google che possono visualizzare e installare la tua app Chat. Utilizza questo campo per testare l'app Chat o per condividerla con il tuo team. Per saperne di più, vedi Testare le funzionalità interattive. Fai clic su Salva. Quando salvi l'app Chat automatica, la tua app di Chat è disponibile specifici degli utenti nella tua organizzazione Google Workspace.
L'app Chat è ora configurata per ricevere interazioni eventi da Google Chat.
Gestire i nuovi tentativi di chiamata HTTP al servizio
Se una richiesta HTTPS al tuo servizio non va a buon fine (ad esempio un timeout, una connessione errore o codice di stato HTTPS non 2xx), Google Chat potrebbe riprovare a volte nel giro di pochi minuti (ma non è garantito). Di conseguenza, L'app Chat potrebbe ricevere lo stesso messaggio alcune volte in determinate situazioni. Se la richiesta viene completata correttamente, ma restituisce un valore non valido payload, Google Chat non proverà nuovamente a inviare la richiesta.
Elabora o rispondi agli eventi di interazione
Questa sezione spiega in che modo le app Google Chat possono elaborare e rispondere alle eventi di interazione.
Dopo che l'app Chat riceve un evento di interazione da Google Chat, possono rispondere in molti modi. In molti casi, le interazioni Le app di chat rispondono all'utente con un messaggio. L'app Google Chat può anche cercare alcune informazioni da un registrare le informazioni sull'evento di interazione o praticamente qualsiasi altra cosa. Questo comportamento di elaborazione definisce App Google Chat.
Per rispondere in modo sincrono, un'app di Chat deve rispondere entro 30 secondi e la risposta deve essere pubblicata nello spazio in cui in cui si è verificata un'interazione. Altrimenti, l'app Chat può rispondono in modo asincrono.
Per ogni evento di interazione, le app di chat ricevono un corpo della richiesta, ossia il payload JSON che rappresenta l'evento. Puoi utilizzare lo le informazioni necessarie per elaborare una risposta. Per esempi di payload di eventi, vedi Tipi di eventi di interazione con l'app di Chat.
Il seguente diagramma mostra come In genere l'app Google Chat elabora o risponde a diversi tipi di eventi di interazione:
Rispondi in tempo reale
Gli eventi di interazione consentono alle app di chat di rispondere in tempo reale oppure in modo sincrono. Le risposte sincrone non richiedono authentication.
Rispondere a uno spazio
In questo esempio, l'app Chat crea e invia un messaggio ogni volta che viene aggiunto a uno spazio. Per conoscere le best practice per per gli utenti, vedi Presenta agli utenti la tua app Chat.
Per inviare un messaggio quando un utente aggiunge la tua app Chat
in uno spazio, la tua app Chat
risponde a un ADDED_TO_SPACE
evento di interazione. Per rispondere a
ADDED_TO_SPACE
eventi di interazione con un messaggio, utilizza il seguente codice:
Node.js
/**
* Sends an onboarding message when the Chat app is added to a space.
*
* @param {Object} req The event object from Chat API.
* @param {Object} res The response object from the Chat app. An onboarding message that
* introduces the app and helps people get started with it.
*/
exports.onMessage = function onMessage(req, res) {
if (req.method === 'GET' || !req.body.message) {
res.send(
'Hello! This function is meant to be used in a Google Chat space.');
}
// Send an onboarding message when added to a Chat space
if (req.body.type === 'ADDED_TO_SPACE') {
res.json({
'text': 'Hi, Cymbal at your service. I help you manage your calendar
from Google Chat. Take a look at your schedule today by typing
`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To
learn what else I can do, type `/help`.'
});
}
};
Apps Script
/**
* Sends an onboarding message when the Chat app is added to a space.
*
* @param {Object} event The event object from Chat API.
* @return {Object} Response from the Chat app. An onboarding message that
* introduces the app and helps people get started with it.
*/
function onAddToSpace(event) {
return {
'text': 'Hi, Cymbal at your service. I help you manage your calendar
from Google Chat. Take a look at your schedule today by typing
`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn
what else I can do, type `/help`.'
}
}
L'esempio di codice restituisce il seguente messaggio di testo:
Altri esempi di risposte alle interazioni
Per creare risposte sincrone agli eventi di interazione, consulta le seguenti risorse guide:
- Impostare i comandi slash
- Apri finestre di dialogo interattive
- Link di anteprima
- Elaborare le informazioni inviate dagli utenti
Rispondi in modo asincrono
A volte le app di chat devono rispondere a un evento di interazione dopo 30 giorni secondi o eseguire attività all'esterno dello spazio in cui si trovava l'evento di interazione generati. Ad esempio, un'app di Chat potrebbe dover rispondere all'utente dopo aver completato un'attività di lunga durata. In questo caso, Le app di chat possono rispondere in modo asincrono chiamando l'API Google Chat.
Per creare un messaggio utilizzando l'API Chat, vedi Crea un messaggio. Per guide sull'utilizzo metodi aggiuntivi dell'API Chat, consulta Panoramica dell'API Chat.
Argomenti correlati
- Invia un messaggio
- Apri finestre di dialogo interattive
- Link di anteprima
- Leggere i dati dei moduli inseriti dagli utenti sulle schede
- Rispondere ai comandi slash
- Creare una home page per un'app di Chat
- Verificare le richieste da Chat
- Testare le funzionalità interattive per le app Google Chat