Excluir um espaço

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

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

O Space recurso representa um lugar em que 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 um usuário e um app do Chat.
  • As conversas em grupo são conversas entre três ou mais usuários e apps do Chat.
  • Os espaços nomeados são lugares permanentes em que as pessoas enviam mensagens, compartilham arquivos e colaboram.

Pré-requisitos

Node.js

  • Uma conta do Google Workspace Business ou Enterprise com acesso ao .

Excluir um espaço nomeado como usuário

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

  • Especifique o escopo de autorização chat.delete.
  • Chame o DeleteSpace() método.
  • Transmita o name do espaço a ser excluído.

Veja como excluir um espaço:

Node.js

chat/client-libraries/cloud/delete-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.delete'];

// This sample shows how to delete 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 = {
    // Replace SPACE_NAME here
    name: 'spaces/SPACE_NAME',
  };

  // Make the request
  const response = await chatClient.deleteSpace(request);

  // Handle the response
  console.log(response);
}

await main();

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

Excluir um espaço nomeado como um app do Chat

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

Com a autenticação do app, só é possível excluir espaços criados por apps do Chat.

Para excluir um espaço no Google Chat com a autenticação do app, transmita o seguinte na sua solicitação:

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

Escrever um script que chama a API Chat

Veja como excluir um espaço:

Python

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

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

def main():
    '''
    Authenticates with Chat API using app authentication,
    then deletes the specified space.
    '''

    # 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().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 o seguinte:

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

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

    python3 chat_space_delete_app.py

Se a solicitação for concluída, o corpo da resposta estará vazio, o que indica que o espaço foi excluído.

Excluir um espaço nomeado como admin do Google Workspace

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

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

  • Chame o método usando a autenticação do usuário e especifique um escopo de autorização que ofereça suporte à chamada do método usando privilégios de administrador.
  • Na sua solicitação, especifique o parâmetro de consulta useAdminAccess como true.

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