Modifier ou renouveler un abonnement Google Workspace

Cette page explique comment renouveler un abonnement Google Workspace à l'aide de la méthode subscriptions.update(). Cette méthode vous permet de mettre à jour la date d'expiration d'un abonnement, y compris de le renouveler pour le délai d'expiration maximal possible.

Apps Script ;

  • Un projet Apps Script:
    • Utilisez votre projet Google Cloud au lieu de celui par défaut créé automatiquement par Apps Script.
    • Tous les champs d'application que vous avez ajoutés pour configurer l'écran de consentement OAuth doivent également être inclus dans le fichier appsscript.json de votre projet Apps Script. Exemple : 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • Activez le service avancé Google Workspace Events.

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

Renouveler un abonnement Google Workspace

Dans cette section, vous allez utiliser la méthode subscriptions.update() de l'API Google Workspace Events pour renouveler un abonnement jusqu'à son délai d'expiration maximal. Pour spécifier le délai d'expiration maximal, remplacez le champ ttl de la ressource Subscription par 0.

Le délai d'expiration maximal dépend des données de ressources incluses dans la charge utile de l'événement. Pour en savoir plus sur les délais d'expiration, consultez la section Données d'événement pour les événements Google Workspace.

Pour renouveler un abonnement Google Workspace:

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: ID de l'abonnement. Pour obtenir l'ID, vous pouvez utiliser l'une des méthodes suivantes :
      • Valeur du champ uid.
      • ID du nom de ressource représenté dans le champ name. 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('client_secrets.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. Mise en forme sous la forme d'un tableau de chaînes. Pour répertorier plusieurs champs d'application, séparez-les par une virgule. Exemple :'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
    • SUBSCRIPTION_ID: ID de l'abonnement. Pour obtenir l'ID, vous pouvez utiliser l'une des méthodes suivantes :
      • Valeur du champ uid.
      • ID du nom de ressource représenté dans le champ name. Par exemple, si le nom de la ressource est subscriptions/subscription-123, utilisez subscription-123.

  2. Dans votre répertoire de travail, vérifiez que vous avez stocké les identifiants de votre ID client OAuth et que vous avez nommé le fichier client_secrets.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.

  3. Pour mettre à jour l'abonnement Google Workspace, exécutez la commande suivante dans votre terminal:

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

Pour en savoir plus sur la ressource Subscription mise à jour, utilisez la méthode operations.get() et spécifiez la ressource Operation renvoyée par votre requête subscriptions.update(). Sinon, si vous spécifiez une ressource Operation issue d'une version précédente de l'abonnement, la réponse est vide.