Choisir les champs d'application de l'API Google Workspace Events

Ce document contient des informations d'autorisation et d'authentification spécifiques à l'API Google Workspace Events. Avant de lire ce document, veillez à lire les informations générales d'authentification et d'autorisation de Google Workspace sur la page En savoir plus sur l'authentification et l'autorisation.

Configurer OAuth 2.0 pour l'autorisation

Configurez l'écran de consentement OAuth et choisissez les champs d'application pour définir les informations à présenter aux utilisateurs et aux examinateurs d'applications, et enregistrez votre application pour pouvoir la publier ultérieurement.

Champs d'application de l'API Google Workspace Events

Pour définir le niveau d'accès accordé à votre application, vous devez identifier et déclarer des champs d'application d'autorisation. Un champ d'application d'autorisation est une chaîne d'URI OAuth 2.0 contenant le nom de l'application Google Workspace, le type de données auxquelles elle accède et le niveau d'accès. Les champs d'application correspondent aux demandes d'utilisation de votre application avec les données Google Workspace, y compris les données des comptes Google des utilisateurs.

Lorsque votre application est installée, l'utilisateur est invité à valider les champs d'application utilisés par l'application. En règle générale, vous devez choisir le champ d'application le plus précis possible et éviter de demander les champs d'application dont votre application n'a pas besoin. Les utilisateurs accordent plus facilement l'accès à des champs d'application limités et clairement décrits.

Dans la mesure du possible, nous vous recommandons d'utiliser des champs d'application non sensibles, car ils accordent un niveau d'accès par fichier et limitent l'accès à des fonctionnalités spécifiques nécessaires à une application.

L'API Google Workspace Events utilise les champs d'application des applications Google Workspace compatibles avec les abonnements. Si votre application utilise déjà les champs d'application requis pour votre abonnement, vous n'avez pas besoin d'en ajouter d'autres pour utiliser l'API Google Workspace Events.

Le tableau suivant présente les champs d'application compatibles avec l'API Google Workspace Events:

Code du champ d'application Description Utilisation
Google Chat  
https://www.googleapis.com/auth/chat.bot Autorise les applications Google Chat à afficher les discussions et à envoyer des messages. Donne l'accès à toutes les fonctionnalités disponibles pour les applications Chat. Non sensible
https://www.googleapis.com/auth/chat.memberships Affichez des participants aux conversations dans Google Chat, ajoutez-en et supprimez-en.
Sensible
https://www.googleapis.com/auth/chat.memberships.readonly Afficher les participants aux conversations Google Chat
Sensible
https://www.googleapis.com/auth/chat.spaces Créez des conversations et des espaces, et affichez ou modifiez les métadonnées (y compris les paramètres d'historique) dans Google Chat. Contenu à caractère sensible
https://www.googleapis.com/auth/chat.spaces.readonly Affichez le chat et les espaces dans Google Chat.
Sensible
https://www.googleapis.com/auth/chat.messages Afficher, rédiger, envoyer, mettre à jour et supprimer les messages, et ajouter, afficher et supprimer les réactions aux messages Limité
https://www.googleapis.com/auth/chat.messages.readonly Affichez les messages et les réactions dans Google Chat.
Restreint
https://www.googleapis.com/auth/chat.messages.reaction s Affichez, ajoutez et supprimez des réactions aux messages dans Chat.
Restreint
https://www.googleapis.com/auth/chat.messages.reactions.readonly Affichez les réactions à un message dans Chat.
Restreint
Google Meet  
https://www.googleapis.com/auth/meetings.space.created Autorisez les applications à créer, modifier et lire les métadonnées sur les espaces de réunion créés par votre application.
Sensible
https://www.googleapis.com/auth/meetings.space.readonly Autoriser les applications à lire les métadonnées sur les espaces de réunion auxquels l'utilisateur a accès.
Sensible

La colonne "Utilisation" du tableau précédent indique la sensibilité de chaque champ d'application, selon les définitions suivantes:

Si votre application nécessite l'accès à d'autres API Google, vous pouvez également ajouter ces niveaux d'accès. Pour en savoir plus sur les champs d'application des API Google, consultez la page Utiliser OAuth 2.0 pour accéder aux API Google.

Pour en savoir plus sur les habilitations OAuth 2.0 spécifiques, consultez Champs d'application OAuth 2.0 pour les API Google.

Validation OAuth

Pour utiliser certains champs d'application OAuth, votre application peut nécessiter le processus de validation OAuth de Google. Consultez les questions fréquentes sur la validation de l'API OAuth pour déterminer quand votre application doit être soumise à la validation et quel type de validation est requis. Consultez également les Conditions d'utilisation supplémentaires de Google Drive.

Types d'authentifications requises

Cette section explique les types d'authentification requis ou acceptés, et fournit les champs d'application acceptés pour chaque méthode de l'API Google Workspace Events.

Pour les abonnements aux événements Google Chat, l'API Google Workspace Events prend en charge l'authentification des utilisateurs et des applications pour appeler certaines de ses méthodes. Si une méthode API est compatible avec les deux identifiants, le type d'identifiant utilisé dans l'appel a une incidence sur le résultat renvoyé. Par exemple, si vous appelez la méthode subscriptions.list() avec l'authentification de l'utilisateur, l'API renvoie une liste d'abonnements auxquels l'utilisateur authentifié peut accéder. Si vous utilisez l'authentification d'application, l'API renvoie une liste des abonnements auxquels l'application peut accéder. Pour en savoir plus sur les types d'authentification Chat, consultez Authentifier et autoriser les applications Chat et les requêtes de l'API Google Chat.

Le tableau suivant indique les champs d'application et les types d'authentification requis ou compatibles pour chaque méthode de l'API Google Workspace Events:

Méthode Authentification de l'utilisateur requise ou prise en charge Authentification des applications compatible (applications Google Chat uniquement) Champs d'application des autorisations compatibles
Créer un abonnement

Nécessite une portée compatible pour chaque type d'événement:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Souscrire un abonnement Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application compatible avec au moins un type d'événement pour l'abonnement.

Avec l'authentification de l'application (applications Google Chat uniquement):

  • chat.bot
Répertorier les abonnements Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application compatible avec au moins un type d'événement pour l'abonnement.

Avec l'authentification de l'application (applications Google Chat uniquement):

  • chat.bot
Mettre à jour un abonnement

Nécessite une portée compatible pour chaque type d'événement:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Réactiver un abonnement

Nécessite une portée compatible pour chaque type d'événement:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Supprimer un abonnement Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application compatible avec au moins un type d'événement pour l'abonnement.

Avec l'authentification de l'application (applications Google Chat uniquement):

  • chat.bot

Portées par type d'événement

Lorsque vous appelez l'API Google Workspace Events à l'aide de l'authentification des utilisateurs, vous devez spécifier un ou plusieurs champs d'application correspondant aux types d'événements de l'abonnement.

Le tableau suivant indique les champs d'application des autorisations compatibles avec chaque type d'événement:

Événements Types d'événements Champs d'application des autorisations compatibles
Google Chat  
Un message est publié ou mis à jour.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
Une réaction est ajoutée ou supprimée, ou plusieurs réactions sont modifiées.
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
Un abonnement est créé, mis à jour ou supprimé, ou plusieurs adhésions sont modifiées.
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
Un espace est mis à jour ou supprimé.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Meet  
Une conférence commence ou se termine.
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
Un participant rejoint ou quitte une conférence.
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
Un enregistrement a été généré.
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
Une transcription a été générée.
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly