Questa guida spiega come utilizzare
patch()
sulla risorsa Space
dell'API Google Chat per aggiornare uno spazio. Aggiornare un
spazio per modificarne gli attributi, ad esempio il nome visualizzato, la descrizione e le linee guida visibili agli utenti.
Se sei un amministratore di Google Workspace, puoi chiamare il metodo patch()
per aggiornare qualsiasi spazio esistente nella tua organizzazione Google Workspace.
La
Space
risorsa
rappresenta un luogo in cui le persone e le app di chat possono inviare messaggi,
condividere file e collaborare. Esistono diversi tipi di spazi:
- I messaggi diretti sono conversazioni 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.
Prerequisiti
Node.js
- Un'azienda o un'impresa Google Workspace con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di chat.
- Installa il Node.js libreria client di Cloud.
-
Creare le credenziali con ID client OAuth per un'applicazione desktop. Per eseguire l'esempio in questo
guida, salva le credenziali come file JSON denominato
client_secrets.json
nel tuo nella directory locale.
- Scegli un ambito di autorizzazione che supporti l'autenticazione degli utenti.
- Uno spazio di Google Chat. Per crearne uno utilizzando l'API Google Chat, consulta Crea uno spazio. Per crearne uno in Chat, consulta la documentazione del Centro assistenza.
Python
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Creare un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Abilita e configura l'API Google Chat con un nome, l'icona e la descrizione dell'app Chat.
- Installa il Python libreria client di Cloud.
-
Crea le credenziali dell'ID client OAuth per un'applicazione desktop. Per eseguire l'esempio in questa
guida, salva le credenziali come file JSON denominato
client_secrets.json
nella directory locale.
- Scegli un ambito di autorizzazione che supporti l'autenticazione utente.
- Uno spazio di Google Chat. Per crearne uno utilizzando l'API Google Chat, consulta Creare uno spazio. Per crearne uno in Chat, consulta la documentazione del Centro assistenza.
Java
- Un'azienda o un'impresa Google Workspace con accesso a Google Chat.
- Configura l'ambiente:
- Creare un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di chat.
- Installa il Java libreria client di Cloud.
-
Creare le credenziali con ID client OAuth per un'applicazione desktop. Per eseguire l'esempio in questa
guida, salva le credenziali come file JSON denominato
client_secrets.json
nella directory locale.
- Scegli un ambito di autorizzazione che supporti l'autenticazione utente.
- Uno spazio di Google Chat. Per crearne uno utilizzando l'API Google Chat, consulta Creare uno spazio. Per crearne uno in Chat: visita il documentazione del Centro assistenza.
Apps Script
- Un'azienda o un'impresa Google Workspace con accesso a Google Chat.
- Configura l'ambiente:
- Creare un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di chat.
- Creare un progetto Apps Script autonomo e attivare il Servizio di chat avanzato.
- Scegli un ambito di autorizzazione che supporti l'autenticazione degli utenti.
- Uno spazio di Google Chat. Per crearne uno utilizzando l'API Google Chat, consulta Crea uno spazio. Per crearne uno in Chat, consulta la documentazione del Centro assistenza.
Aggiornare uno spazio come utente
Per aggiornare uno spazio esistente in Google Chat con autenticazione dell'utente, quanto segue nella tua richiesta:
- Specifica l'ambito di autorizzazione
chat.spaces
. - Chiama il metodo
UpdateSpace()
. Nella richiesta, specifica il camponame
dello spazio, il campoupdateMask
con uno o più campi da aggiornare e unbody
con le informazioni aggiornate dello spazio.
Puoi aggiornare elementi quali il nome visualizzato, il tipo di spazio, lo stato della cronologia e altro ancora. Per visualizzare tutti i campi che puoi aggiornare, consulta: la documentazione di riferimento.
Ecco come aggiornare il campo displayName
di uno spazio esistente:
Node.js
Python
Java
Apps Script
Per eseguire questo esempio, sostituisci SPACE_NAME
con l'ID di
dello spazio
name
. Puoi ottenere l'ID chiamando il metodo
ListSpaces()
o dall'URL dello spazio.
L'API Google Chat restituisce un'istanza
Space
che riflette il
aggiornamenti.
Aggiornare uno spazio come amministratore di Google Workspace
Se sei un amministratore di Google Workspace, puoi chiamare il metodoUpdateSpace()
per aggiornare qualsiasi spazio della tua organizzazione Google Workspace.
Per chiamare questo metodo in qualità di amministratore di Google Workspace:
- Richiama il metodo utilizzando l'autenticazione utente e specifica ambito di autorizzazione che supporta la chiamata al metodo mediante privilegi amministrativi.
- Nella richiesta, specifica il parametro di query
useAdminAccess
pertrue
.
Per ulteriori informazioni ed esempi, vedi Gestire gli spazi di Google Chat come amministratore di Google Workspace.
Aggiornare uno spazio come app di Chat
L'autenticazione app richiede una sola volta approvazione degli amministratori.
Per aggiornare uno spazio esistente in Google Chat con autenticazione app, invia quanto segue nella richiesta:
- Specifica l'ambito dell'autorizzazione
chat.app.spaces
. Con l'autenticazione delle app, puoi aggiornare solo gli spazi creati dalle app di Chat. - Chiama il
Metodo
patch
sulla risorsaSpace
. Nella la tua richiesta, specifica il camponame
dello spazio,updateMask
campo con uno o più campi da aggiornare e unbody
con le informazioni sullo spazio aggiornate.
Puoi aggiornare, ad esempio, nome visualizzato, tipo di spazio, stato della cronologia impostazioni delle autorizzazioni e altro ancora. Per visualizzare tutti i campi che puoi aggiornare, consulta la documentazione di riferimento.
crea una chiave API
Per chiamare un metodo dell'API Developer Preview, devi utilizzare una versione di anteprima per lo sviluppatore non pubblica del documento di rilevamento dell'API. Per autenticare la richiesta, devi passare una chiave API.
Per creare la chiave API, apri il progetto Google Cloud della tua app ed effettua le seguenti operazioni:
- Nella console Google Cloud, vai a Menu > API e servizi > Credenziali.
- Fai clic su Crea credenziali > Chiave API.
- Viene visualizzata la nuova chiave API.
- Fai clic su Copia per copiare la chiave API da utilizzare nel codice dell'app. La chiave API è disponibile anche nella sezione "Chiavi API" delle credenziali del progetto.
- Fai clic su Limita chiave per aggiornare le impostazioni avanzate e limitare l'utilizzo della chiave API. Per maggiori dettagli, consulta Applicazione di limitazioni relative alle chiavi API.
Scrivi uno script che chiami l'API Chat
Ecco come aggiornare il campo spaceDetails
di uno spazio esistente:
Python
- Nella directory di lavoro, crea un file denominato
chat_space_update_app.py
. Includi il seguente codice in
chat_space_update_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()
Nel codice, sostituisci quanto segue:
API_KEY
: la chiave API che hai creato per creare l'endpoint di servizio per l'API Chat.SPACE
con il nome di uno spazio, che puoi ottenere dal metodospaces.list
nell'API Chat o dall'URL di uno spazio.
Nella directory di lavoro, compila ed esegui l'esempio:
python3 chat_space_update_app.py
L'API Google Chat restituisce un'istanza
Space
risorsa che riflette la
aggiornamenti.
Argomenti correlati
- Ottenere dettagli su uno spazio.
- Elenca spazi.
- Eliminare uno spazio.
- Configura uno spazio.
- Trova uno spazio per i messaggi diretti.
- Rendere uno spazio rilevabile per utenti specifici.