Enumerar suscripciones a Google Workspace

Apps Script

• Una suscripción a Google Workspace. Para crear una, consulta Cómo crear una suscripción.

• Requiere la autenticación del usuario con uno o más alcances que admitan todos los tipos de eventos de la suscripción.

• Un proyecto de Apps Script:
  • Usa tu proyecto de Google Cloud en lugar del predeterminado que crea Apps Script automáticamente.
  • Para los permisos que agregaste para configurar la pantalla de consentimiento de OAuth, también debes agregar los permisos al archivo appsscript.json en tu proyecto de Apps Script. Por ejemplo:

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

  • Habilita el servicio avanzado Google Workspace Events.

Python

• Python 3.6 o una versión posterior
• La herramienta de administración de paquetes pip
• Las bibliotecas cliente de Google más recientes para Python Para instalarlos o actualizarlos, ejecuta el siguiente comando en la interfaz de línea de comandos:

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

• Una suscripción a Google Workspace. Para crear una, consulta Cómo crear una suscripción.

• Requiere autenticación:

  • Para la autenticación del usuario, requiere un permiso que admita al menos uno de los tipos de eventos de la suscripción. Para identificar un alcance, consulta Alcances por tipo de evento.
  • Para la autenticación de apps, requiere el permiso chat.bot (solo para apps de Google Chat).

Apps Script

1. En tu proyecto de Apps Script, crea un nuevo archivo de secuencia de comandos llamado listSubscriptions y agrega el siguiente código:

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

   Reemplaza lo siguiente:

   • EVENT_TYPE: Un tipo de evento con el formato según la especificación de CloudEvents. Por ejemplo, para filtrar suscripciones que reciben eventos sobre membresías nuevas a un espacio de Google Chat, google.workspace.chat.message.v1.created.
   • TARGET_RESOURCE: Es un recurso de destino, con el formato de su nombre completo. Por ejemplo, para filtrar por suscripciones de un espacio de Google Chat, usa //chat.googleapis.com/spaces/SPACE_ID, en el que spaces/SPACE_ID representa el campo name del recurso Space.

2. Para enumerar las suscripciones, ejecuta la función listSubscriptions en tu proyecto de Apps Script.

Python

1. En tu directorio de trabajo, crea un archivo llamado list_subscriptions.py y agrega el siguiente código:

   """List subscriptions."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = ['SCOPE']
   
   # 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,
   )
   
   # 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)
   

   Reemplaza lo siguiente:

   • SCOPE: Un permiso de OAuth que admite al menos un tipo de evento de la suscripción. Por ejemplo, si tu suscripción recibe eventos de un espacio de Chat actualizado, https://www.googleapis.com/auth/chat.spaces.readonly.
   • EVENT_TYPE: Un tipo de evento con el formato según la especificación de CloudEvents. Por ejemplo, para filtrar suscripciones que reciben eventos sobre membresías nuevas a un espacio de Google Chat, google.workspace.chat.message.v1.created.
   • TARGET_RESOURCE: Es un recurso de destino, con el formato de su nombre completo. Por ejemplo, para filtrar por suscripciones de un espacio de Google Chat, usa //chat.googleapis.com/spaces/SPACE_ID, en el que spaces/SPACE_ID representa el campo name del recurso Space.

2. En tu directorio de trabajo, asegúrate de haber almacenado las credenciales de tu ID de cliente de OAuth y de haber nombrado el archivo client_secrets.json. La muestra de código usa este archivo JSON para autenticarse con Google Workspace y obtener credenciales del usuario. Para obtener instrucciones, consulta Cómo crear credenciales de ID de cliente de OAuth.

3. Para obtener una lista de las suscripciones, ejecuta el siguiente comando en la terminal:

   python3 list_subscriptions.py