Atualizar um espaço

Este guia explica como usar o método patch() no recurso Space da API Google Chat para atualizar um espaço. Atualize um espaço para mudar atributos, como o nome de exibição visível para o usuário, a descrição e as diretrizes.

Se você for admin do Google Workspace, poderá chamar o método patch() para atualizar qualquer espaço na sua organização do Google Workspace.

O recurso Space representa um lugar onde pessoas e apps do Chat podem enviar mensagens, compartilhar arquivos e colaborar. Há vários tipos de espaços:

  • As mensagens diretas (DMs) são conversas entre dois usuários ou entre um usuário e um app do Chat.
  • Os chats em grupo são conversas entre três ou mais usuários e apps de chat.
  • Os espaços nomeados são lugares permanentes onde as pessoas enviam mensagens, compartilham arquivos e colaboram.

Pré-requisitos

Node.js

Python

Java

Apps Script

Atualizar um espaço como usuário

Para atualizar um espaço no Google Chat com autenticação de usuário, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.spaces.
  • Chame o método UpdateSpace(). Na solicitação, especifique o campo name do espaço, o campo updateMask com um ou mais campos a serem atualizados e um body com as informações atualizadas do espaço.

É possível atualizar o nome de exibição, o tipo de espaço, o estado do histórico e muito mais. Para conferir todos os campos que podem ser atualizados, consulte a documentação de referência.

Saiba como atualizar o campo displayName de um espaço:

Node.js

chat/client-libraries/cloud/update-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';  const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces'];  // This sample shows how to update a space with user credential async function main() {   // Create a client   const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);    // Initialize request argument(s)   const request = {     space: {       // Replace SPACE_NAME here       name: 'spaces/SPACE_NAME',       displayName: 'New space display name'     },     // The field paths to update. Separate multiple values with commas or use     // `*` to update all field paths.     updateMask: {       // The field paths to update.       paths: ['display_name']     }   };    // Make the request   const response = await chatClient.updateSpace(request);    // Handle the response   console.log(response); }  main().catch(console.error);

Python

chat/client-libraries/cloud/update_space_user_cred.py
from authentication_utils import create_client_with_user_credentials from google.apps import chat_v1 as google_chat  SCOPES = ["https://www.googleapis.com/auth/chat.spaces"]  # This sample shows how to update a space with user credential def update_space_with_user_cred():     # Create a client     client = create_client_with_user_credentials(SCOPES)      # Initialize request argument(s)     request = google_chat.UpdateSpaceRequest(         space = {             # Replace SPACE_NAME here             'name': 'spaces/SPACE_NAME',             'display_name': 'New space display name'         },         # The field paths to update. Separate multiple values with commas.         update_mask = 'displayName'     )      # Make the request     response = client.update_space(request)      # Handle the response     print(response)  update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.UpdateSpaceRequest; import com.google.chat.v1.Space; import com.google.protobuf.FieldMask;  // This sample shows how to update space with user credential. public class UpdateSpaceUserCred {    private static final String SCOPE =     "https://www.googleapis.com/auth/chat.spaces";    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithUserCredentials(           ImmutableList.of(SCOPE))) {       UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()         .setSpace(Space.newBuilder()           // Replace SPACE_NAME here.           .setName("spaces/SPACE_NAME")           .setDisplayName("New space display name"))         .setUpdateMask(FieldMask.newBuilder()           // The field paths to update.           .addPaths("display_name"));       Space response = chatServiceClient.updateSpace(request.build());        System.out.println(JsonFormat.printer().print(response));     }   } }

Apps Script

chat/advanced-service/Main.gs
/**  * This sample shows how to update a space with user credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'  * referenced in the manifest file (appsscript.json).  */ function updateSpaceUserCred() {   // Initialize request argument(s)   // TODO(developer): Replace SPACE_NAME here   const name = 'spaces/SPACE_NAME';   const space = {     displayName: 'New space display name'   };   // The field paths to update. Separate multiple values with commas or use   // `*` to update all field paths.   const updateMask = 'displayName';    // Make the request   const response = Chat.Spaces.patch(space, name, {     updateMask: updateMask   });    // Handle the response   console.log(response); }

Para executar este exemplo, substitua SPACE_NAME pelo ID do campo name do espaço. Você pode conseguir o ID chamando o método ListSpaces() ou no URL do espaço.

A API Google Chat retorna uma instância do Space refletindo as atualizações.

Atualizar um espaço como administrador do Google Workspace

Se você for admin do Google Workspace, chame o método UpdateSpace() para atualizar qualquer espaço na sua organização do Google Workspace.

Para chamar esse método como administrador do Google Workspace, faça o seguinte:

Para mais informações e exemplos, consulte Gerenciar espaços do Google Chat como administrador do Google Workspace.

Atualizar um espaço como um app do Chat

A autenticação do app exige uma única aprovação do administrador.

Para atualizar um espaço existente no Google Chat com autenticação de app, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.app.spaces. Com a autenticação de apps, só é possível atualizar espaços criados por apps do Chat.
  • Chame o método patch no recurso Space. Na solicitação, especifique o campo name do espaço, o campo updateMask com um ou mais campos a serem atualizados e um body com as informações atualizadas do espaço.

É possível atualizar o nome de exibição, o tipo de espaço, o estado do histórico, as configurações de permissão e muito mais. Para conferir todos os campos que podem ser atualizados, consulte a documentação de referência.

Escrever um script que chama a API Chat

Saiba como atualizar o campo spaceDetails de um espaço:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_space_update_app.py.

  2. Inclua o seguinte código em 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()

  3. No código, substitua o seguinte:

    • SPACE com um nome de espaço, que pode ser obtido com o método spaces.list na API Chat ou no URL de um espaço.

  4. No diretório de trabalho, crie e execute a amostra:

    python3 chat_space_update_app.py

A API Google Chat retorna uma instância do recurso Space refletindo as atualizações.

Limitações e considerações