Creare un abbonamento a Google Workspace

Apps Script

• Per utilizzare i comandi di Google Cloud CLI in questa guida:
  1. Installa Google Cloud CLI.
  2. Per inizializzare l'interfaccia a riga di comando gcloud, esegui questo codice:

    gcloud init
    

• Una risorsa di destinazione per la sottoscrizione:
  • Per iscriverti a uno spazio di Google Chat, uno spazio di Chat di cui l'utente autenticato è membro. L'utente deve essere membro dello spazio tramite il proprio Account Google Workspace o Google (gli utenti che sono membri di uno spazio tramite un gruppo Google non sono supportati).
  • Per abbonarti a uno spazio per le riunioni di Google Meet, uno spazio per riunioni in cui l'utente autenticato è il proprietario. Per creare uno spazio, nella documentazione di Google Meet, vedi Lavorare con gli spazi per le riunioni.
  • Per abbonarti a un utente di Google Meet, l'ID user per l'API Cloud Identity
• Un progetto Google Cloud con fatturazione abilitata. Per gli abbonamenti a Chat, devi anche abilitare l'API Chat nel tuo progetto Cloud e configurare i campi Nome app, URL avatar e Descrizione. Per maggiori dettagli, consulta Creare un'app Google Chat.
• Richiede l'autenticazione degli utenti con la schermata per il consenso OAuth configurata per l'app. Quando configuri la schermata per il consenso, devi specificare un ambito per supportare ogni tipo di evento per l'abbonamento. Per configurare la schermata per il consenso e identificare gli ambiti richiesti, consulta Scegli gli ambiti.

• Un progetto Apps Script:
  • Utilizza il tuo progetto Google Cloud anziché quello predefinito creato automaticamente da Apps Script.
  • Per tutti gli ambiti che hai aggiunto per configurare la schermata per il consenso OAuth, devi aggiungere anche gli ambiti al file appsscript.json nel tuo progetto Apps Script. Ad esempio:

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

  • Abilita il servizio avanzato Google Workspace Events.

Python

• Python 3.6 o versioni successive
• Lo strumento di gestione dei pacchetti pip
• Le librerie client di Google più recenti per Python. Per installarli o aggiornarli, esegui questo comando nell'interfaccia a riga di comando:

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

• Per utilizzare i comandi di Google Cloud CLI in questa guida:
  1. Installa Google Cloud CLI.
  2. Per inizializzare l'interfaccia a riga di comando gcloud, esegui questo codice:

    gcloud init
    

• Una risorsa di destinazione per la sottoscrizione:
  • Per iscriverti a uno spazio di Google Chat, uno spazio di Chat di cui l'utente autenticato è membro. L'utente deve essere membro dello spazio tramite il proprio Account Google Workspace o Google (gli utenti che sono membri di uno spazio tramite un gruppo Google non sono supportati).
  • Per abbonarti a uno spazio per le riunioni di Google Meet, uno spazio per riunioni in cui l'utente autenticato è il proprietario. Per creare uno spazio, nella documentazione di Google Meet, vedi Lavorare con gli spazi per le riunioni.
  • Per abbonarti a un utente di Google Meet, l'ID user per l'API Cloud Identity
• Un progetto Google Cloud con fatturazione abilitata. Per gli abbonamenti a Chat, devi anche abilitare l'API Chat nel tuo progetto Cloud e configurare i campi Nome app, URL avatar e Descrizione. Per maggiori dettagli, consulta Creare un'app Google Chat.
• Richiede l'autenticazione degli utenti con la schermata per il consenso OAuth configurata per l'app. Quando configuri la schermata per il consenso, devi specificare un ambito per supportare ogni tipo di evento per l'abbonamento. Per configurare la schermata per il consenso e identificare gli ambiti richiesti, consulta Scegli gli ambiti.

Console Google Cloud

Nella console Google Cloud, apri il progetto Google Cloud per la tua app e abilita l'API Google Workspace Eventi e l'API Pub/Sub:

Abilita le API

gcloud

1. Nella directory di lavoro, accedi al tuo Account Google:

   gcloud auth login
   

2. Imposta il progetto sul progetto Cloud per la tua app:

   gcloud config set project PROJECT_ID
   

   Sostituisci PROJECT_ID con l' ID progetto del progetto Cloud per la tua app.

3. Abilita l'API Google Workspace Eventi e l'API Google Cloud Pub/Sub:

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

Console Google Cloud

1. Nella console Google Cloud, vai alla pagina Pub/Sub:

   Vai a Google Cloud Pub/Sub

   Assicurati che il progetto Cloud per la tua app sia selezionato.

2. Fai clic su add_box Crea argomento e segui questi passaggi:

   1. Inserisci un nome per l'argomento, ad esempio workspace-events-topic.
   2. Lascia selezionata l'opzione Aggiungi un abbonamento predefinito. Pub/Sub assegna a questa sottoscrizione predefinita un nome simile al tuo argomento, ad esempio workspace-events-topic-sub.
   3. (Facoltativo) Aggiorna o configura proprietà aggiuntive per l'argomento.

3. Fai clic su Crea. Il nome completo dell'argomento è nel formato projects/PROJECT_ID/topics/TOPIC_ID. Potrai utilizzare questo nome completo in un passaggio successivo.

4. Concedi l'accesso per pubblicare messaggi Pub/Sub nel tuo argomento:

   1. Nella pagina dell'argomento, vai al riquadro laterale e apri la scheda Autorizzazioni.
   2. Fai clic su Aggiungi entità.
   3. Nel campo Aggiungi entità, aggiungi l'account di servizio per l'applicazione Google Workspace che fornisce eventi al tuo abbonamento:
      1. Per gli eventi di Chat, chat-api-push@system.gserviceaccount.com.
      2. Per gli eventi di Meet, meet-api-event-push@system.gserviceaccount.com.
   4. Nel menu Assegna ruoli, seleziona Pub/Sub Publisher.
   5. Fai clic su Salva. L'aggiornamento delle autorizzazioni per l'argomento può richiedere alcuni minuti.

gcloud

1. Nel tuo progetto Cloud, crea un argomento eseguendo questo comando:

   gcloud pubsub topics create TOPIC_ID
   

   Sostituisci TOPIC_ID con un ID univoco per l'argomento, ad esempio workspace-events-topic.

   L'output mostra il nome completo dell'argomento, nel formato projects/PROJECT_ID/topics/TOPIC_ID. Prendi nota del nome e assicurati che il valore di PROJECT_ID sia l'ID progetto Cloud della tua app. Utilizzerai il nome dell'argomento nel passaggio seguente e potrai creare l'abbonamento a Google Workspace in un secondo momento.

2. Concedi l'accesso per pubblicare messaggi nell'argomento:

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

   Sostituisci quanto segue:

   • TOPIC_NAME: il nome completo dell'argomento, ovvero l'output del passaggio precedente. Formattata come projects/PROJECT_ID/topics/TOPIC_ID.

   • GOOGLE_WORKSPACE_APPLICATION: l'applicazione Google Workspace che deve fornire eventi al tuo abbonamento:

     • Per ricevere eventi da Chat, utilizza chat-api-push@system.gserviceaccount.com.
     • Per ricevere eventi da Meet, utilizza meet-api-event-push@system.gserviceaccount.com.

   L'aggiornamento delle autorizzazioni per l'argomento può richiedere qualche minuto.

3. Crea una sottoscrizione Pub/Sub per l'argomento:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   Sostituisci quanto segue:

   • SUBSCRIPTION_NAME: il nome dell'abbonamento, ad esempio workspace-events-subscription.
   • TOPIC_NAME: il nome dell'argomento creato nel passaggio precedente.

Apps Script

1. Nel tuo progetto Apps Script, crea un nuovo file script denominato createSubscription e aggiungi il seguente codice:

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

   Sostituisci quanto segue:

   • TARGET_RESOURCE: la risorsa Google Workspace a cui ti stai abbonando, formattata come nome completo della risorsa. Ad esempio, per iscriverti a uno spazio di Google Chat con l'ID spazio AAAABBBB, utilizza //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: uno o più tipi di eventi a cui vuoi iscriverti nella risorsa di destinazione. Formatta come un array di stringhe, come 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: il nome completo dell'argomento Pub/Sub che hai creato nel progetto Cloud. Formattata come projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: un valore booleano che specifica se l'abbonamento include dati delle risorse nel payload:

     • True: include tutti i dati delle risorse. Per limitare i campi inclusi, aggiungi il campo fieldMask e specifica almeno un campo per la risorsa modificata. Sono supportate solo gli abbonamenti alle risorse di Chat, inclusi i dati delle risorse.
     • False: esclude i dati delle risorse.

2. Per creare l'abbonamento a Google Workspace, esegui la funzione createSubscription nel progetto Apps Script.

Python

1. Nella directory di lavoro, crea un file denominato create_subscription.py e aggiungi il seguente codice:

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

   Sostituisci quanto segue:

   • SCOPES: uno o più ambiti OAuth che supportano ogni tipo di evento per l'abbonamento. Formattato come array di stringhe. Per elencare più ambiti, separali con virgole. Ad esempio: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: la risorsa Google Workspace a cui ti stai abbonando, formattata come nome completo della risorsa. Ad esempio, per iscriverti a uno spazio di Google Chat con l'ID spazio AAAABBBB, utilizza //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: uno o più tipi di eventi a cui vuoi iscriverti nella risorsa di destinazione. Formatta come un array di stringhe, come 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: il nome completo dell'argomento Pub/Sub che hai creato nel progetto Cloud. Formattata come projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: un valore booleano che specifica se l'abbonamento include dati delle risorse nel payload:

     • True: include tutti i dati delle risorse. Per limitare i campi inclusi, aggiungi il campo fieldMask e specifica almeno un campo per la risorsa modificata. Sono supportate solo gli abbonamenti alle risorse di Chat, inclusi i dati delle risorse.
     • False: esclude i dati delle risorse.

2. Per creare l'abbonamento a Google Workspace, esegui questo comando nel tuo terminale:

   python3 create_subscription.py
   

Console Google Cloud

1. Attiva uno o più tipi di eventi nella risorsa di destinazione del tuo abbonamento a Google Workspace. Ad esempio, se hai effettuato l'iscrizione ai nuovi messaggi in uno spazio di Chat, pubblica un messaggio nello spazio.

2. Nella console Google Cloud, vai alla pagina Pub/Sub:

   Vai a Pub/Sub

   Assicurati che il progetto Cloud per la tua app sia selezionato.

3. Nel menu Pub/Sub, fai clic su Abbonamenti.

4. Nella tabella, trova la sottoscrizione Pub/Sub per l'argomento e fai clic sul nome della sottoscrizione.

5. Fai clic sulla scheda Messaggi.

6. Fai clic su Pull. Possono essere necessari alcuni minuti prima che un evento generi un messaggio Pub/Sub.

gcloud

1. Attiva uno o più tipi di eventi nella risorsa di destinazione del tuo abbonamento a Google Workspace. Ad esempio, se hai effettuato l'iscrizione ai nuovi messaggi in uno spazio di Chat, pubblica un messaggio nello spazio.

2. Esegui questo comando:

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

   Sostituisci quanto segue:

   • PUBSUB_SUBSCRIPTION_NAME: il nome completo della sottoscrizione Pub/Sub, nel formato projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: numero massimo di messaggi Pub/Sub di cui eseguire il pull.

   Possono essere necessari alcuni minuti prima che un evento generi un messaggio Pub/Sub.