Crea una suscripción a Google Workspace

Apps Script

• Para usar los comandos de Google Cloud CLI en esta guía, haz lo siguiente:
  1. Instala Google Cloud CLI.
  2. Para inicializar la CLI de gcloud, ejecuta el siguiente código:

    gcloud init
    

• Un proyecto de Google Cloud con la facturación habilitada Para las suscripciones a Chat, también debes habilitar la API de Chat en tu proyecto de Cloud y configurar los campos Nombre de la app, URL del avatar y Descripción. Para obtener más información, consulta Cómo compilar una app de Google Chat.
• Requiere autenticación del usuario con la pantalla de consentimiento de OAuth configurada para la app. Cuando configures la pantalla de consentimiento, debes especificar un alcance para admitir cada tipo de evento de la suscripción. Para configurar la pantalla de consentimiento y, luego, identificar los permisos necesarios, consulta Cómo elegir los permisos.

• 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
    

• Para usar los comandos de Google Cloud CLI en esta guía, haz lo siguiente:
  1. Instala Google Cloud CLI.
  2. Para inicializar la CLI de gcloud, ejecuta el siguiente código:

    gcloud init
    

• Un proyecto de Google Cloud con la facturación habilitada Para las suscripciones a Chat, también debes habilitar la API de Chat en tu proyecto de Cloud y configurar los campos Nombre de la app, URL del avatar y Descripción. Para obtener más información, consulta Cómo compilar una app de Google Chat.
• Requiere autenticación del usuario con la pantalla de consentimiento de OAuth configurada para la app. Cuando configures la pantalla de consentimiento, debes especificar un alcance para admitir cada tipo de evento de la suscripción. Para configurar la pantalla de consentimiento y, luego, identificar los permisos necesarios, consulta Cómo elegir los permisos.

Consola de Google Cloud

En la consola de Google Cloud, abre el proyecto de Google Cloud de tu app y habilita las APIs de Google Workspace Events y Pub/Sub:

Habilitar las API

gcloud

1. En tu directorio de trabajo, accede a tu Cuenta de Google:

   gcloud auth login

2. Establece tu proyecto en el proyecto de Cloud de tu app:

   gcloud config set project PROJECT_ID

   Reemplaza PROJECT_ID por el ID del proyecto del proyecto de Cloud de tu app.

3. Habilita la API de eventos de Google Workspace y la API de Google Cloud Pub/Sub:

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com

Consola de Google Cloud

1. En la consola de Google Cloud, ve a la página Pub/Sub:

   Ir a Pub/Sub de Google Cloud

   Asegúrate de que el proyecto de Cloud de tu app esté seleccionado.

2. Haz clic en add_box Crear tema y haz lo siguiente:

   1. Ingresa un nombre para tu tema, como workspace-events-topic.
   2. Deja seleccionada la opción Agregar una suscripción predeterminada. Pub/Sub le asigna un nombre similar al de tu tema a esta suscripción predeterminada, como workspace-events-topic-sub.
   3. Opcional: Actualiza o configura propiedades adicionales para tu tema.

3. Haz clic en Crear. El nombre completo del tema tiene el formato projects/PROJECT_ID/topics/TOPIC_ID. Usarás este nombre completo en un paso posterior.

4. Otorga acceso para publicar mensajes de Pub/Sub en tu tema:

   1. En la página de tu tema, ve al panel lateral y abre la pestaña Permisos.
   2. Haz clic en Agregar principal.
   3. En el campo Agregar principales, agrega la cuenta de servicio de la aplicación de Google Workspace que envía eventos a tu suscripción:
      1. Para eventos de chat, usa chat-api-push@system.gserviceaccount.com.
      2. Para eventos de Meet, meet-api-event-push@system.gserviceaccount.com.
   4. En el menú Asignar roles, selecciona Pub/Sub Publisher.
   5. Haz clic en Guardar. Es posible que los permisos de tu tema tarden unos minutos en actualizarse.

gcloud

1. En tu proyecto de Cloud, ejecuta el siguiente comando para crear un tema:

   gcloud pubsub topics create TOPIC_ID

   Reemplaza TOPIC_ID por un ID único para tu tema, como workspace-events-topic.

   En el resultado, se muestra el nombre completo del tema, con el formato projects/PROJECT_ID/topics/TOPIC_ID. Anota el nombre y asegúrate de que el valor de PROJECT_ID sea el ID del proyecto de Cloud de tu app. Usarás el nombre del tema en el siguiente paso y para crear la suscripción a Google Workspace más adelante.

2. Otorga acceso para publicar mensajes en tu tema:

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'

   Reemplaza lo siguiente:

   • TOPIC_NAME: Es el nombre completo del tema, que es el resultado del paso anterior. Tiene el formato projects/PROJECT_ID/topics/TOPIC_ID.

   • GOOGLE_WORKSPACE_APPLICATION: Es la aplicación de Google Workspace que debe entregar eventos a tu suscripción:

     • Para recibir eventos de Chat, usa chat-api-push@system.gserviceaccount.com.
     • Para recibir eventos de Meet, usa meet-api-event-push@system.gserviceaccount.com.

   Es posible que los permisos de tu tema tarden unos minutos en actualizarse.

3. Crea una suscripción a Pub/Sub para el tema.

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

   Reemplaza lo siguiente:

   • SUBSCRIPTION_NAME: Es un nombre para tu suscripción, como workspace-events-subscription.
   • TOPIC_NAME: Es el nombre del tema que creaste en el paso anterior.

Apps Script

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

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   Reemplaza lo siguiente:

   • TARGET_RESOURCE: Es el recurso de Google Workspace al que te suscribes, con el formato de su nombre completo. Por ejemplo, para suscribirte a un espacio de Google Chat con el ID AAAABBBB, usa //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Uno o más tipos de eventos a los que deseas suscribirte en el recurso de destino. Dale formato como un array de cadenas, como 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Es el nombre completo del tema de Pub/Sub que creaste en tu proyecto de Cloud. Tiene el formato projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Es un valor booleano que especifica si la suscripción incluye datos de recursos en la carga útil:

     • True: Incluye todos los datos de recursos. Para limitar los campos que se incluyen, agrega el campo fieldMask y especifica al menos un campo para el recurso modificado. Solo las suscripciones a recursos de chat admiten la inclusión de datos de recursos.
     • False: Excluye los datos de recursos.

2. Para crear la suscripción a Google Workspace, ejecuta la función createSubscription en tu proyecto de Apps Script.

Python

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

   """Create 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()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   Reemplaza lo siguiente:

   • SCOPES: Uno o más alcances de OAuth que admitan cada tipo de evento para la suscripción. Tiene el formato de un array de cadenas. Para enumerar varios permisos, sepáralos con comas. Por ejemplo, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: Es el recurso de Google Workspace al que te suscribes, con el formato de su nombre completo. Por ejemplo, para suscribirte a un espacio de Google Chat con el ID AAAABBBB, usa //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Uno o más tipos de eventos a los que deseas suscribirte en el recurso de destino. Dale formato como un array de cadenas, como 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Es el nombre completo del tema de Pub/Sub que creaste en tu proyecto de Cloud. Tiene el formato projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Es un valor booleano que especifica si la suscripción incluye datos de recursos en la carga útil:

     • True: Incluye todos los datos de recursos. Para limitar los campos que se incluyen, agrega el campo fieldMask y especifica al menos un campo para el recurso modificado. Solo las suscripciones a recursos de chat admiten la inclusión de datos de recursos.
     • False: Excluye los datos de recursos.

2. Para crear la suscripción a Google Workspace, ejecuta lo siguiente en la terminal:

   python3 create_subscription.py

Consola de Google Cloud

1. Activa uno o más tipos de eventos en el recurso de destino de tu suscripción a Google Workspace. Por ejemplo, si te suscribiste a mensajes nuevos en un espacio de Chat, publica un mensaje en el espacio.

2. En la consola de Google Cloud, ve a la página Pub/Sub:

   Ir a Pub/Sub

   Asegúrate de que el proyecto de Cloud de tu app esté seleccionado.

3. En el menú Pub/Sub, haz clic en Suscripciones.

4. En la tabla, busca la suscripción de Pub/Sub de tu tema y haz clic en su nombre.

5. Haz clic en la pestaña Mensajes.

6. Haz clic en Extraer. Un evento puede tardar unos minutos en generar un mensaje de Pub/Sub.

gcloud

1. Activa uno o más tipos de eventos en el recurso de destino de tu suscripción a Google Workspace. Por ejemplo, si te suscribiste a mensajes nuevos en un espacio de Chat, publica un mensaje en el espacio.

2. Ejecuta el siguiente comando:

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack

   Reemplaza lo siguiente:

   • PUBSUB_SUBSCRIPTION_NAME: Es el nombre completo de tu suscripción a Pub/Sub, con el formato projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: Es la cantidad máxima de mensajes de Pub/Sub que deseas extraer.

   Un evento puede tardar unos minutos en generar un mensaje de Pub/Sub.