Questa guida spiega come utilizzare il metodo
patch()
nella risorsa Space
dell'API Google Chat per aggiornare uno spazio. Aggiorna uno spazio per modificare gli attributi di uno spazio, come il nome visualizzato visibile agli utenti, la descrizione e le linee guida.
Se sei un amministratore di Google Workspace, puoi chiamare il metodo patch()
per aggiornare qualsiasi spazio esistente nella tua organizzazione Google Workspace.
La
risorsa Space
rappresenta un luogo in cui persone e app di chat possono inviare messaggi,
condividere file e collaborare. Esistono diversi tipi di spazi:
- I messaggi diretti sono conversazioni 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 denominati sono luoghi permanenti in cui le persone inviano messaggi, condividono file e collaborano.
Prerequisiti
Node.js
- Un account Google Workspace Business o Enterprise 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 la libreria client Cloud Node.js.
-
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
credentials.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 la sezione 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:
- 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 la libreria client Python 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
credentials.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 la sezione Crea uno spazio. Per crearne uno in Chat, consulta la documentazione del Centro assistenza.
Java
- Un account Google Workspace Business o Enterprise 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 la libreria client Java 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
credentials.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 la sezione Crea uno spazio. Per crearne uno in Chat, consulta la documentazione del Centro assistenza.
Apps Script
- Un account Google Workspace Business o Enterprise 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.
- Crea un progetto Apps Script autonomo e attiva il servizio di chat avanzato.
- Scegli un ambito di autorizzazione che supporti l'autenticazione utente.
- Uno spazio di Google Chat. Per crearne uno utilizzando l'API Google Chat, consulta la sezione 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 l'autenticazione utente, passa quanto segue nella richiesta:
- Specifica l'ambito di autorizzazione
chat.spaces
. - Chiama il metodo
UpdateSpace()
. Nella richiesta, specifica il campo spazioname
, il campoupdateMask
con uno o più campi da aggiornare e unbody
con le informazioni aggiornate sullo spazio.
Puoi aggiornare elementi come 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 del campo
name
dello spazio. Puoi ottenere l'ID chiamando il metodo
ListSpaces()
o dall'URL dello spazio.
L'API Google Chat restituisce un'istanza di
Space
che riflette gli
aggiornamenti.
Aggiornare uno spazio come amministratore di Google Workspace
Se sei un amministratore di Google Workspace, puoi chiamare il metodo
UpdateSpace()
per aggiornare qualsiasi spazio nella tua organizzazione
Google Workspace.
Per chiamare questo metodo in qualità di amministratore di Google Workspace, procedi nel seguente modo:
- Chiama il metodo utilizzando l'autenticazione utente e specifica un ambito di autorizzazione che supporti la chiamata del metodo utilizzando privilegi amministrativi.
- Nella richiesta, specifica il parametro di query
useAdminAccess
sutrue
.
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 dell'app richiede l'approvazione dell'amministratore una sola volta.
Per aggiornare uno spazio esistente in Google Chat con l'autenticazione dell'app, passa quanto segue nella richiesta:
- Specifica l'ambito di 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 richiesta, specifica il camponame
dello spazio, il campoupdateMask
con uno o più campi da aggiornare e unbody
con le informazioni aggiornate sullo spazio.
Puoi aggiornare elementi come il nome visualizzato, il tipo di spazio, lo stato della cronologia, le 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 API di anteprima per gli sviluppatori, devi utilizzare una versione di anteprima per gli sviluppatori non pubblica del documento di rilevamento API. Per autenticare la richiesta, devi passare una chiave API.
Per creare la chiave API, apri il progetto Google Cloud della tua app e svolgi i seguenti passaggi:
- 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 può essere trovata 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 Applicare le limitazioni relative alle chiavi API.
Scrivere uno script che chiama 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 del 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 della
risorsa Space
che riflette gli
aggiornamenti.
Limitazioni e considerazioni
- Con l'autenticazione delle app,
App di chat:
- Può aggiornare solo
predefinedPermissionSettings
opermissionSettings
negli spazi che ha creato. - Impossibile aggiornare
accessSettings.audience
.
- Può aggiornare solo
Argomenti correlati
- Visualizzare i dettagli di uno spazio.
- Elenca spazi.
- Eliminare uno spazio.
- Configurare uno spazio.
- Trova uno spazio di messaggi diretti.
- Rendere uno spazio rilevabile per utenti specifici.