Supprimer un abonnement Google Workspace

Cette page explique comment supprimer un abonnement Google Workspace à l'aide du subscriptions.delete() .

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

Prérequis

Apps Script

  • Un projet Apps Script:
    • Utilisez votre projet Google Cloud au lieu du projet par défaut 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 les champs d'application au fichier appsscript.json de votre projet Apps Script. Exemple :
    • "oauthScopes": [
        "https://www.googleapis.com/auth/chat.messages.readonly"
      ]
          
    • Activer le service avancé Google Workspace Events.

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion de 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
      
  • Vous devez disposer d'un abonnement Google Workspace. Pour en créer un, consultez la section Créer un abonnement.

  • Nécessite une authentification:

    • Pour l'authentification des utilisateurs, nécessite qui accepte au moins un des types d'événements de l'abonnement. Pour identifier une portée, consultez Champs d'application par type d'événement. <ph type="x-smartling-placeholder">
    • Pour l'authentification des applications, nécessite le champ d'application chat.bot (applications Google Chat uniquement).

Supprimer un abonnement autorisé par un utilisateur

L'exemple de code suivant supprime Ressource Subscription à l'aide de l'authentification utilisateur.

Pour supprimer un abonnement:

Apps Script

  1. Créez un fichier de script dans votre projet Apps 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: <ph type="x-smartling-placeholder">
        </ph>
      • La valeur du paramètre <ph type="x-smartling-placeholder"></ph> uid.
      • L'ID du nom de la ressource représenté dans le <ph type="x-smartling-placeholder"></ph> name. 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('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)
    

    Remplacez les éléments suivants :

    • SCOPE: champ d'application OAuth acceptant au moins un type d'événement à partir de l'abonnement. Par exemple, si votre abonnement reçoit des événements un espace Chat modifié, 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: <ph type="x-smartling-placeholder">
        </ph>
      • La valeur du paramètre <ph type="x-smartling-placeholder"></ph> uid.
      • L'ID du nom de la ressource représenté dans le <ph type="x-smartling-placeholder"></ph> name. Par exemple, si le nom de la ressource est subscriptions/subscription-123, utilisez subscription-123.
  2. Vérifiez que vous avez bien stocké votre ID client OAuth dans votre répertoire de travail. identifiants et nommé le fichier client_secrets.json. L'exemple de code utilise ce fichier pour s'authentifier avec Google Workspace et obtenir les identifiants utilisateur. Pour obtenir des instructions, consultez la page Créer un ID client OAuth identifiants.

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

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