Apps Script

• A Google Workspace subscription. To create one,seeCreate 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 theappsscript.json file in your Apps Script project. For example, if you specified thechat.messages scope, then add the following:

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

  • Enable theGoogle Workspace Events advanced service.

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

  • For user authentication, requires a scope that supports at least one of the event types for the subscription. To identify a scope, seeScopes by event type.Note: To run the code sample in this guide, you must use the sameOAuth client ID credentials that you used to create the subscription.
  • For app authentication, requires thechat.bot scope (Google Chat apps only).

Python

• Python 3.6 or greater
• Thepip 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,seeCreate a subscription.

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

  • For user authentication, requires a scope that supports at least one of the event types for the subscription. To identify a scope, seeScopes by event type.Note: To run the code sample in this guide, you must use the sameOAuth client ID credentials that you used to create the subscription.
  • For app authentication, requires thechat.bot scope (Google Chat apps only).

Apps Script

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

   functionlistSubscriptions(){// Filter for event type (required).consteventType='EVENT_TYPE';// Filter for target resource (optional).consttargetResource='TARGET_RESOURCE';constfilter=`event_types:"${eventType}" AND target_resource="${targetResource}"`// Call the Workspace Events API using the advanced service.constresponse=WorkspaceEvents.Subscriptions.list({filter});console.log(response);}

   Replace the following:

   • EVENT_TYPE: Anevent typeformatted according to the CloudEvents specification. For example,to filter for subscriptions that receive events about new membershipsto a Google Chat space,google.workspace.chat.message.v1.created.
   • TARGET_RESOURCE: Atarget resource,formatted as its full resource name. For example, to filter bysubscriptions for a Google Chat space, use//chat.googleapis.com/spaces/SPACE_ID wherespaces/SPACE_ID represents thenamefield for theSpace resource.

2. To list subscriptions, run the functionlistSubscriptions inyour Apps Script project.

Python

1. In your working directory, create a file namedlist_subscriptions.pyand add the following code:

   """List subscriptions."""fromgoogle_auth_oauthlib.flowimportInstalledAppFlowfromgoogleapiclient.discoveryimportbuild# Specify required scopes.SCOPES=['SCOPE']# 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,)# Filter for event type (required).EVENT_TYPE='EVENT_TYPE'# Filter for target resource (optional).TARGET_RESOURCE='TARGET_RESOURCE'FILTER=f'event_types:"{EVENT_TYPE}" AND target_resource="{TARGET_RESOURCE}"'response=service.subscriptions().list(filter=FILTER).execute()print(response)

   Replace the following:

   • SCOPE: An OAuth scope thatsupports at leastone event type from the subscription. For example, if your subscription receives eventsan updated Chat space,https://www.googleapis.com/auth/chat.spaces.readonly.
   • EVENT_TYPE: Anevent typeformatted according to the CloudEvents specification. For example,to filter for subscriptions that receive events about new membershipsto a Google Chat space,google.workspace.chat.message.v1.created.
   • TARGET_RESOURCE: Atarget resource,formatted as its full resource name. For example, to filter bysubscriptions for a Google Chat space, use//chat.googleapis.com/spaces/SPACE_ID wherespaces/SPACE_ID represents thenamefield for theSpace resource.

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

3. To list subscriptions, run the following in your terminal:

   python3list_subscriptions.py