Questa sezione spiega in che modo un'app Google Chat può chiamare l'API Chat, che consente alle app di Chat di eseguire operazioni come creare uno spazio, aggiungere persone e pubblicare un messaggio senza che venga richiesto da un evento di interazione nell'app Chat.
Autenticazione
La chiamata all'API Chat in modo asincrono richiede l'autenticazione. Ogni metodo dell'API Chat richiede l'autenticazione dell'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 delle app.
Per scoprire di più sull'autenticazione in Chat, consulta Panoramica dell'autenticazione.
Risorse e metodi dell'API
Le risorse e i metodi REST concedono l'accesso asincrono a spazi di Chat, membri dello spazio, messaggi, reazioni ai messaggi e allegati dei messaggi.
- 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 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 spazi permanenti in cui le persone inviano messaggi, condividono file e collaborano.
La risorsa
spacesrappresenta uno spazio.Gli spazi supportano i seguenti metodi:
- Crea uno spazio, ovvero un luogo in cui persone e app possono conversare e condividere file.
- Configura uno spazio per creare lo spazio e aggiungi persone e app di chat allo spazio.
- Acquista uno spazio per visualizzarne i dettagli.
- Elenca spazi per visualizzare un elenco di spazi filtrabile e impaginato.
- Aggiornare uno spazio per modificare gli attributi dello spazio, come il nome visualizzato visibile all'utente, la descrizione e le linee guida.
- Eliminare uno spazio quando non è più necessario.
- Trova un messaggio diretto per restituire un messaggio diretto tra due utenti o un messaggio diretto tra un utente e le app di Chat che chiamano.
- Membri
I membri sono utenti e app di chat che partecipano o sono stati invitati a uno spazio.
La risorsa
spaces.membersrappresenta un membro.Gli abbonati supportano i seguenti metodi:
- Crea un abbonamento per aggiungere un utente o un'app a uno spazio.
- Abbonati per visualizzarne i dettagli.
- Appartenenze a un elenco per visualizzare un elenco filtrabile e impaginato delle appartenenze a uno spazio.
- Aggiornare un abbonamento per modificare gli attributi di un membro, ad esempio cambiare un membro dello spazio in gestore dello spazio o cambiare un gestore in un membro dello spazio.
- Eliminare un abbonamento per rimuovere un utente o un'app da uno spazio.
- Messaggi
I messaggi includono comunicazioni di tipo testo e schede pubblicate negli spazi. Ai messaggi possono essere allegati file. Le persone possono reagire ai messaggi aggiungendo emoji.
La risorsa
spaces.messagesrappresenta un messaggio.I messaggi supportano i seguenti metodi:
- Crea un messaggio per pubblicare un messaggio di testo o una scheda. Puoi anche avviare un thread di messaggi o rispondere.
- Ricevere un messaggio per avere i dettagli di un messaggio, come quando è stato inviato o cosa dice.
- Elenca messaggi per visualizzare un elenco filtrabile e impaginato dei messaggi in uno spazio.
- Aggiornare un messaggio per modificare gli attributi del messaggio, ad esempio la descrizione. Puoi anche aggiungere testo a un messaggio con scheda o una scheda a un messaggio di testo.
- Elimina un messaggio quando non è più necessario.
- Reazioni
Le reazioni rappresentano le emoji usate dalle persone per reagire a un messaggio, ad esempio 👍, ☁ e Suggest.
La risorsa
spaces.messages.reactionsrappresenta una reazione.Le reazioni supportano i seguenti metodi:
- Crea una reazione per aggiungere un'emoji a un messaggio.
- Elencare le reazioni per visualizzare un elenco filtrabile e impaginato delle reazioni a un messaggio.
- Elimina una reazione per rimuovere un'emoji dal messaggio.
- Contenuti multimediali e allegati
Contenuti multimediali rappresenta un file caricato su Google Chat, come immagini, video e documenti.
La risorsa
mediarappresenta i contenuti multimediali allegati ai messaggi.Gli allegati sono istanze di file multimediali allegati ai messaggi.
La risorsa
spaces.messages.attachmentsrappresenta un collegamento. Un allegato include i contenuti multimediali e i metadati associati allegati a un messaggio.I contenuti multimediali e gli allegati supportano i seguenti metodi:
- Carica i contenuti multimediali come allegato per caricare i contenuti multimediali su Google Chat e quindi allegarli a un messaggio.
- Scarica contenuti multimediali come allegato per scaricare contenuti multimediali da Google Chat come file binario.
- Ottenere un allegato per recuperare i metadati relativi a un allegato a un messaggio.
- Eventi dello spazio
Gli eventi dello spazio rappresentano le modifiche apportate a uno spazio o alle relative risorse secondarie, inclusi i membri, i messaggi e le reazioni.
La risorsa
spaces.spaceEventrappresenta un evento nello spazio.Gli eventi dello spazio supportano i seguenti metodi:
- Recuperare un evento dello spazio per restituire i dettagli di un evento che si è verificato in uno spazio.
- Elenca gli eventi dello spazio per ottenere un elenco degli eventi che si sono verificati in uno spazio.
- Stati di lettura dell'utente (anteprima per sviluppatori)
Gli stati di lettura dell'utente sono risorse singleton che rappresentano i dettagli dell'ultimo messaggio letto di un utente specificato in uno spazio di Google Chat o in un thread di messaggi.
La risorsa
users.spacesrappresenta lo stato di lettura di un utente in uno spazio.La risorsa
users.spaces.threadsrappresenta lo stato di lettura di un utente in un thread di messaggi.Gli stati di lettura dell'utente supportano i seguenti metodi:
- Ottieni lo stato di lettura dello spazio per restituire dettagli sullo stato di lettura di un utente all'interno di uno spazio.
- Aggiorna lo stato di lettura dello spazio per aggiornare lo stato di lettura di un utente all'interno di uno spazio.
- Ottieni lo stato di lettura dei thread per restituire dettagli sullo stato di lettura di un utente all'interno di un thread.