Sviluppare con Google Chat

Questa pagina fornisce una panoramica dell'API Google Chat e delle app Google Chat.

Panoramica dell'API Google Chat

L'API Chat è costituita da servizi gRPC o risorse e metodi REST che concedono l'accesso a Chat, inclusi spazi, membri degli spazi, messaggi, reazioni ai messaggi, allegati dei messaggi, eventi dello spazio e stati di lettura degli utenti.

Concetti

La sezione seguente definisce i servizi, le risorse e i metodi per l'API Chat:

Spazi

Gli spazi sono luoghi in cui persone e app possono conversare e condividere file. Esistono diversi tipi di spazi. I messaggi diretti sono conversazioni 1:1 tra due utenti o tra un utente e un'app di chat. Le chat di gruppo sono conversazioni tra tre o più utenti e app di chat. Gli spazi con nome sono luoghi permanenti in cui le persone inviano messaggi, condividono file e collaborano.

Riferimento alla risorsa:

Per un esempio di utilizzo, vedi:

Membri

I membri sono utenti e app di chat che hanno partecipato o sono stati invitati a uno spazio.

Riferimento alla risorsa:

Per un esempio di utilizzo, vedi:

Messaggi

I messaggi includono testo e schede> comunicazioni pubblicate negli spazi. I messaggi possono avere file allegati. Le persone possono reagire ai messaggi aggiungendo emoji.

Riferimento alla risorsa:

Per un esempio di utilizzo, vedi:

Reazioni

Le reazioni rappresentano le emoji che le persone usano per reagire a un messaggio, ad esempio 👍, 🚲 e 🌞.

Riferimento alla risorsa:

Per un esempio di utilizzo, vedi:

Emoji personalizzate

Emoji personalizzate rappresentano le emoji personalizzate create e condivise all'interno dell'organizzazione in Google Chat. Le emoji personalizzate possono essere incluse nel contenuto di un messaggio o utilizzate per reagire a un messaggio.

Riferimento alla risorsa:

Contenuti multimediali e allegati

Contenuti multimediali indica un file caricato su Google Chat, come immagini, video e documenti.

Riferimento alla risorsa multimediale (non disponibile in RPC):

Gli allegati sono istanze di contenuti multimediali (file) allegati ai messaggi.

Riferimento alla risorsa:

Per un esempio di utilizzo, vedi:

Eventi dello spazio

Gli eventi dello spazio rappresentano le modifiche apportate a uno spazio o alle relative risorse secondarie, inclusi membri, messaggi e reazioni.

Riferimento alla risorsa:

Per un esempio di utilizzo, vedi:

Stati di lettura dell'utente

Gli stati di lettura degli utenti sono risorse singleton che rappresentano i dettagli dell'ultimo messaggio letto da un utente specifico in uno spazio Google Chat o in un thread di messaggi.

Riferimento alla risorsa stato di lettura dello spazio:

Riferimento alla risorsa dello stato di lettura del thread:

Per un esempio di utilizzo, vedi:

Impostazioni di notifica dello spazio utente

Le impostazioni di notifica dello spazio utente sono risorse singleton che rappresentano le impostazioni di notifica di un utente specifico in uno spazio Google Chat.

Riferimento alla risorsa:

Autenticazione

La chiamata all'API Chat richiede l'autenticazione. Ogni metodo dell'API Chat richiede l'autenticazione utente (per eseguire azioni o accedere ai dati per conto di un utente) o l'autenticazione app (per eseguire azioni o accedere ai dati come app di Chat). Alcuni metodi supportano sia l'autenticazione utente sia l'autenticazione app.

Per saperne di più sull'autenticazione in Chat, consulta la Panoramica dell'autenticazione.

Librerie client

Il modo consigliato per la maggior parte degli sviluppatori di chiamare l'API Google Chat è con le nostre librerie client di Cloud supportate ufficialmente per il linguaggio che preferisci, come Python, Java o Node.js.

Se codifichi con Google Apps Script, utilizza il servizio Chat avanzato anziché installare una libreria client.

Creare app di chat

L'API Chat ti consente di creare app Google Chat che portano i tuoi servizi e risorse direttamente in Google Chat. Puoi creare app di chat per eseguire una delle seguenti operazioni:

  • Recupera le informazioni in base alle query di testo strutturato o libero inserite dall'utente.
  • Generare report sugli incidenti o altri artefatti utilizzando le informazioni fornite dall'utente.
  • Migliora la collaborazione del team, ad esempio fornendo una "memoria del team" o pianificando le risorse.

Puoi progettare la tua app di chat utilizzando diversi stili di architettura, tra cui:

  • App interattive: rispondono all'interazione degli utenti, ad esempio @menzioni o comandi con slash, e presentano informazioni o guidano gli utenti in un flusso di lavoro con schede e finestre di dialogo.
  • App da riga di comando o webhook: invia messaggi proattivi, come sveglie o notifiche, da un altro sistema a uno spazio. Gli utenti non possono interagire direttamente con questo tipo di app.
  • App basate su eventi: iscriviti e reagisci all'attività in uno spazio Chat, ad esempio l'ingresso di un nuovo membro. In risposta a un evento, l'app può inviare un messaggio o eseguire un'altra azione.

Per maggiori dettagli sulla progettazione dell'app Chat, vedi Scegliere un'architettura per l'app Google Chat.

Vuoi vedere l'API Google Chat in azione?
Il canale Google Workspace Developers offre video con suggerimenti, trucchi e le funzionalità più recenti.