Cómo borrar una suscripción a Google Workspace
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
En esta página, se explica cómo borrar una suscripción a Google Workspace con el método subscriptions.delete()
.
Cuando borras una suscripción, tu app ya no recibe ningún evento. Si vence una suscripción, la API de Google Workspace Events la borra automáticamente.
Requisitos previos
Apps Script
- Un proyecto de Apps Script:
Python
- Python 3.6 o una versión posterior
- La herramienta de administración de paquetes pip
- Las bibliotecas cliente de Google más recientes para Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Una suscripción a Google Workspace Para crear una, consulta Cómo crear una suscripción.
Requiere autenticación:
- Para la autenticación del usuario, se requiere un alcance que admita al menos uno de los tipos de eventos de la suscripción. Para identificar un alcance, consulta Alcances por tipo de evento.
- Para la autenticación de la app, se requiere el alcance
chat.bot
(solo para apps de Google Chat).
Borra una suscripción autorizada por un usuario
En la siguiente muestra de código, se borra un recurso Subscription
con la autenticación del usuario.
Para borrar una suscripción, sigue estos pasos:
Apps Script
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
: ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
- El valor del campo
uid
.
- ID del nombre del recurso representado en el campo
name
. Por ejemplo, si el nombre del recurso es subscriptions/subscription-123
, usa subscription-123
.
Para borrar la suscripción, ejecuta la función deleteSubscription
en tu proyecto de Apps Script.
Python
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
: ID de la suscripción. Para obtener el ID, puedes usar cualquiera de las siguientes opciones:
- El valor del campo
uid
.
- ID del nombre del recurso representado en el campo
name
. Por ejemplo, si el nombre del recurso es subscriptions/subscription-123
, usa subscription-123
.
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.
Para borrar la suscripción, ejecuta el siguiente comando en la terminal:
python3 delete_subscription.py
La API de Google Workspace Events devuelve una
operación de larga duración que contiene la instancia del recurso
Subscription
.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-21 (UTC)
[null,null,["Última actualización: 2025-08-21 (UTC)"],[[["\u003cp\u003eThis page provides instructions for deleting a Google Workspace subscription using the \u003ccode\u003esubscriptions.delete()\u003c/code\u003e method, which stops event delivery to your app.\u003c/p\u003e\n"],["\u003cp\u003eDeleting a subscription is permanent and requires user authentication with appropriate scopes.\u003c/p\u003e\n"],["\u003cp\u003eCode samples are provided in Apps Script and Python, demonstrating how to delete a subscription authorized by a user.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully execute the code samples, you need a Google Workspace subscription, necessary authentication credentials, and a correctly configured development environment.\u003c/p\u003e\n"],["\u003cp\u003eOnce the subscription is deleted, the Google Workspace Events API returns a long-running operation confirming the removal.\u003c/p\u003e\n"]]],["To delete a Google Workspace subscription, use the `subscriptions.delete()` method. In Apps Script, create a `deleteSubscription` function, specify the subscription ID, and run the function. In Python, create a `delete_subscription.py` file, authenticate with Google Workspace using OAuth credentials, then specify the subscription ID and execute the `delete()` method. Ensure you have the required scopes and the same OAuth client ID used to create the subscription. After deletion, the app stops receiving events.\n"],null,["# Delete a Google Workspace subscription\n\nThis page explains how to delete a Google Workspace subscription using the\n[`subscriptions.delete()`](/workspace/events/reference/rest/v1/subscriptions/delete)\nmethod.\n\nWhen you delete a subscription, your app no longer receives any events. If a\nsubscription expires, the Google Workspace Events API deletes it automatically.\n\nPrerequisites\n-------------\n\n### Apps Script\n\n- \u003cbr /\u003e\n\n A Google Workspace subscription. To create one, see [Create a subscription](/workspace/events/guides/create-subscription).\n\n \u003cbr /\u003e\n\n- Requires user authentication with one or more\n [scopes that support all event types for\n the subscription](/workspace/events/guides/auth#scopes-event-type).\n\n | **Note:** To run the code sample in this guide, you must use the same [OAuth client\n | ID credentials](/workspace/events/guides/create-subscription#create-oauth) that you used to create the subscription.\n\n\u003c!-- --\u003e\n\n- An Apps Script project:\n - Use your Google Cloud project instead of the default one created automatically by Apps Script.\n - For all scopes that you added to configure the OAuth consent screen, you must also add the scopes to the `appsscript.json` file in your Apps Script project. For example, if you specified the `chat.messages` scope, then add the following: \n\n ```console\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/chat.messages\"\n ]\n \n ```\n - [Enable](/apps-script/guides/services/advanced#enable_advanced_services) the `Google Workspace Events` advanced service.\n\n### Python\n\n- Python 3.6 or greater\n- The [pip](https://pypi.org/project/pip/) package management tool\n- The latest Google client libraries for Python. To install or update them, run the following command in your command-line interface: \n\n ```console\n pip3 install --upgrade google-api-python-client google-auth-oauthlib\n \n ```\n\n\u003c!-- --\u003e\n\n- \u003cbr /\u003e\n\n A Google Workspace subscription. To create one, see [Create a subscription](/workspace/events/guides/create-subscription).\n\n \u003cbr /\u003e\n\n- Requires [authentication](/workspace/events/guides/auth):\n\n - For user authentication, requires a scope that supports at least one of the event types for the subscription. To identify a scope, see [Scopes by event type](/workspace/events/guides/auth#scopes-event-type). **Note:** To run the code sample in this guide, you must use the same [OAuth\n | client ID credentials](/workspace/events/guides/create-subscription#create-oauth) that you used to create the subscription.\n - For app authentication, requires the `chat.bot` scope (Google Chat apps only).\n\nDelete a subscription authorized by a user\n------------------------------------------\n\nThe following code sample deletes a\n[`Subscription`](/workspace/events/reference/rest/v1/subscriptions) resource\nusing user authentication.\n\nTo delete a subscription: \n\n### Apps Script\n\n1. In your Apps Script project, create a new script file\n named `deleteSubscription` and add the following code:\n\n function deleteSubscription() {\n // The name of the subscription to delete.\n const name = 'subscriptions/\u003cvar translate=\"no\"\u003eSUBSCRIPTION_ID\u003c/var\u003e';\n\n // Call the Workspace Events API using the advanced service.\n const response = WorkspaceEvents.Subscriptions.remove(name);\n console.log(response);\n }\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eSUBSCRIPTION_ID\u003c/var\u003e: The ID of the subscription. To get the ID, you can use any of the following:\n - The value of the [`uid`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.uid) field.\n - The ID of the resource name represented in the [`name`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.name) field. For example, if the resource name is `subscriptions/subscription-123`, use `subscription-123`.\n2. To delete the subscription, run the function `deleteSubscription` in your\n Apps Script project.\n\n### Python\n\n1. In your working directory, create a file named `delete_subscription.py`\n and add the following code:\n\n \"\"\"Delete subscription.\"\"\"\n\n from google_auth_oauthlib.flow import InstalledAppFlow\n from googleapiclient.discovery import build\n\n # Specify required scopes.\n SCOPES = ['\u003cvar translate=\"no\"\u003eSCOPE\u003c/var\u003e']\n\n # Authenticate with Google Workspace and get user authentication.\n flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)\n CREDENTIALS = flow.run_local_server()\n\n # Call the Workspace Events API using the service endpoint.\n service = build(\n 'workspaceevents',\n 'v1',\n credentials=CREDENTIALS,\n )\n\n NAME = 'subscriptions/\u003cvar translate=\"no\"\u003eSUBSCRIPTION_ID\u003c/var\u003e'\n response = service.subscriptions().delete(name=NAME).execute()\n print(response)\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eSCOPE\u003c/var\u003e: An OAuth scope that [supports at least\n one event type from the subscription](/workspace/events/guides/auth#scopes-event-type). For example, if your subscription receives events an updated Chat space, `https://www.googleapis.com/auth/chat.spaces.readonly`.\n - \u003cvar translate=\"no\"\u003eSUBSCRIPTION_ID\u003c/var\u003e: The ID of the subscription. To get the ID, you can use any of the following:\n - The value of the [`uid`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.uid) field.\n - The ID of the resource name represented in the [`name`](/workspace/events/reference/rest/v1/subscriptions#Subscription.FIELDS.name) field. For example, if the resource name is `subscriptions/subscription-123`, use `subscription-123`.\n2. In your working directory, make sure you've stored your OAuth client ID\n credentials and named the file `credentials.json`. The code sample uses this JSON\n file to authenticate with Google Workspace and get user credentials. For instructions,\n see [Create OAuth client ID\n credentials](/workspace/events/guides/create-subscription#create-oauth).\n\n3. To delete the subscription, run the following in your terminal:\n\n python3 delete_subscription.py\n\nThe Google Workspace Events API returns a [long-running operation](/workspace/events/reference/rest/v1/operations) that contains the instance of the `Subscription` resource.\n\nRelated topics\n--------------\n\n- [Create a subscription](/workspace/events/guides/create-subscription)\n- [Get a subscription](/workspace/events/guides/get-subscription)\n- [List subscriptions](/workspace/events/guides/list-subscriptions)\n- [Update or renew a subscription](/workspace/events/guides/update-subscription)\n- [Resolve errors and reactivate a subscription](/workspace/events/guides/reactivate-subscription)"]]