Update or renew a Google Workspace subscription

Apps Script

• A Google Workspace subscription. To create one, see Create a subscription.

• An Apps Script project:
  • Use your Google Cloud project instead of the default one created automatically by Apps Script.
  • For all scopes that you added to configure the OAuth consent screen, you must also add the scopes to the appsscript.json file in your Apps Script project. For example, if you specified the chat.messages scope, then add the following:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages"
  ]
      

  • Enable the Google Workspace Events advanced service.

• Requires authentication and an appropriate authorization scope for each event type in the subscription:

  • For user authentication, requires one or more scopes that support at least one of the event types for the subscription. To identify a scope, see Scopes by event type.
  • For subscribing to a Chat event as a Chat app, requires app authentication with one-time administrator approval. Subscribing to a Chat event as a Chat app is available in Developer Preview.

Python

• Python 3.6 or greater
• The pip package management tool
• The latest Google client libraries for Python. To install or update them, run the following command in your command-line interface:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• A Google Workspace subscription. To create one, see Create a subscription.

• Requires authentication and an appropriate authorization scope for each event type in the subscription:

  • For user authentication, requires one or more scopes that support at least one of the event types for the subscription. To identify a scope, see Scopes by event type.
  • For subscribing to a Chat event as a Chat app, requires app authentication with one-time administrator approval. Subscribing to a Chat event as a Chat app is available in Developer Preview.

Apps Script

1. In your Apps Script project, create a new script file named updateSubscription and add the following code:

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

   Replace the following:

   • SUBSCRIPTION_ID: The ID of the subscription. To get the ID, you can use any of the following:
     • The value of the uid field.
     • The ID of the resource name represented in the name field. For example, if the resource name is subscriptions/subscription-123, use subscription-123.

2. To update the Google Workspace subscription, run the function updateSubscription in your Apps Script project.

Python

1. In your working directory, create a file named update_subscription.py and add the following code:

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

   Replace the following:

   • SCOPES: One or more OAuth scopes that support each event type for the subscription. Formatted as an array of strings. To list multiple scopes, separate by commas. For example, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • SUBSCRIPTION_ID: The ID of the subscription. To get the ID, you can use any of the following:
     • The value of the uid field.
     • The ID of the resource name represented in the name field. For example, if the resource name is subscriptions/subscription-123, use subscription-123.

2. In your working directory, make sure you've stored your OAuth client ID credentials and named the file credentials.json. The code sample uses this JSON file to authenticate with Google Workspace and get user credentials. For instructions, see Create OAuth client ID credentials.

3. To update the Google Workspace subscription, run the following in your 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,
      discoveryServiceUrl='https://workspaceevents.googleapis.com/$discovery/rest?version=v1beta&labels=DEVELOPER_PREVIEW&key=API_KEY',
  )

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