Modifier ou renouveler un abonnement Google Workspace

Cette page explique comment renouveler un abonnement Google Workspace à l'aide de la méthode subscriptions.update(). Vous pouvez utiliser cette méthode pour mettre à jour la date d'expiration d'un abonnement, y compris pour renouveler l'abonnement pour la date d'expiration maximale possible, ou pour mettre à jour la liste des types d'événements à recevoir concernant la ressource cible.

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 les ajouter au 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
  • Outil de gestion des paquets pip
  • 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'à sa date d'expiration maximale. Pour spécifier la date/heure d'expiration maximale, mettez à jour le champ ttl de la ressource Subscription sur 0.

La durée d'expiration maximale 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 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 la 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 pour l'abonnement. Formaté sous la forme d'un 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: 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 la 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, assurez-vous d'avoir stocké vos identifiants d'ID client OAuth et d'avoir 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 utilisateur. Pour obtenir des instructions, consultez Créer des identifiants 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 contenant l'instance de la ressource Subscription.

Pour obtenir des informations 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 à partir d'une version précédente de l'abonnement, la réponse est vide.