Créer un abonnement Google Workspace

Apps Script

• Pour utiliser les commandes Google Cloud CLI de ce guide :
  1. Installez Google Cloud CLI.
  2. Pour initialiser la CLI gcloud, exécutez le code suivant:

    gcloud init
    

• Un projet Google Cloud avec la facturation activée. Pour les abonnements à Chat, vous devez également activer l'API Chat dans votre projet Cloud et configurer les champs Nom de l'application, URL de l'avatar et Description. Pour en savoir plus, consultez Créer une application Google Chat.
• Nécessite l'authentification de l'utilisateur avec l'écran de consentement OAuth configuré pour l'application. Lorsque vous configurez l'écran de consentement, vous devez spécifier un champ d'application pour prendre en charge chaque type d'événement de l'abonnement. Pour configurer l'écran de consentement et identifier les autorisations requises, consultez Choisir des autorisations.

• Un projet Apps Script:
  • Utilisez votre projet Google Cloud au lieu de celui créé automatiquement par Apps Script.
  • Pour tous les champs d'application que vous avez ajoutés pour configurer l'écran de consentement OAuth, vous devez également les ajouter au fichier appsscript.json de votre projet Apps Script. Exemple :

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

  • Activez le service avancé Google Workspace Events.

Python

• Python 3.6 ou version ultérieure
• Outil de gestion des paquets pip
• Dernières bibliothèques clientes Google pour Python. Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande:

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

• Pour utiliser les commandes Google Cloud CLI de ce guide :
  1. Installez Google Cloud CLI.
  2. Pour initialiser la CLI gcloud, exécutez le code suivant:

    gcloud init
    

• Un projet Google Cloud avec la facturation activée. Pour les abonnements à Chat, vous devez également activer l'API Chat dans votre projet Cloud et configurer les champs Nom de l'application, URL de l'avatar et Description. Pour en savoir plus, consultez Créer une application Google Chat.
• Nécessite l'authentification de l'utilisateur avec l'écran de consentement OAuth configuré pour l'application. Lorsque vous configurez l'écran de consentement, vous devez spécifier un champ d'application pour prendre en charge chaque type d'événement de l'abonnement. Pour configurer l'écran de consentement et identifier les autorisations requises, consultez Choisir des autorisations.

Console Google Cloud

Dans la console Google Cloud, ouvrez le projet Google Cloud de votre application et activez les API Google Workspace Events et Pub/Sub:

Activer les API

gcloud

1. Dans votre répertoire de travail, connectez-vous à votre compte Google:

   gcloud auth login

2. Définissez votre projet sur le projet Cloud de votre application:

   gcloud config set project PROJECT_ID

   Remplacez PROJECT_ID par l'ID de projet du projet Cloud de votre application.

3. Activez l'API Google Workspace Events et l'API Google Cloud Pub/Sub:

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

Console Google Cloud

1. Dans la console Google Cloud, accédez à la page Pub/Sub:

   Accéder à Google Cloud Pub/Sub

   Assurez-vous que le projet Cloud de votre application est sélectionné.

2. Cliquez sur add_box Créer un sujet, puis effectuez les opérations suivantes:

   1. Saisissez un nom pour votre sujet, par exemple workspace-events-topic.
   2. Laissez l'option Ajouter un abonnement par défaut sélectionnée. Pub/Sub nomme cet abonnement par défaut de manière similaire au nom de votre sujet, par exemple workspace-events-topic-sub.
   3. Facultatif: mettez à jour ou configurez des propriétés supplémentaires pour votre sujet.

3. Cliquez sur Créer. Le nom complet de votre sujet est au format projects/PROJECT_ID/topics/TOPIC_ID. Vous utiliserez ce nom complet lors d'une prochaine étape.

4. Accordez l'accès pour publier des messages Pub/Sub dans votre sujet:

   1. Sur la page de votre sujet, accédez au panneau latéral et ouvrez l'onglet Autorisations.
   2. Cliquez sur Ajouter un compte principal.
   3. Dans le champ Ajouter des comptes principaux, ajoutez le compte de service de l'application Google Workspace qui envoie des événements à votre abonnement :
      1. Pour les événements Chat, chat-api-push@system.gserviceaccount.com.
      2. Pour les événements Meet, meet-api-event-push@system.gserviceaccount.com.
   4. Dans le menu Attribuer des rôles, sélectionnez Pub/Sub Publisher.
   5. Cliquez sur Enregistrer. La mise à jour des autorisations de votre sujet peut prendre quelques minutes.

gcloud

1. Dans votre projet Cloud, créez un sujet en exécutant la commande suivante:

   gcloud pubsub topics create TOPIC_ID

   Remplacez TOPIC_ID par un ID unique pour votre sujet, par exemple workspace-events-topic.

   Le résultat affiche le nom complet du sujet, au format projects/PROJECT_ID/topics/TOPIC_ID. Notez le nom et assurez-vous que la valeur de PROJECT_ID correspond à l'ID de projet Cloud de votre application. Vous utiliserez le nom du sujet à l'étape suivante et pour créer l'abonnement Google Workspace plus tard.

2. Accordez l'accès pour publier des messages dans votre sujet:

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

   Remplacez les éléments suivants :

   • TOPIC_NAME: nom complet du sujet, qui correspond à la sortie de l'étape précédente. Formaté comme projects/PROJECT_ID/topics/TOPIC_ID.

   • GOOGLE_WORKSPACE_APPLICATION: application Google Workspace qui doit envoyer des événements à votre abonnement:

     • Pour recevoir des événements de Chat, utilisez chat-api-push@system.gserviceaccount.com.
     • Pour recevoir des événements de Meet, utilisez meet-api-event-push@system.gserviceaccount.com.

   La mise à jour des autorisations de votre sujet peut prendre quelques minutes.

3. Créez un abonnement Pub/Sub pour le sujet :

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

   Remplacez les éléments suivants :

   • SUBSCRIPTION_NAME: nom de votre abonnement, par exemple workspace-events-subscription.
   • TOPIC_NAME: nom du sujet que vous avez créé à l'étape précédente.

Apps Script

1. Dans votre projet Apps Script, créez un fichier de script nommé createSubscription et ajoutez le code suivant:

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

   Remplacez les éléments suivants :

   • TARGET_RESOURCE: ressource Google Workspace à laquelle vous vous abonnez, au format de son nom complet. Par exemple, pour vous abonner à un espace Google Chat dont l'ID est AAAABBBB, utilisez //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: un ou plusieurs types d'événements auxquels vous souhaitez vous abonner dans la ressource cible. Mettez en forme sous la forme d'un tableau de chaînes, par exemple 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: nom complet du sujet Pub/Sub que vous avez créé dans votre projet Cloud. Formaté comme projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: valeur booléenne indiquant si l'abonnement inclut des données de ressources dans la charge utile:

     • True: inclut toutes les données de ressources. Pour limiter les champs inclus, ajoutez le champ fieldMask et spécifiez au moins un champ pour la ressource modifiée. Seuls les abonnements aux ressources Chat sont compatibles avec les données de ressources.
     • False: exclut les données de ressources.

2. Pour créer l'abonnement Google Workspace, exécutez la fonction createSubscription dans votre projet Apps Script.

Python

1. Dans votre répertoire de travail, créez un fichier nommé create_subscription.py et ajoutez le code suivant:

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

   Remplacez les éléments suivants :

   • SCOPES: un ou plusieurs champs d'application OAuth compatibles avec chaque type d'événement pour l'abonnement. Formaté sous la forme d'un tableau de chaînes. Pour lister plusieurs champs d'application, séparez-les par des virgules. Par exemple, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: ressource Google Workspace à laquelle vous vous abonnez, au format de son nom complet. Par exemple, pour vous abonner à un espace Google Chat dont l'ID est AAAABBBB, utilisez //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: un ou plusieurs types d'événements auxquels vous souhaitez vous abonner dans la ressource cible. Mettez en forme sous la forme d'un tableau de chaînes, par exemple 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: nom complet du sujet Pub/Sub que vous avez créé dans votre projet Cloud. Formaté comme projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: valeur booléenne indiquant si l'abonnement inclut des données de ressources dans la charge utile:

     • True: inclut toutes les données de ressources. Pour limiter les champs inclus, ajoutez le champ fieldMask et spécifiez au moins un champ pour la ressource modifiée. Seuls les abonnements aux ressources Chat sont compatibles avec les données de ressources.
     • False: exclut les données de ressources.

2. Pour créer l'abonnement Google Workspace, exécutez la commande suivante dans votre terminal:

   python3 create_subscription.py

Console Google Cloud

1. Déclenchez un ou plusieurs types d'événements dans la ressource cible de votre abonnement Google Workspace. Par exemple, si vous vous êtes abonné aux nouveaux messages dans un espace Chat, publiez un message dans cet espace.

2. Dans la console Google Cloud, accédez à la page Pub/Sub:

   Accéder à Pub/Sub

   Assurez-vous que le projet Cloud de votre application est sélectionné.

3. Dans le menu Pub/Sub, cliquez sur Abonnements.

4. Dans le tableau, recherchez l'abonnement Pub/Sub de votre sujet, puis cliquez sur son nom.

5. Cliquez sur l'onglet Messages.

6. Cliquez sur Extraire. La génération d'un message Pub/Sub par un événement peut prendre jusqu'à quelques minutes.

gcloud

1. Déclenchez un ou plusieurs types d'événements dans la ressource cible de votre abonnement Google Workspace. Par exemple, si vous vous êtes abonné aux nouveaux messages dans un espace Chat, publiez un message dans cet espace.

2. Exécutez la commande suivante :

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

   Remplacez les éléments suivants :

   • PUBSUB_SUBSCRIPTION_NAME: nom complet de votre abonnement Pub/Sub, au format projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: nombre maximal de messages Pub/Sub que vous souhaitez extraire.

   La génération d'un message Pub/Sub par un événement peut prendre jusqu'à quelques minutes.