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 con l'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 dell'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 la 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 luoghi permanenti in cui le persone inviano messaggi, condividono file e collaborano.
La risorsa
spaces
rappresenta uno spazio.Gli spazi supportano i seguenti metodi:
- Crea uno spazio, un luogo in cui persone e app possono conversare e condividere file.
- Configura uno spazio per crearlo a cui aggiungere persone e app di chat.
- Ottieni uno spazio per visualizzarne i dettagli.
- Elenca spazi per visualizzare un elenco di spazi impaginato e filtrabile.
- Aggiorna uno spazio per modificarne gli attributi, 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 hanno partecipato a uno spazio o sono stati invitati a entrare in uno spazio.
La risorsa
spaces.members
rappresenta un membro.I membri supportano i seguenti metodi:
- Crea un abbonamento per aggiungere un utente o un'app a uno spazio.
- Acquista un abbonamento per visualizzare i dettagli di un abbonamento.
- Appartenenze all'elenco per visualizzare un elenco impaginato e filtrabile delle iscrizioni a uno spazio.
- Aggiorna un'appartenenza per modificare gli attributi di un'appartenenza, ad esempio per cambiare un membro dello spazio in gestore dello spazio o cambiare un gestore dello spazio in membro dello spazio.
- Elimina un abbonamento per rimuovere un utente o un'app da uno spazio.
- Messaggi
I messaggi includono comunicazioni di testo e schede pubblicate negli spazi. Ai messaggi possono essere allegati file. Le persone possono reagire ai messaggi aggiungendo loro emoji.
La risorsa
spaces.messages
rappresenta un messaggio.I messaggi supportano i seguenti metodi:
- Crea un messaggio per pubblicare un messaggio di testo o di scheda. Puoi anche avviare o rispondere a un thread di messaggi.
- Ricevere un messaggio per visualizzarne i dettagli, ad esempio quando è stato inviato o il testo.
- Elenca i messaggi per visualizzare un elenco impaginato e filtrabile di messaggi in uno spazio.
- Aggiorna un messaggio per modificarne gli attributi, ad esempio il testo. Puoi anche aggiungere del testo a un messaggio nella scheda o una scheda a un messaggio di testo.
- Elimina un messaggio quando non è più necessario.
- Reazioni
Le reazioni rappresentano le emoji utilizzate dalle persone per reagire a un messaggio, ad esempio 👍, 🏏 e dmca.
La risorsa
spaces.messages.reactions
rappresenta una reazione.Le reazioni supportano i seguenti metodi:
- Crea una reazione per aggiungere un'emoji a un messaggio.
- Elenca le reazioni per vedere un elenco impaginato e filtrabile di 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
media
rappresenta i contenuti multimediali allegati ai messaggi.Gli allegati sono istanze di contenuti multimediali (file) allegati ai messaggi.
La risorsa
spaces.messages.attachments
rappresenta 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 elementi multimediali come allegati per caricarli in Google Chat e quindi allegarli a un messaggio.
- Scarica contenuti multimediali come allegato per scaricare contenuti multimediali da Google Chat come file binario.
- Ottieni un allegato per recuperare i metadati relativi a un allegato di un messaggio.
- Eventi dello spazio
Gli eventi dello spazio rappresentano le modifiche apportate a uno spazio o alle relative risorse figlio, inclusi i membri, i messaggi e le reazioni.
La risorsa
spaces.spaceEvent
rappresenta un evento dello spazio.Gli eventi spazio supportano i seguenti metodi:
- Recupera un evento dello spazio per restituire i dettagli di un evento che si è verificato in uno spazio.
- Elenca eventi dello spazio per visualizzare un elenco degli eventi che si sono verificati in uno spazio.
- Stati di lettura dell'utente
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 di un thread di messaggi.
La risorsa
users.spaces
rappresenta lo stato di lettura di un utente in uno spazio.La risorsa
users.spaces.threads
rappresenta lo stato di lettura di un utente in un thread di messaggi.Gli stati di lettura dell'utente supportano i seguenti metodi:
- Ottieni stato di lettura dello spazio per restituire i 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 del thread per restituire i dettagli sullo stato di lettura di un utente all'interno di un thread.