Aggiornare o rinnovare un abbonamento a Google Workspace

In questa pagina viene spiegato come rinnovare un abbonamento a Google Workspace utilizzando il metodo subscriptions.update(). Puoi utilizzare questo metodo per aggiornare la data di scadenza di un abbonamento, incluso il rinnovo dell'abbonamento per la scadenza massima possibile.

Apps Script

  • Un progetto Apps Script:
    • Utilizza il tuo progetto Google Cloud anziché quello predefinito creato automaticamente da Apps Script.
    • Per tutti gli ambiti che hai aggiunto per configurare la schermata per il consenso OAuth, devi aggiungere anche gli ambiti al file appsscript.json nel tuo progetto Apps Script. Ad esempio: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • Abilita il servizio avanzato Google Workspace Events.

Python

  • Python 3.6 o versioni successive
  • Lo strumento di gestione dei pacchetti pip
  • Le librerie client di Google più recenti per Python. Per installarli o aggiornarli, esegui questo comando nell'interfaccia a riga di comando: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

Rinnovare un abbonamento a Google Workspace

In questa sezione utilizzerai il metodo subscriptions.update() dell'API Google Workspace Eventi per rinnovare un abbonamento fino alla scadenza massima. Per specificare la scadenza massima, aggiorna il campo ttl della risorsa Subscription a 0.

La scadenza massima dipende dai dati delle risorse inclusi nel payload dell'evento. Per scoprire di più sui tempi di scadenza, consulta Dati sugli eventi per gli eventi di Google Workspace.

Per rinnovare un abbonamento a Google Workspace:

Apps Script

  1. Nel tuo progetto Apps Script, crea un nuovo file script denominato updateSubscription e aggiungi il seguente codice:

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

    Sostituisci quanto segue:

    • SUBSCRIPTION_ID: l'ID dell'abbonamento. Per ottenere l'ID, puoi utilizzare uno dei seguenti documenti:
      • Il valore del campo uid.
      • L'ID del nome della risorsa rappresentato nel campo name. Ad esempio, se il nome della risorsa è subscriptions/subscription-123, utilizza subscription-123.

  2. Per aggiornare l'abbonamento a Google Workspace, esegui la funzione updateSubscription nel progetto Apps Script.

Python

  1. Nella directory di lavoro, crea un file denominato update_subscription.py e aggiungi il seguente codice:

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

    Sostituisci quanto segue:

    • SCOPES: uno o più ambiti OAuth che supportano ogni tipo di evento per l'abbonamento. Formattato come array di stringhe. Per elencare più ambiti, separali con virgole. Ad esempio: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
    • SUBSCRIPTION_ID: l'ID dell'abbonamento. Per ottenere l'ID, puoi utilizzare uno dei seguenti documenti:
      • Il valore del campo uid.
      • L'ID del nome della risorsa rappresentato nel campo name. Ad esempio, se il nome della risorsa è subscriptions/subscription-123, utilizza subscription-123.

  2. Nella directory di lavoro, assicurati di aver archiviato le credenziali dell'ID client OAuth e denominato client_secrets.json. L'esempio di codice utilizza questo file JSON per eseguire l'autenticazione con Google Workspace e ottenere le credenziali utente. Per le istruzioni, consulta la pagina Creare le credenziali dell'ID client OAuth.

  3. Per aggiornare l'abbonamento a Google Workspace, esegui questo comando nel terminale:

    python3 update_subscription.py
L'API Google Workspace Eventi restituisce un'operazione a lunga esecuzione che contiene l'istanza della risorsa Subscription.

Per ottenere dettagli sulla risorsa Subscription aggiornata, utilizza il metodo operations.get() e specifica la risorsa Operation restituita dalla richiesta subscriptions.update(). Altrimenti, se specifichi una risorsa Operation da una versione precedente dell'abbonamento, la risposta è vuota.