Créer un abonnement Google Workspace

Cette page explique comment utiliser l'API Google Workspace Events pour créer un abonnement à une ressource Google Workspace. Un abonnement Google Workspace permet à votre application de recevoir des informations sur les événements Google Workspace, qui représentent des modifications apportées à une ressource Google Workspace. Pour en savoir plus sur les ressources et les types d'événements compatibles avec l'API Google Workspace Events, consultez la présentation de l'API Google Workspace Events.

Cette page décrit les étapes à suivre pour créer un abonnement Google Workspace :

1. configurer votre environnement ;
2. Créez un sujet Google Cloud Pub/Sub et abonnez-vous-y. Vous utilisez ce sujet comme point de terminaison pour recevoir les événements Google Workspace.
3. Appelez la méthode create de l'API Google Workspace Events sur la ressource Subscription.
4. Testez votre abonnement Google Workspace pour vérifier que votre sujet Pub/Sub reçoit les événements auxquels vous vous êtes abonné.
5. Vous pouvez également configurer la manière dont les événements sont envoyés à un point de terminaison pour votre application, afin que celle-ci puisse traiter l'événement et, si nécessaire, prendre des mesures.

Remarque : Events for Google Drive API est proposé dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder de manière anticipée à certaines fonctionnalités. L'exemple de code listé ici ne fonctionnera pas avec ces événements.

Prérequis

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 pour l'abonnement. Pour configurer l'écran de consentement et identifier les habilitations requises, consultez Choisir des habilitations.

• 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 de packages 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 pour l'abonnement. Pour configurer l'écran de consentement et identifier les habilitations requises, consultez Choisir des habilitations.

Configurer votre environnement

La section suivante explique comment configurer votre environnement avant de créer un abonnement Google Workspace.

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

Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud. Vous pouvez activer une ou plusieurs API dans un même projet Google Cloud.

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 le projet sur le projet Cloud de votre application :

   gcloud config set project PROJECT_ID

   Remplacez PROJECT_ID par l'ID du projet pour le 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

Créer des identifiants client OAuth

Remarque : Vous pouvez ignorer cette étape si vous utilisez Apps Script.

Choisissez le type d'application pour obtenir des instructions spécifiques sur la création d'un ID client OAuth :

Remarque : Pour exécuter l'exemple de code de ce guide, sélectionnez Application de bureau et suivez les instructions.

Application Web

1. Dans la console Google Cloud, accédez à Menu  > > Clients.

   Accéder à "Clients"

2. Cliquez sur Créer un client.
3. Cliquez sur Type d'application > Application Web.
4. Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Ajoutez les URI autorisés associés à votre application :
   • Applications côté client (JavaScript) : sous Origines JavaScript autorisées, cliquez sur Ajouter un URI. Saisissez ensuite un URI à utiliser pour les requêtes du navigateur. Cela permet d'identifier les domaines à partir desquels votre application peut envoyer des requêtes d'API au serveur OAuth 2.0.
   • Applications côté serveur (Java, Python, etc.) : sous URI de redirection autorisés, cliquez sur Ajouter un URI. Saisissez ensuite un URI de point de terminaison vers lequel le serveur OAuth 2.0 peut envoyer des réponses.
6. Cliquez sur Créer.

   Les identifiants que vous venez de créer s'affichent sous ID client OAuth 2.0.

   Notez l'ID client. Les codes secrets du client ne sont pas utilisés pour les applications Web.

Android

1. Dans la console Google Cloud, accédez à Menu  > > Clients.

   Accéder à "Clients"

2. Cliquez sur Créer un client.
3. Cliquez sur Type d'application > Android.
4. Dans le champ "Nom", saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Dans le champ "Nom du package", saisissez le nom du package de votre fichier AndroidManifest.xml.
6. Dans le champ "Empreinte du certificat SHA-1", saisissez l'empreinte du certificat SHA-1 que vous avez générée.
7. Cliquez sur Créer.

   Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".

iOS

1. Dans la console Google Cloud, accédez à Menu  > > Clients.

   Accéder à "Clients"

2. Cliquez sur Créer un client.
3. Cliquez sur Type d'application > iOS.
4. Dans le champ "Nom", saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Dans le champ "Bundle ID" (ID du bundle), saisissez l'identifiant du bundle tel qu'il apparaît dans le fichier Info.plist de l'application.
6. (Facultatif) Si votre application apparaît dans l'App Store d'Apple, saisissez son ID App Store.
7. (Facultatif) Dans le champ "ID d'équipe", saisissez la chaîne unique de 10 caractères générée par Apple et attribuée à votre équipe.
8. Cliquez sur Créer.

   Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".

Application Chrome

1. Dans la console Google Cloud, accédez à Menu  > > Clients.

   Accéder à "Clients"

2. Cliquez sur Créer un client.
3. Cliquez sur Type d'application > Extension Chrome.
4. Dans le champ "Nom", saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Dans le champ "ID de l'article", saisissez la chaîne de 32 caractères unique de votre application. Vous trouverez cette valeur d'ID dans l'URL de votre application sur le Chrome Web Store et dans le tableau de bord du développeur Chrome Web Store.
6. Cliquez sur Créer.

   Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".

Application de bureau

1. Dans la console Google Cloud, accédez à Menu  > > Clients.

   Accéder à "Clients"

2. Cliquez sur Créer un client.
3. Cliquez sur Type d'application > Application de bureau.
4. Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Cliquez sur Créer.

   Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".

TV et périphériques à saisie limitée

1. Dans la console Google Cloud, accédez à Menu  > > Clients.

   Accéder à "Clients"

2. Cliquez sur Créer un client.
3. Cliquez sur Type d'application > TV et appareils à saisie limitée.
4. Dans le champ "Nom", saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Cliquez sur Créer.

   Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".

Plate-forme Windows universelle (UWP)

1. Dans la console Google Cloud, accédez à Menu  > > Clients.

   Accéder à "Clients"

2. Cliquez sur Créer un client.
3. Cliquez sur Type d'application > Plate-forme Windows universelle (UWP).
4. Dans le champ "Nom", saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Dans le champ "ID du Store", saisissez l'ID Microsoft Store unique de votre application (12 caractères). Vous trouverez cet ID dans l'URL Microsoft Store de votre application et dans le Centre des partenaires.
6. Cliquez sur Créer.

   Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".

Télécharger le fichier JSON du code secret du client

Remarque : Vous pouvez ignorer cette étape si vous utilisez Apps Script.

Le fichier du code secret du client est une représentation JSON des identifiants de l'ID client OAuth auxquels votre application peut faire référence lorsqu'elle fournit des identifiants.

1. Dans la console Google Cloud, accédez à Menu  > API et services > Identifiants.

   Accéder à "Identifiants"

2. Sous ID client OAuth 2.0, cliquez sur l'ID client que vous avez créé.

3. Cliquez sur Télécharger au format JSON.

4. Enregistrez le fichier sous le nom credentials.json.

Créer un sujet Pub/Sub et s'y abonner

Dans cette section, vous allez créer un sujet Pub/Sub et un abonnement à ce sujet. Votre sujet Pub/Sub sert de point de terminaison de notification où votre abonnement Google Workspace reçoit les événements.

Pour en savoir plus sur la création et la gestion des sujets Pub/Sub, consultez la documentation Pub/Sub.

Remarque : L'API Google Workspace Events utilise des clés de tri pour que votre application reçoive les messages dans l'ordre dans lequel ils sont publiés. Nous vous recommandons d'éviter d'utiliser la politique de stockage des messages. Les événements publiés dans des sujets avec de telles règles sont susceptibles d'échouer, car les régions de la règle peuvent ne pas correspondre à la source de l'événement.

Pour créer un sujet Pub/Sub et vous y abonner :

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 Créer un sujet, puis procédez comme suit :

   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 la même manière que votre sujet, par exemple workspace-events-topic-sub.
   3. Facultatif : Mettez à jour ou configurez des propriétés supplémentaires pour votre thème.

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'autorisation de 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 pour l'application Google Workspace qui fournit des événements à votre abonnement :
      1. Pour les événements Chat, [e-mail].
      2. Version Preview développeur : pour les événements Drive, [e-mail].
      3. Pour les événements Meet, [e-mail].
   4. Dans le menu Attribuer des rôles, sélectionnez Pub/Sub Publisher.
   5. Cliquez sur Enregistrer. La mise à jour des autorisations pour votre thème 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 ultérieurement.

2. Accordez l'accès à la publication de 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 résultat de l'étape précédente. Le fichier est au format projects/PROJECT_ID/topics/TOPIC_ID.

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

     • Pour recevoir des événements de Chat, utilisez [e-mail].
     • Version Preview développeur : pour recevoir des événements de Drive, utilisez [e-mail].
     • Pour recevoir des événements de Meet, utilisez [e-mail].

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

S'abonner à une ressource Google Workspace

Dans cette section, vous vous abonnez à la ressource Google Workspace dont vous souhaitez surveiller les événements.

Choisir et identifier la ressource cible

Dans un abonnement Google Workspace, la ressource cible est la ressource Google Workspace dont vous surveillez les événements. La ressource cible est représentée dans le champ targetResource de l'abonnement, au format du nom complet de la ressource. Par exemple, pour un abonnement qui surveille un espace Google Chat (spaces/AAAABBBBBBB), la valeur de targetResource est //chat.googleapis.com/spaces/AAAABBBBBBB.

Remarque : La durée d'expiration maximale de vos abonnements dépend de la présence ou non de données de ressources dans la charge utile de l'événement. Pour en savoir plus sur les délais d'expiration, consultez Données d'événement pour les événements Google Workspace.

Identifier une ressource cible pour Chat

Ressource cible	Format	Limites
Espace	//chat.googleapis.com/spaces/SPACE où SPACE correspond à l'ID dans le nom de ressource de la ressource space de l'API Chat. Vous pouvez obtenir l'ID à partir de l'URL de l'espace ou à l'aide de la méthode spaces.list().	L'utilisateur Chat qui autorise l'abonnement doit être membre de l'espace avec son compte Google Workspace ou Google.
Tous les espaces d'un utilisateur	//chat.googleapis.com/spaces/-	L'abonnement ne reçoit que les événements des espaces dont l'utilisateur est membre avec son compte Google Workspace ou Google.
Utilisateur	//cloudidentity.googleapis.com/users/USER où USER correspond à l'ID dans le nom de ressource de la ressource user de l'API Chat. Pour en savoir plus, consultez Identifier et spécifier les utilisateurs Google Chat.	L'abonnement ne reçoit que les événements concernant l'utilisateur qui a autorisé l'abonnement. Un utilisateur ne peut pas autoriser un abonnement au nom d'autres utilisateurs.

Identifier une ressource cible pour Drive

Preview développeur : disponible dans le programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à certaines fonctionnalités.

Ressource cible	Format	Limites (le cas échéant)
Fichier	//drive.googleapis.com/files/FILE où FILE est l'ID dans le nom de ressource de la ressource files de l'API Drive. Vous pouvez obtenir l'ID à partir de l'URL du fichier ou en utilisant la méthode files.list.	L'utilisateur qui autorise l'abonnement doit disposer d'une autorisation sur le fichier dans l'abonnement par rapport à l'événement d'abonnement.
Drive partagé	//drive.googleapis.com/drives/DRIVE où DRIVE est l'ID dans le nom de ressource de la ressource drives de l'API Drive. Vous pouvez obtenir l'ID à partir de l'URL du lecteur ou à l'aide de la méthode drives.list.	L'abonnement ne reçoit que les événements concernant les éléments du Drive partagé dont l'utilisateur est membre avec son compte Google Workspace ou son compte Google.

Identifier une ressource cible pour Meet

Ressource cible	Format	Limites (le cas échéant)
Espace de réunion	//meet.googleapis.com/spaces/SPACE où SPACE correspond à l'ID dans le nom de ressource de la ressource space de l'API Meet REST. Pour en savoir plus, consultez Comment Meet identifie un espace de réunion.
Utilisateur	//cloudidentity.googleapis.com/users/USER où USER correspond à l'ID dans le champ signedinUser.user de la ressource participant de l'API REST Meet. Pour en savoir plus, consultez Utiliser des participants.	L'abonnement reçoit des événements concernant les espaces de réunion dans lesquels l'utilisateur est l'un des suivants : Propriétaire de l'espace de réunion. Un participant à l'espace de réunion. L'organisateur de l'événement Google Agenda associé à l'espace de réunion.

Créer un abonnement Google Workspace

Pour créer un abonnement, vous utilisez la méthode subscriptions.create de l'API Google Workspace Events afin de créer une ressource Subscription. Vous spécifiez les champs suivants :

• targetResource : un compte Google Workspace que vous avez identifié dans la section précédente, mis en forme à l'aide de son nom de ressource complet.
• eventTypes : tableau d'un ou plusieurs types d'événements que vous souhaitez recevoir concernant la ressource. Par exemple, si votre application n'a besoin de connaître que les nouveaux messages publiés dans un espace Chat, elle peut simplement s'abonner aux événements concernant les messages créés.
• notificationEndpoint : point de terminaison de notification où votre abonnement Google Workspace envoie des événements. Vous utilisez le sujet Pub/Sub que vous avez créé dans la section précédente.
• payloadOptions : options permettant de spécifier la quantité de données de ressources à inclure dans la charge utile de l'événement. Cette configuration affecte le délai d'expiration de votre abonnement. Pour en savoir plus, consultez Données d'événement.

Pour créer un abonnement Google Workspace :

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, formatée sous la forme de son nom complet. Par exemple, pour s'abonner à un espace Google Chat avec l'ID d'espace 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-le en forme sous forme de tableau de chaînes, comme 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME : nom complet du sujet Pub/Sub que vous avez créé dans votre projet Cloud. Le fichier est au format projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA : valeur booléenne qui indique 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 permettent d'inclure 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('credentials.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 forme de tableau de chaînes. Pour lister plusieurs niveaux d'accès, 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, formatée sous la forme de son nom complet. Par exemple, pour s'abonner à un espace Google Chat avec l'ID d'espace 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-le en forme sous forme de tableau de chaînes, comme 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME : nom complet du sujet Pub/Sub que vous avez créé dans votre projet Cloud. Le fichier est au format projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA : valeur booléenne qui indique 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 permettent d'inclure 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

L'API Google Workspace Events renvoie une opération de longue durée terminée qui contient l'instance de la ressource Subscription que vous avez créée.

Tester votre abonnement Google Workspace

Pour vérifier que vous recevez bien les événements Google Workspace, vous pouvez déclencher un événement et extraire les messages vers l'abonnement Pub/Sub.

Pour tester votre abonnement Google Workspace :

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 d'un espace Chat, publiez un message dans l'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 correspondant à 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 à partir d'un événement peut prendre 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 d'un espace Chat, publiez un message dans l'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/PROJECT_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 à partir d'un événement peut prendre quelques minutes.

Pour chaque événement Google Workspace que vous avez déclenché, un message contenant l'événement est envoyé à votre abonnement Pub/Sub. Pour en savoir plus, consultez Recevoir des événements en tant que messages Google Cloud Pub/Sub.

Configurer la façon dont votre application reçoit les événements

L'abonnement Pub/Sub que vous avez créé est basé sur l'extraction. Une fois que vous avez testé votre abonnement Pub/Sub, vous pouvez modifier le type de distribution pour changer la façon dont votre application reçoit les événements. Par exemple, vous pouvez configurer l'abonnement Pub/Sub sur un type de diffusion push afin que votre application puisse recevoir des événements directement sur un point de terminaison d'application.

Pour savoir comment configurer un abonnement Pub/Sub, consultez la documentation Pub/Sub.

Remarque : Vous ne pouvez pas définir un projet Apps Script comme point de terminaison de distribution push dans Pub/Sub. Pour envoyer des messages Pub/Sub à un projet Apps Script, vous devez publier le script en tant qu'application Web.

Articles associés

• Tutoriel : Observer les événements de réunion avec Python et l'API REST Google Meet
• Souscrire un abonnement
• Lister les abonnements
• Modifier ou renouveler un abonnement
• Résoudre les erreurs et réactiver un abonnement
• Supprimer un abonnement