Excluir um espaço

Neste guia, explicamos como usar o método delete no recurso Space da API Google Chat para excluir um espaço nomeado quando ele não é mais necessário. A exclusão de um espaço também exclui tudo o que ele contém, incluindo mensagens e anexos.

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 exclusão de um espaço requer a autenticação do usuário com o escopo de autorização chat.delete de um usuário que tenha permissão para excluir o espaço especificado.

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 exclusão de um espaço requer a autenticação do usuário com o escopo de autorização chat.delete de um usuário que tenha permissão para excluir o espaço especificado.

Excluir um espaço nomeado

Para excluir um espaço no Google Chat, transmita o seguinte na solicitação:

  • Especifique o escopo de autorização chat.delete.
  • Chame o método delete no recurso Space.
  • Transmita o name do espaço a ser excluído.

Veja como excluir um espaço:

Python

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

  2. Inclua o seguinte código em chat_space_delete.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.delete"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then deletes the specified space.
    '''

    # 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().delete(

          # The space to delete.
          #
          # 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'

      ).execute()

    # Print Chat API's response in your command line interface.
    # When deleting a space, the response body is empty.
    print(result)

if __name__ == '__main__':
    main()

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

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

    python3 chat_space_delete.py

Node.js

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

  2. Inclua o seguinte código em delete-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Deletes a Chat space.
* @return {!Promise<!Object>}
*/
async function deleteSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.delete',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.delete({name: 'spaces/SPACE'});
}

deleteSpace().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 delete-space.js

    Se a solicitação for bem-sucedida, o corpo da resposta vai ficar vazio, o que indica que o espaço foi excluído.