Créer un abonnement Google Workspace

Apps Script

• Pour utiliser les commandes de la Google Cloud CLI dans ce guide: <ph type="x-smartling-placeholder">
  </ph>
  1. Installez Google Cloud CLI.
  2. À <ph type="x-smartling-placeholder"></ph> initialisez la CLI gcloud, exécutez le code suivant:

    gcloud init
    

• Un projet Google Cloud avec la facturation activée. Pour souscrire un abonnement à Chat, vous devez activer également l'API Chat dans votre projet Cloud configurez le nom de l'application, l'URL de l'avatar et la description ; . Pour en savoir plus, consultez Créer une application Google Chat
• Nécessite l'authentification des utilisateurs 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 sont compatibles avec chaque type d'événement de l'abonnement. Pour configurer le consentement et identifier les habilitations requises, consultez Choisissez des portées.

• Un projet Apps Script:
  • Utilisez votre projet Google Cloud au lieu du projet par défaut 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 ajouter les les champs d'application au fichier appsscript.json de votre projet Apps Script. Exemple :

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

  • Activer le service avancé Google Workspace Events.

Python

• Python 3.6 ou version ultérieure
• L'outil de gestion de packages pip
• Les 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 de la Google Cloud CLI dans ce guide: <ph type="x-smartling-placeholder">
  </ph>
  1. Installez Google Cloud CLI.
  2. À <ph type="x-smartling-placeholder"></ph> initialisez la CLI gcloud, exécutez le code suivant:

    gcloud init
    

• Un projet Google Cloud avec la facturation activée. Pour souscrire un abonnement à Chat, vous devez activer également l'API Chat dans votre projet Cloud configurez le nom de l'application, l'URL de l'avatar et la description ; . Pour en savoir plus, consultez Créer une application Google Chat
• Nécessite l'authentification des utilisateurs 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 sont compatibles avec tous les types d'événements de l'abonnement. Pour configurer le consentement et identifier les niveaux d'accès requis, consultez Choisissez des niveaux d'accès.

console Google Cloud

Dans la console Google Cloud, ouvrez le projet Google Cloud de votre application et activez le API Google Workspace Events et API 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 pour votre application:

   gcloud config set project PROJECT_ID
   

   Remplacez PROJECT_ID par le ID du projet Cloud pour votre application.

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

   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. effectuer les opérations suivantes:

   1. Saisissez un nom pour votre thème, par exemple workspace-events-topic.
   2. Laissez l'option Ajouter un abonnement par défaut sélectionnée. Pub/Sub nomme ceci abonnement par défaut 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 se présente sous la forme suivante : 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 Onglet Autorisations.
   2. Cliquez sur Ajouter un compte principal.
   3. Dans le champ Ajouter des comptes principaux, ajoutez le compte de service pour l'application Google Workspace qui envoie des événements à vos abonnement: <ph type="x-smartling-placeholder">
      </ph>
      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 peut prendre quelques minutes pour votre sujet.

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 identifiant unique pour votre thème, tel que en tant que workspace-events-topic.

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

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 au du résultat de l'étape précédente. Format : projects/PROJECT_ID/topics/TOPIC_ID

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

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

   La mise à jour des autorisations pour 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. comme workspace-events-subscription.
   • TOPIC_NAME: nom du sujet que vous avez créé à l'étape précédente.

Apps Script

1. Créez un fichier de script dans votre projet Apps 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 auquel vous vous abonnez, sous la forme d'un nom de ressource complet. Pour Par exemple, pour s'abonner à un espace Google Chat avec l'ID de l'espace AAAABBBB, utilisez //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: un ou plusieurs types d'événement auquel vous souhaitez vous abonner dans la ressource cible. Appliquer le format tableau de chaînes tel que 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: nom complet du sujet Pub/Sub que vous avez créés dans votre projet Cloud. Format : projects/PROJECT_ID/topics/TOPIC_ID

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

     • True: inclut toutes les données de ressources. Pour limiter les champs inclus, ajoutez la fieldMask et spécifiez au moins un champ pour la ressource modifiée. Uniquement à des ressources Chat, y compris des 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. Mise en forme sous la forme d'un tableau de chaînes. Pour répertorier plusieurs champs d'application, séparez-les par une virgule. Exemple : 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: ressource Google Workspace auquel vous vous abonnez, sous la forme d'un nom de ressource complet. Pour Par exemple, pour s'abonner à un espace Google Chat avec l'ID de l'espace AAAABBBB, utilisez //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: un ou plusieurs types d'événement auquel vous souhaitez vous abonner dans la ressource cible. Appliquer le format tableau de chaînes tel que 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: nom complet du sujet Pub/Sub que vous avez créés dans votre projet Cloud. Format : projects/PROJECT_ID/topics/TOPIC_ID

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

     • True: inclut toutes les données de ressources. Pour limiter les champs inclus, ajoutez la fieldMask et spécifiez au moins un champ pour la ressource modifiée. Uniquement à des ressources Chat, y compris des 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é à de nouvelles messages d'un espace Chat, y publier un message.

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 associé à votre sujet, puis cliquez sur le nom de l'abonnement.

5. Cliquez sur l'onglet Messages.

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

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é à de nouvelles messages d'un espace Chat, y publier un message.

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: le nom complet de votre Abonnement Pub/Sub, au format suivant : projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID
   • MESSAGE_COUNT: nombre maximal de messages Pub/Sub que vous souhaitez extraire.

   La génération d'une adresse Pub/Sub pour un événement peut prendre quelques minutes .