Crea una suscripción a Google Workspace

Apps Script

• Para usar los comandos de Google Cloud CLI en esta guía, sigue estos pasos:
  1. Instala Google Cloud CLI.
  2. Para inicializa la CLI de gcloud y ejecuta el siguiente código:

    gcloud init
    

• Un proyecto de Google Cloud con la facturación habilitada. Para las suscripciones a Chat, debes habilitar la API de Chat en tu proyecto de Cloud y configura el Nombre de la app, la URL del avatar y la Descripción . Para obtener más información, consulta Compila una app de Google Chat.
• Requiere la autenticación del usuario con la pantalla de consentimiento de OAuth configurada para la aplicación. Cuando configuras la pantalla de consentimiento, debes especificar un alcance para admitir cada tipo de evento de la suscripción. Para configurar el consentimiento pantalla e identificar los alcances requeridos, consulta Elige los permisos.

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

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

  • Habilitar el servicio avanzado Google Workspace Events.

Python

• Python 3.6 o superior
• 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 tu 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, sigue estos pasos:
  1. Instala Google Cloud CLI.
  2. Para inicializa la CLI de gcloud y ejecuta el siguiente código:

    gcloud init
    

• Un proyecto de Google Cloud con la facturación habilitada. Para las suscripciones a Chat, debes habilitar la API de Chat en tu proyecto de Cloud y configura el Nombre de la app, la URL del avatar y la Descripción . Para obtener más información, consulta Compila una app de Google Chat.
• Requiere la autenticación del usuario con la pantalla de consentimiento de OAuth configurada para la aplicación. Cuando configuras la pantalla de consentimiento, debes especificar un alcance para admitir cada tipo de evento de la suscripción. Para configurar el consentimiento pantalla e identificar los alcances requeridos, consulta Elige los permisos.

Consola de Google Cloud

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

Habilitar las API

gcloud

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

   gcloud auth login
   

2. Configura el proyecto de Cloud para tu app:

   gcloud config set project PROJECT_ID
   

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

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

   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 de Pub/Sub:

   Ir a Google Cloud Pub/Sub

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

2. Haz clic en add_box Crear tema y, luego, 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 lo nombra suscripción predeterminada similar al nombre de tu tema, como workspace-events-topic-sub
   3. Opcional: Actualiza o configura propiedades adicionales de tu tema.

3. Haz clic en Crear. El nombre completo de tu tema tiene el siguiente formato: projects/PROJECT_ID/topics/TOPIC_ID Lo usarás 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 el Permisos.
   2. Haz clic en Agregar principal.
   3. En el campo Agregar principales, agrega la cuenta de servicio para la de Google Workspace que entrega eventos a tu suscripción:
      1. Para los eventos de Chat, chat-api-push@system.gserviceaccount.com
      2. Para los 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. La actualización de los permisos puede tardar unos minutos. de tu tema.

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 como workspace-events-topic.

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

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: El nombre completo del tema, que es el el resultado del paso anterior. Con formato de projects/PROJECT_ID/topics/TOPIC_ID

   • GOOGLE_WORKSPACE_APPLICATION: El 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

   La actualización de los permisos de tu tema puede tardar unos minutos.

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 la 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. con el nombre 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. a los que te suscribes, con el formato de su nombre completo de recurso. Para Por ejemplo, para suscribirte a un espacio de Google Chat con el ID de espacio AAAABBBB, usa //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Uno o más tipos de eventos a los que quieres suscribirte en el recurso de destino. Asignar formato array de cadenas, como 'google.workspace.chat.message.v1.created'
   • TOPIC_NAME: Es el nombre completo del tema de Pub/Sub que que creaste en tu proyecto de Cloud. Con formato de projects/PROJECT_ID/topics/TOPIC_ID

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

     • True: Incluye todos los datos de recursos. Para limitar qué campos incluido, agrega fieldMask y especifica, al menos, un campo para el recurso modificado. Solo las suscripciones a los recursos de Chat, como los datos de los 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 el 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 permisos de OAuth que admiten 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. a los que te suscribes, con el formato de su nombre completo de recurso. Para Por ejemplo, para suscribirte a un espacio de Google Chat con el ID de espacio AAAABBBB, usa //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Uno o más tipos de eventos a los que quieres suscribirte en el recurso de destino. Asignar formato array de cadenas, como 'google.workspace.chat.message.v1.created'
   • TOPIC_NAME: Es el nombre completo del tema de Pub/Sub que que creaste en tu proyecto de Cloud. Con formato de projects/PROJECT_ID/topics/TOPIC_ID

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

     • True: Incluye todos los datos de recursos. Para limitar qué campos incluido, agrega fieldMask y especifica, al menos, un campo para el recurso modificado. Solo las suscripciones a los recursos de Chat, como los datos de los recursos.
     • False: Excluye los datos de recursos.

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

   python3 create_subscription.py
   

Consola de Google Cloud

1. Activa uno o más tipos de eventos en el recurso objetivo de tu suscripción a Google Workspace. Por ejemplo, si te suscribiste a las nuevas mensajes en un espacio de Chat y publicar un mensaje en él.

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

   Ir a Pub/Sub

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

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

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

5. Haz clic en la pestaña Mensajes.

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

gcloud

1. Activa uno o más tipos de eventos en el recurso objetivo de tu suscripción a Google Workspace. Por ejemplo, si te suscribiste a las nuevas mensajes en un espacio de Chat y publicar un mensaje en él.

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 de projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID
   • MESSAGE_COUNT: La cantidad máxima de mensajes de Pub/Sub que deseas extraer.

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