Atualizar um espaço

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

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

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

Pré-requisitos

Python

  • Python 3.6 ou superior
  • A ferramenta de gerenciamento de pacotes pip

  • As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.

  • Autorização configurada para o app do Chat. A atualização de um espaço exige a autenticação do usuário com o escopo de autorização chat.spaces.

Node.js

  • Node.js e npm

  • As bibliotecas de cliente mais recentes do Google para Node.js. Para instalá-los, execute o seguinte comando na interface de linha de comando:

    npm install @google-cloud/local-auth @googleapis/chat
  • Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.

  • Autorização configurada para o app do Chat. A atualização de um espaço exige a autenticação do usuário com o escopo de autorização chat.spaces.

Atualizar um espaço

Para atualizar um espaço no Google Chat, envie o seguinte na solicitação:

  • Especifique o escopo de autorização chat.spaces.
  • Chame o método patch no recurso Space e transmita o name do espaço a ser atualizado, um updateMask e um body que especifique os atributos atualizados do espaço.
  • O updateMask especifica os aspectos do espaço a ser atualizado e inclui o seguinte:
    • displayName: atualiza o nome legível pelo usuário do espaço mostrado na interface do Google Chat. Oferece suporte apenas à mudança do nome de exibição de um espaço com o tipo SPACE ou ao incluir também a máscara spaceType para mudar um tipo de espaço GROUP_CHAT para SPACE. Tentar atualizar o nome de exibição de um espaço GROUP_CHAT ou DIRECT_MESSAGE resulta em um erro de argumento inválido.
    • spaceType: atualiza o tipo de espaço, mas só oferece suporte à mudança de um tipo de espaço GROUP_CHAT para SPACE. Inclua displayName com spaceType na máscara de atualização e verifique se o espaço especificado tem um displayName não vazio e o tipo de espaço SPACE. Se o espaço existente já tiver o tipo SPACE, incluindo a máscara spaceType e o tipo SPACE no espaço especificado ao atualizar o nome de exibição, será opcional . Tentar atualizar o tipo de espaço de outras maneiras resulta em um erro de argumento inválido.
    • spaceDetails: detalhes sobre o espaço, incluindo descrição e regras.
    • spaceHistoryState: permite ativar ou desativar o histórico no espaço se a organização permitir que os usuários mudem a configuração do histórico. Mutuamente exclusivo com todos os outros caminhos de campo.

Saiba como atualizar o spaceDetails de um espaço:

Python

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

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

if __name__ == '__main__':
    main()

  3. No código, substitua SPACE por um nome de espaço, que pode ser obtido no 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.py

Node.js

  1. No diretório de trabalho, crie um arquivo chamado update-space.js.

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

  3. No código, substitua SPACE por um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.

  4. No diretório de trabalho, execute o exemplo:

    node update-space.js

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