Supprimer un abonnement Google Workspace

Cette page explique comment supprimer un abonnement Google Workspace à l'aide de la subscriptions.delete() méthode.

Lorsque vous supprimez un abonnement, votre application ne reçoit plus d'événements. Si un abonnement expire, l'API Google Workspace Events le supprime automatiquement.

Prérequis

Apps Script

  • Un projet Apps Script :
    • Utilisez votre projet Google Cloud au lieu de celui créé automatiquement par Apps Script.
    • Pour tous les champs d'application que vous avez ajoutés pour configurer l'écran de consentement OAuth, vous devez également ajouter les champs d'application au fichier appsscript.json de votre projet Apps Script. Par exemple, si vous avez spécifié le champ d'application chat.messages, ajoutez les éléments suivants : 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages"
]
    • Activez le Google Workspace Events service avancé.

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion des packages pip
  • Les dernières bibliothèques clientes Google pour Python. Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande : 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

Supprimer un abonnement autorisé par un utilisateur

L'exemple de code suivant supprime une Subscription ressource à l'aide de l'authentification des utilisateurs.

Pour supprimer un abonnement :

Apps Script

  1. Dans votre projet Apps Script, créez un fichier de script nommé deleteSubscription et ajoutez le code suivant :

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

    Remplacez les éléments suivants :

    • SUBSCRIPTION_ID : ID de l'abonnement. Pour obtenir l'ID, vous pouvez utiliser l'une des méthodes suivantes :
      • La valeur du uid champ.
      • L'ID du nom de la ressource représenté dans le name champ. Par exemple, si le nom de la ressource est subscriptions/subscription-123, utilisez subscription-123.

  2. Pour supprimer l'abonnement, exécutez la fonction deleteSubscription dans votre projet Apps Script.

Python

  1. Dans votre répertoire de travail, créez un fichier nommé delete_subscription.py et ajoutez le code suivant :

    """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)

    Remplacez les éléments suivants :

    • SCOPE : champ d'application OAuth qui accepte au moins un type d'événement de l'abonnement. Par exemple, si votre abonnement reçoit des événements dans un espace Chat mis à jour, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID : ID de l'abonnement. Pour obtenir l'ID, vous pouvez utiliser l'une des méthodes suivantes :
      • La valeur du uid champ.
      • L'ID du nom de la ressource représenté dans le name champ. Par exemple, si le nom de la ressource est subscriptions/subscription-123, utilisez subscription-123.

  2. Dans votre répertoire de travail, assurez-vous d'avoir stocké vos identifiants d'ID client OAuth et nommé le fichier credentials.json. L'exemple de code utilise ce fichier JSON pour s'authentifier auprès de Google Workspace et obtenir les identifiants de l'utilisateur. Pour obtenir des instructions, consultez Créer des identifiants d'ID client OAuth credentials.

  3. Pour supprimer l'abonnement, exécutez la commande suivante dans votre terminal :

    python3 delete_subscription.py
L'API Google Workspace Events renvoie une opération de longue durée qui contient l'instance de la Subscription ressource.