Modifier ou renouveler un abonnement Google Workspace

Apps Script

• Un abonnement Google Workspace. Pour en créer un, consultez Créer un abonnement.

• 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 d'autorisation 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é.

• Nécessite une authentification et un champ d'application d'autorisation approprié pour chaque type d'événement de l'abonnement :

  • Pour l'authentification des utilisateurs, nécessite un ou plusieurs champs d'application compatibles avec au moins l'un des types d'événements de l'abonnement. Pour identifier un champ d'application, consultez Champs d'application par type d'événement.
  • Pour s'abonner à un événement Chat en tant qu'application Chat, nécessite une authentification de l'application avec une approbation unique de l'administrateur.

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
    

• Un abonnement Google Workspace. Pour en créer un, consultez Créer un abonnement.

• Nécessite une authentification et un champ d'application d'autorisation approprié pour chaque type d'événement de l'abonnement :

  • Pour l'authentification des utilisateurs, nécessite un ou plusieurs champs d'application compatibles avec au moins l'un des types d'événements de l'abonnement. Pour identifier un champ d'application, consultez Champs d'application par type d'événement.
  • Pour s'abonner à un événement Chat en tant qu'application Chat, nécessite une authentification de l'application avec une approbation unique de l'administrateur.

Apps Script

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

   function updateSubscription() {
     // The name of the subscription to update.
     const name = 'subscriptions/SUBSCRIPTION_ID';
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.patch({
       ttl: '0s',
     }, name);
     console.log(response);
   }
   

   Remplacez les éléments suivants :

   • SUBSCRIPTION_ID : l'ID de l'abonnement. Pour obtenir l'ID, vous pouvez utiliser l'un des éléments suivants :
     • 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 mettre à jour l'abonnement Google Workspace, exécutez la fonction updateSubscription dans votre projet Apps Script.

Python

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

   """Update subscription."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = [SCOPES]
   
   # 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,
     )
   
   BODY = {
       'ttl': {'seconds': 0},
   }
   NAME = 'subscriptions/SUBSCRIPTION_ID'
   response = (
       service.subscriptions()
       .patch(name=NAME, updateMask='ttl', body=BODY)
       .execute()
   )
   print(response)
   

   Remplacez les éléments suivants :

   • SCOPES : un ou plusieurs champs d'application OAuth compatibles avec chaque type d'événement de l'abonnement. Formaté sous forme de tableau de chaînes. Pour lister plusieurs champs d'application, séparez-les par des virgules. Par exemple, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • SUBSCRIPTION_ID : l'ID de l'abonnement. Pour obtenir l'ID, vous pouvez utiliser l'un des éléments suivants :
     • 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 mettre à jour l'abonnement Google Workspace, exécutez la commande suivante dans votre terminal :

   python3 update_subscription.py

Python

  """Update subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = [SCOPES]

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

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

  BODY = {
      'ttl': {'seconds': 0},
  }
  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = (
      service.subscriptions()
      .patch(name=NAME, updateMask='ttl', body=BODY)
      .execute()
  )
  print(response)