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

Ce document contient des informations sur l'autorisation et l'authentification spécifiques à l'API Google Workspace Events. Avant de lire ce document, assurez-vous de consulter les informations générales sur l'authentification et l'autorisation dans 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 des habilitations pour définir les informations affichées aux utilisateurs et aux évaluateurs 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 les niveaux d'autorisation. Un champ d'application d'autorisation est une chaîne URI OAuth 2.0 qui contient 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 de votre application pour travailler avec les données Google Workspace, y compris les données de compte Google des utilisateurs.

Lors de l'installation de votre application, 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 des champs d'application dont votre application n'a pas besoin. Les utilisateurs accordent plus facilement l'accès à des niveaux d'accès limités et clairement décrits.

Dans la mesure du possible, nous vous recommandons d'utiliser des niveaux d'accès non sensibles, car ils accordent un niveau d'accès par fichier et limitent l'accès aux fonctionnalités spécifiques dont une application a besoin.

L'API Google Workspace Events utilise des champs d'application issus 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 niveaux d'accès compatibles avec l'API Google Workspace Events :

Code du champ d'application Description Utilisation
Google Chat  
https://www.googleapis.com/auth/chat.bot Permet aux applications Google Chat d'afficher les discussions et d'envoyer des messages. Donne accès à toutes les fonctionnalités disponibles pour les applications Chat. Non sensible
https://www.googleapis.com/auth/chat.memberships Afficher les participants aux conversations dans Google Chat, en ajouter et en supprimer
 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éer des conversations et des espaces, et afficher ou modifier les métadonnées (y compris les paramètres de l'historique) dans Google Chat Contenu à caractère sensible
https://www.googleapis.com/auth/chat.spaces.readonly Afficher les discussions et les espaces dans Google Chat.
 Sensible
https://www.googleapis.com/auth/chat.messages.reaction s Afficher, ajouter et supprimer des réactions à des messages dans Chat.
 Sensible
https://www.googleapis.com/auth/chat.messages.reactions.readonly Afficher les réactions à un message dans 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 Afficher les messages et les réactions dans Google Chat
 Limité
Google Drive  
https://www.googleapis.com/auth/drive.file créer des fichiers Drive ou modifier des fichiers existants que vous ouvrez avec une application ou que l'utilisateur partage avec une application à l'aide de l'API Google Picker ou du sélecteur de fichiers de l'application ; Non sensible
https://www.googleapis.com/auth/drive Affichez et gérez tous vos fichiers Drive. Limité
https://www.googleapis.com/auth/drive.readonly Consultez et téléchargez tous vos fichiers Drive. Limité
https://www.googleapis.com/auth/drive.metadata Affichez et gérez les métadonnées des fichiers présents dans votre Drive. Limité
https://www.googleapis.com/auth/drive.metadata.readonly Consultez les métadonnées de vos fichiers dans Drive. Limité
Google Meet  
https://www.googleapis.com/auth/meetings.space.created Autoriser les applications à créer, modifier et lire les métadonnées des espaces de réunion créés par votre application.
 Sensible
https://www.googleapis.com/auth/meetings.space.readonly Autorise les applications à lire les métadonnées de tous 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 autorisation, selon les définitions suivantes :

Si votre application nécessite d'accéder à 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 Utiliser OAuth 2.0 pour accéder aux API Google.

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

Validation OAuth

L'utilisation de certains champs d'application OAuth peut nécessiter que votre application suive la procédure décrite dans le Centre d'aide sur la validation des applications OAuth. Consultez les questions fréquentes sur la validation OAuth des applications pour déterminer quand votre application doit être validée et quel type de validation est requis. Consultez également les Conditions d'utilisation de Google Drive.

Types d'authentification requis

Cette section explique les types d'authentification requis ou acceptés, et fournit les niveaux d'accès 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 accepte l'authentification des utilisateurs et des applications pour appeler certaines de ses méthodes. Si une méthode d'API accepte les deux types d'identifiants, le type d'identifiant utilisé dans l'appel affecte 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 des 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 API Google Chat.

Le tableau suivant indique les types d'authentification et les niveaux d'accès requis ou acceptés pour chaque méthode de l'API Google Workspace Events :

Méthode Authentification de l'utilisateur requise ou acceptée Authentification des applications acceptée (applications Google Chat uniquement) Champs d'application des autorisations acceptés
Créer un abonnement

Nécessite un champ d'application 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
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly
Souscrire un abonnement Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application qui prend en charge au moins un type d'événement pour l'abonnement.

Avec l'authentification des applications (applications Google Chat uniquement) :

  • chat.bot
Lister les abonnements Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application qui prend en charge au moins un type d'événement pour l'abonnement.

Avec l'authentification des applications (applications Google Chat uniquement) :

  • chat.bot
Modifier un abonnement

Nécessite un champ d'application 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
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly
Réactiver un abonnement

Nécessite un champ d'application 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
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly
Supprimer un abonnement Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application qui prend en charge au moins un type d'événement pour l'abonnement.

Avec l'authentification des applications (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 niveaux d'autorisation compatibles avec chaque type d'événement :

Événements Types d'événements Champs d'application des autorisations acceptés
Google Chat  
Un message est publié ou modifié.
  • 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
  • chat.messages
  • chat.messages.readonly
Une souscription est créée, modifiée ou supprimée, ou plusieurs souscriptions 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 modifié ou supprimé.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Drive  
Un fichier est créé, modifié, déplacé, supprimé, mis à la corbeille ou supprimé de la corbeille.
  • google.workspace.drive.file.v3.added
  • google.workspace.drive.file.v3.moved
  • google.workspace.drive.file.v3.contentChanged
  • google.workspace.drive.file.v3.deleted
  • google.workspace.drive.file.v3.trashed
  • google.workspace.drive.file.v3.untrashed
  • drive
  • drive.file
  • drive.metadata
Une proposition d'accès est créée ou résolue pour un fichier.
  • google.workspace.drive.accessProposal.v3.created
  • google.workspace.drive.accessProposal.v3.resolved
  • drive
  • drive.file
  • drive.metadata
  • drive.metadata
  • drive.metadata.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