Questa sezione spiega come un'app Google Chat può effettuare chiamate l'API Chat, che consente alle app di Chat, ad esempio, creare uno spazio, aggiungere persone e pubblicare un messaggio senza che vi venga richiesto Evento di interazione con l'app di Chat.
Autenticazione
La chiamata all'API Chat in modo asincrono richiede l'autenticazione. Ciascuna Il metodo API Chat richiede autenticazione degli utenti (per eseguire azioni o accedere per conto di un utente) o autenticazione app (per eseguire azioni o accedere ai dati come app di Chat). Alcune supportano sia l'autenticazione utente sia quella delle app.
Per scoprire di più sull'autenticazione in Chat, vedi Panoramica dell'autenticazione.
Risorse e metodi dell'API
Le risorse e i metodi REST concedono l'accesso asincrono a Chat spazi, 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. Là esistono vari tipi di spazi. I messaggi diretti sono conversazioni 1:1 tra due utenti o un utente e un'app di Chat. Gruppo le chat sono conversazioni tra tre o più utenti e App di chat. Gli spazi con nome sono luoghi permanenti in cui gli utenti inviano messaggi, condividere file e collaborare.
La
spacesrisorsa rappresenta uno spazio.Gli spazi supportano i seguenti metodi:
- Crea uno spazio. un luogo in cui persone e app possono conversare e condividere file.
- Configurare uno spazio per creare lo spazio, a cui aggiungere persone e app di chat spazio.
- Ottieni uno spazio per vedere i dettagli di uno spazio.
- Elenco spazi per vedere un elenco impaginato e filtrabile di spazi.
- Aggiornare uno spazio di modificare gli attributi di uno spazio, come il nome visualizzato visibile all'utente, la descrizione e le linee guida.
- Eliminare uno spazio quando non è più necessario.
- Trovare un messaggio diretto per restituire un messaggio diretto tra due utenti o un messaggio diretto tra un utente e la persona che chiama App di chat.
- Membri
I membri sono utenti e app di Chat che partecipano o sono è stato invitato in uno spazio.
La
spaces.membersrisorsa rappresenta un membro.I membri supportano i seguenti metodi:
- Creare un abbonamento per aggiungere un utente o un'app a uno spazio.
- Abbonarsi per visualizzare i dettagli di un abbonamento.
- Abbonamenti all'elenco per vedere un elenco impaginato e filtrabile delle appartenenze a uno spazio.
- Aggiornare un abbonamento per modificare gli attributi di un'appartenenza, ad esempio cambiando il membro di uno spazio in un gestore dello spazio o la modifica di un gestore dello spazio in membro dello spazio.
- Eliminare un abbonamento per rimuovere un utente o un'app da uno spazio.
- Messaggi
I messaggi includono testo e carta le comunicazioni pubblicate negli spazi. Ai messaggi possono essere allegati file. Le persone possono reagire ai messaggi aggiungendo loro emoji.
La
spaces.messagesrisorsa rappresenta un messaggio.I messaggi supportano i seguenti metodi:
- Crea un messaggio per pubblicare un testo o card. Puoi anche avviare o rispondere a un thread di messaggi.
- Ricevi un messaggio per ottenere dettagli su un messaggio, ad esempio quando è stato inviato o il testo.
- Elenca messaggi per visualizzare un elenco filtrabile e impaginato dei messaggi in uno spazio.
- Aggiornare un messaggio per modificare gli attributi dei messaggi, come il testo. Puoi anche aggiungere testo a un messaggio nella scheda, o una carta a un messaggio di testo.
- Eliminare un messaggio quando non è più necessario.
- Reazioni
Le reazioni rappresentano le emoji che le persone utilizzano per reagire a un messaggio, ad esempio: 👍, ↁ e 🇦.
La
spaces.messages.reactionsrisorsa rappresenta una reazione.Le reazioni supportano i seguenti metodi:
- Creare una reazione per aggiungere un'emoji a un messaggio.
- Elencare le reazioni per vedere un elenco impaginato e filtrabile di reazioni a un messaggio.
- Eliminare 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
mediarisorsa rappresenta gli elementi multimediali allegati ai messaggi.Gli allegati sono istanze di contenuti multimediali (file) allegati ai messaggi.
La
spaces.messages.attachmentsrisorsa rappresenta un allegato. Un allegato include i contenuti multimediali e i contenuti associati allegati a un messaggio.I contenuti multimediali e gli allegati supportano i seguenti metodi:
- Caricare contenuti multimediali come allegati per caricare contenuti multimediali su Google Chat e allegarli a un messaggio.
- Scaricare contenuti multimediali come allegati per scaricare contenuti multimediali da Google Chat come file binario.
- Scaricare un allegato per recuperare i metadati relativi a un allegato di un messaggio.
- Eventi dello spazio
Gli eventi dello spazio rappresentano le modifiche a uno spazio o ai relativi spazi. risorse figlio, inclusi membri, messaggi e reazioni.
La risorsa
spaces.spaceEventrappresenta un evento nello spazio.Gli eventi spazio supportano i seguenti metodi:
- Organizzare un evento nello spazio per restituire i dettagli di un evento che si è verificato in uno spazio.
- Elencare gli eventi nello spazio per ottenere 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 di un l'ultimo messaggio letto da un utente specificato in uno spazio di Google Chat o in un messaggio .
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 stato di lettura dello spazio per restituire i dettagli sullo stato di lettura di un utente all'interno di uno spazio.
- Aggiornare lo stato di lettura dello spazio per aggiornare lo stato di lettura di un utente all'interno di uno spazio.
- Recuperare lo stato di lettura del thread per restituire i dettagli sullo stato di lettura di un utente all'interno di un thread.