Cómo borrar una suscripción a Google Workspace

En esta página, se explica cómo borrar una suscripción a Google Workspace con el subscriptions.delete() método.

Cuando borras una suscripción, tu app ya no recibe ningún evento. Si una suscripción vence, la API de Google Workspace Events la borra automáticamente.

Requisitos previos

Apps Script

  • Un proyecto de Apps Script:
    • Usa tu proyecto de Google Cloud en lugar del predeterminado que crea Apps Script automáticamente.
    • Para todos los permisos que agregaste para configurar la pantalla de consentimiento de OAuth, también debes agregar los permisos al archivo appsscript.json en tu proyecto de Apps Script. Por ejemplo, si especificaste el permiso chat.messages, agrega lo siguiente: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages"
]
    • Habilita el Google Workspace Events servicio avanzado.

Python

  • Python 3.6 o una versión superior
  • La herramienta de administración de paquetes pip
  • Las bibliotecas cliente de Google más recientes para Python. Para instalarlas o actualizarlas, ejecuta el siguiente comando en tu interfaz de línea de comandos: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

Borra una suscripción autorizada por un usuario

En la siguiente muestra de código, se borra un Subscription recurso con la autenticación del usuario.

Para borrar una suscripción, haz lo siguiente:

Apps Script

  1. En tu proyecto de Apps Script, crea un archivo de secuencia de comandos nuevo llamado deleteSubscription y agrega el siguiente código:

    function deleteSubscription() {
  // The name of the subscription to delete.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.remove(name);
  console.log(response);
}

    Reemplaza lo siguiente:

    • SUBSCRIPTION_ID: Es el ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
      • El valor del uid campo.
      • El ID del nombre del recurso representado en el name campo. Por ejemplo, si el nombre del recurso es subscriptions/subscription-123, usa subscription-123.

  2. Para borrar la suscripción, ejecuta la función deleteSubscription en tu proyecto de Apps Script.

Python

  1. En tu directorio de trabajo, crea un archivo llamado delete_subscription.py y agrega el siguiente código:

    """Delete subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = ['SCOPE']

# Authenticate with Google Workspace and get user authentication.
flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)
CREDENTIALS = flow.run_local_server()

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

NAME = 'subscriptions/SUBSCRIPTION_ID'
response = service.subscriptions().delete(name=NAME).execute()
print(response)

    Reemplaza lo siguiente:

    • SCOPE: Es un permiso de OAuth que admite al menos un tipo de evento de la suscripción. Por ejemplo, si tu suscripción recibe eventos de un espacio de Chat actualizado, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: Es el ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
      • El valor del uid campo.
      • El ID del nombre del recurso representado en el name campo. Por ejemplo, si el nombre del recurso es subscriptions/subscription-123, usa subscription-123.

  2. En tu directorio de trabajo, asegúrate de haber almacenado tus credenciales de ID de cliente de OAuth y de haber nombrado el archivo credentials.json. La muestra de código usa este archivo JSON para autenticarse en Google Workspace y obtener credenciales de usuario. Para obtener instrucciones, consulta Crea credenciales de ID de cliente de OAuth.

  3. Para borrar la suscripción, ejecuta lo siguiente en tu terminal:

    python3 delete_subscription.py
La API de Google Workspace Events muestra una operación de larga duración que contiene la instancia del recurso Subscription.