Questa guida spiega come utilizzare il metodo patch
nella risorsa Space
di
l'API Google Chat per aggiornare uno spazio. Aggiorna uno spazio per modificare gli attributi relativi a un
dello spazio di archiviazione, come il nome visualizzato, la descrizione e le linee guida visibili all'utente.
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 collaborare.
Prerequisiti
Python
- Un'azienda o un'impresa Google Workspace con accesso a Google Chat.
- Python 3.6 o versioni successive
- Lo strumento di gestione dei pacchetti pip
- Le librerie client di Google più recenti. Per installarle o aggiornarle,
esegui questo comando nell'interfaccia a riga di comando:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- 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.
-
Creare credenziali con ID client OAuth per un'applicazione desktop. Per eseguire l'esempio in questo
guida, salva le credenziali come file JSON (
client_secrets.json
) nel tuo nella directory locale.
- Scegli un ambito di autorizzazione che supporti l'autenticazione degli utenti.
Node.js
- Un'azienda o un'impresa Google Workspace con accesso a Google Chat.
- Node.js 14 o versioni successive
- npm strumento di gestione dei pacchetti
- Le librerie client di Google più recenti. Per installarle o aggiornarle,
esegui questo comando nell'interfaccia a riga di comando:
npm install @google-cloud/local-auth @googleapis/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.
-
Creare credenziali con ID client OAuth per un'applicazione desktop. Per eseguire l'esempio in questo
guida, salva le credenziali come file JSON (
client_secrets.json
) nel tuo nella directory locale.
- Scegli un ambito di autorizzazione che supporti l'autenticazione degli utenti.
Aggiornare uno spazio
Per aggiornare uno spazio esistente in Google Chat, trasmetti quanto segue nella tua richiesta:
- Specifica l'ambito dell'autorizzazione
chat.spaces
. - Chiama il
Metodo
patch
sulla risorsaSpace
. Nel 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, il nome visualizzato, il tipo di spazio, lo stato della cronologia altro ancora. Per visualizzare tutti i campi che puoi aggiornare, consulta: la documentazione di riferimento.
Ecco come aggiornare il campo spaceDetails
di uno spazio esistente:
Python
- Nella directory di lavoro, crea un file denominato
chat_space_update.py
. Includi il seguente codice in
chat_space_update.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.spaces"] def main(): ''' Authenticates with Chat API via user credentials, then updates the specified space description and guidelines. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # 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
SPACE
con il nome di uno spazio, che che puoi ottenere Metodospaces.list
nell'API Chat o dall'URL di uno spazio.Nella directory di lavoro, crea ed esegui l'esempio:
python3 chat_space_update.py
Node.js
- Nella directory di lavoro, crea un file denominato
update-space.js
. Includi il seguente codice in
update-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a Chat space with the description and guidelines. * @return {!Promise<!Object>} */ async function updateSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.patch({ name: 'spaces/SPACE', updateMask: 'spaceDetails', requestBody: { spaceDetails: { description: 'This description was updated with Chat API!', guidelines: 'These guidelines were updated with Chat API!' }, } }); } updateSpace().then(console.log);
Nel codice, sostituisci
SPACE
con il nome di uno spazio, che che puoi ottenere Metodospaces.list
nell'API Chat o dall'URL di uno spazio.Nella directory di lavoro, esegui l'esempio:
node update-space.js
L'API Google Chat restituisce un'istanza
Space
risorsa che riflette gli 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.