Cómo borrar un espacio

En esta guía, se explica cómo usar la delete() en el recurso Space de la API de Google Chat para borrar un espacio con nombre cuando ya no es necesario. Cuando borras un espacio, también se borra todo lo que contiene, incluidos los mensajes y los archivos adjuntos.

Si eres administrador de Google Workspace, puedes llamar al delete() para borrar cualquier espacio con nombre de tu organización de Google Workspace.

El Recurso Space representa un lugar donde las personas y las apps de Chat pueden enviar mensajes, compartir archivos y colaborar. Existen varios tipos de espacios:

  • Los mensajes directos (MD) son conversaciones entre dos usuarios o un usuario y una app de Chat.
  • Los chats en grupo son conversaciones entre tres o más usuarios y apps de chat.
  • Los espacios con nombre son lugares persistentes donde las personas envían mensajes, y colaborar.

Requisitos previos

Node.js

Cómo borrar un espacio con nombre como usuario

Para borrar un espacio existente en Google Chat, sigue estos pasos: autenticación de usuario, pasar lo siguiente en tu solicitud:

  • Especifica el alcance de la autorización chat.delete.
  • Realiza una llamada al método DeleteSpace().
  • Pasa el name del espacio que quieres borrar.

Sigue estos pasos para borrar un espacio:

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);
}

main().catch(console.error);

Para ejecutar este ejemplo, reemplaza SPACE_NAME por el ID del campo name del espacio. Para obtener el ID, llama al método ListSpaces() o desde la URL del espacio.

Borra un espacio con nombre como app de Chat

La autenticación de apps requiere una aprobación del administrador única.

Con la autenticación de apps, solo puedes borrar los espacios creados por Apps de Chat

Para borrar un espacio existente en Google Chat, sigue estos pasos: autenticación de app, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de la autorización chat.app.delete.
  • Llama al Método delete en el recurso Space.
  • Pasa el name del espacio que quieres borrar.

Crea una clave de API

Para llamar a un método de la API de la Versión preliminar para desarrolladores, debes usar una versión no pública de la versión preliminar para desarrolladores del documento de descubrimiento de la API. Para autenticar la solicitud, debes pasar una clave de API.

Para crear la clave de API, abre el proyecto de Google Cloud de tu app y haz lo siguiente:

  1. En la consola de Google Cloud, ve a Menú > APIs y servicios > Credenciales.

    Ir a Credenciales

  2. Haz clic en Crear credenciales >. Clave de API.
  3. Se mostrará tu nueva clave de API.
    • Haz clic en Copiar para copiar la clave de API y usarla en el código de tu app. La clave de API también se puede encontrar en la sección "Claves de API" de las credenciales de tu proyecto.
    • Haz clic en Restringir clave para actualizar la configuración avanzada y limitar el uso de tu clave de API. Para obtener más detalles, consulta Aplica restricciones de claves de API.

Escribe una secuencia de comandos que llame a la API de Chat

Sigue estos pasos para borrar un espacio:

Python

  1. En tu directorio de trabajo, crea un archivo llamado chat_space_delete_app.py.

  2. Incluye el siguiente código en 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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. En el código, reemplaza lo siguiente:

    • API_KEY: Es la clave de API que creaste para compilar el extremo de servicio de la API de Chat.

    • SPACE con el nombre del espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

  4. En tu directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_space_delete_app.py

Si el proceso es satisfactorio, el cuerpo de la respuesta estará vacío, lo que indica que el espacio es borrar.

Borra un espacio con nombre como administrador de Google Workspace

Si eres administrador de Google Workspace, puedes llamar al DeleteSpace() para borrar cualquier espacio con nombre de tu organización de Google Workspace.

Para llamar a este método como administrador de Google Workspace, haz lo siguiente:

Para obtener más información y ejemplos, consulta Cómo administrar espacios de Google Chat como administrador de Google Workspace.