En esta página, se explica cómo borrar una suscripción a Google Workspace con la
subscriptions.delete()
.
Cuando borras una suscripción, la app ya no recibe ningún evento. Si un una suscripción, la API de Google Workspace Events la borra automáticamente.
Requisitos previos
Apps Script
- Una suscripción a Google Workspace Para crear una, consulta Cómo crear una suscripción.
Requiere la autenticación del usuario con uno o más que admiten todos los tipos de eventos la suscripción.
.
- Un proyecto de Apps Script:
- Usa tu proyecto de Google Cloud en lugar del predeterminado que crea automáticamente Apps Script
- En el caso de los permisos que agregaste para configurar la pantalla de consentimiento de OAuth, también debes agregar el
los permisos al archivo
appsscript.json
en tu proyecto de Apps Script. Por ejemplo:
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.readonly" ]
- Habilitar
el servicio avanzado
Google Workspace Events
.
Python
- Python 3.6 o superior
- 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 de usuarios, requiere un 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 apps, requiere el permiso
chat.bot
(solo para apps de Google Chat).
Borrar una suscripción autorizada por un usuario
En la siguiente muestra de código, se borra un
Subscription
recurso
con la autenticación de usuarios.
Para borrar una suscripción, haz lo siguiente:
Apps Script
En tu proyecto de Apps Script, crea un nuevo archivo de secuencia de comandos. con el nombre
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
campo
uid
. - El ID del nombre del recurso representado en el
campo
name
. Por ejemplo, si el nombre del recurso essubscriptions/subscription-123
, usasubscription-123
.
- El valor del
campo
Para borrar la suscripción, ejecuta la función
deleteSubscription
en tu Proyecto de Apps Script.
Python
En el 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('client_secrets.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
: Un alcance de OAuth que admite como mínimo un tipo de evento de la suscripción. Por ejemplo, si tu suscripción recibe eventos 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
campo
uid
. - El ID del nombre del recurso representado en el
campo
name
. Por ejemplo, si el nombre del recurso essubscriptions/subscription-123
, usasubscription-123
.
- El valor del
campo
En el directorio de trabajo, asegúrate de haber almacenado tu ID de cliente de OAuth. credenciales y nombraste al archivo
client_secrets.json
. La muestra de código usa este JSON para autenticarse con Google Workspace y obtener credenciales de usuario. Para obtener instrucciones, consulta Crea un ID de cliente de OAuth credenciales.Para borrar la suscripción, ejecuta lo siguiente en la terminal:
python3 delete_subscription.py
Subscription
.