Update a space (original) (raw)

This guide explains how to use thepatch()method on the Space resource of the Google Chat API to update a space. Update a space to change attributes about a space, like its user-visible display name, description, and guidelines.

If you're a Google Workspace administrator, you can call the patch() method to update any existing space in your Google Workspace organization.

TheSpace resourcerepresents a place where people and Chat apps can send messages, share files, and collaborate. There are several types of spaces:

Prerequisites

Node.js

#set-up-environment).

Python

#set-up-environment).

Java

#set-up-environment).

Apps Script

Update a space as a user

To update an existing space in Google Chat withuser authentication, pass the following in your request:

You can update things like the display name, space type, history state, and more. To see all the fields you can update, see the reference documentation.

Here's how to update the displayName field of an existing space:

Node.js

Python

Java

Apps Script

To run this sample, replace SPACE_NAME with the ID from the space'snamefield. You can obtain the ID by calling theListSpaces()method or from the space's URL.

The Google Chat API returns an instance of theSpace reflecting the updates.

Update a space as a Google Workspace administrator

If you're a Google Workspace administrator, you can call theUpdateSpace() method to update any space in your Google Workspace organization.

To call this method as a Google Workspace administrator, do the following:

For more information and examples, seeManage Google Chat spaces as a Google Workspace administrator.

Update a space as a Chat app

App authentication requires one-timeadministrator approval.

To update an existing space in Google Chat withapp authentication, pass the following in your request:

You can update things like the display name, space type, history state, permission settings, and more. To see all the fields you can update, see the reference documentation.

Write a script that calls Chat API

Here's how to update the spaceDetails field of an existing space:

Python

  1. In your working directory, create a file named chat_space_update_app.py.
  2. Include the following code 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)  
    # 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()
  1. In the code, replace the following:
    • SPACE with a space name, which you can obtain from thespaces.list methodin the Chat API, or from a space's URL.
  2. In your working directory, build and run the sample:
python3 chat_space_update_app.py

The Google Chat API returns an instance of theSpace resource reflecting the updates.

Limitations and considerations