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 lire 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 champs d'application pour définir les informations affichées aux utilisateurs et aux examinateurs de l'application, puis 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 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 sont les demandes de votre application pour utiliser les données Google Workspace, y compris les données du 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 restreint 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 champs d'application limités et clairement décrits.

L'API Google Workspace Events utilise des champs d'application des applications Google Workspace qui acceptent les abonnements. Si votre application utilise déjà les champs d'application requis pour votre abonnement, vous n'avez pas besoin d'ajouter de champs d'application pour utiliser l'API Google Workspace Events. Si vous ajoutez des champs d'application, choisissez le moins sensible qui permet à votre application de fonctionner. Pour en savoir plus sur les catégories de champs d'application, consultez Catégories de champs d'application.

Le tableau suivant liste 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 Permet aux applications Chat d'afficher les discussions et d'envoyer des messages. Accorde l'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 Chat, ajouter des participants et en supprimer
Sensible
https://www.googleapis.com/auth/chat.memberships.readonly Afficher les participants aux conversations Chat.
Sensible
https://www.googleapis.com/auth/chat.app.memberships

Afficher les membres des conversations et des espaces dans Chat, en ajouter, en modifier et en supprimer en tant qu'application Chat.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.


Sensible
https://www.googleapis.com/auth/chat.app.memberships.readonly

Afficher les membres des conversations et des espaces dans Google Chat en tant qu'application Chat.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.


Sensible
https://www.googleapis.com/auth/chat.spaces Créer des conversations et des espaces, et afficher ou mettre à jour les métadonnées (y compris les paramètres de l'historique) dans Chat. Sensible
https://www.googleapis.com/auth/chat.spaces.readonly Afficher le chat et les espaces dans Chat.
Sensible
https://www.googleapis.com/auth/chat.app.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 Chat en tant qu'application Chat.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.


Sensible
https://www.googleapis.com/auth/chat.app.spaces.readonly

Afficher les métadonnées (y compris les paramètres de l'historique) dans Google Chat en tant qu'application Chat.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.


Sensible
https://www.googleapis.com/auth/chat.messages.reactions 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 Chat.
Limité
https://www.googleapis.com/auth/chat.app.messages.readonly

Afficher les messages et les réactions dans Chat en tant qu'application Chat.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.


Limité
https://www.googleapis.com/auth/chat.users.readstate Afficher et modifier l'état de lecture de l'utilisateur dans Chat.
Sensible
https://www.googleapis.com/auth/chat.users.readstate.readonly Afficher l'état de lecture des utilisateurs dans Chat.
Sensible
https://www.googleapis.com/auth/chat.users.availability Afficher et modifier l'état de disponibilité dans Chat.
Sensible
https://www.googleapis.com/auth/chat.users.availability.readonly Afficher l'état de disponibilité dans Chat.
Sensible
https://www.googleapis.com/auth/chat.app.all.spaces.readonly

Afficher les métadonnées de tous les espaces et conversations dans Google Chat dans l'ensemble de votre organisation Google Workspace, même lorsque l'application Chat n'en est pas membre.

Ce champ d'application n'est compatible qu'avec les abonnements client.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.

Limité
https://www.googleapis.com/auth/chat.app.all.memberships.readonly

Afficher tous les membres des espaces et des conversations Google Chat de votre organisation Google Workspace, même si l'application Chat n'en est pas membre.

Ce champ d'application n'est compatible qu'avec les abonnements client.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.

Limité
https://www.googleapis.com/auth/chat.app.all.messages.readonly

Afficher tous les messages et réactions dans l'ensemble de votre organisation Google Workspace, même lorsque l'application Chat n'est pas membre d'un espace ou d'une conversation

Ce champ d'application n'est compatible qu'avec les abonnements client.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.

Limité
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly

Afficher l'heure de dernière lecture pour tous les utilisateurs dans tous les espaces et conversations dans l'ensemble de votre organisation Google Workspace, même lorsque l'application Chat n'en est pas membre.

Ce champ d'application n'est compatible qu'avec les abonnements client.

Nécessite l'approbation de l'administrateur.

Ce champ d'application n'est compatible qu'avec l'authentification des applications avec des comptes de service. Vous ne pouvez pas vous authentifier avec des identifiants utilisateur ni avec la délégation au niveau du domaine à l'aide de ce champ d'application.

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 lorsqu'il utilise l'API Google Picker ou le 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 Consulter et télécharger tous vos fichiers Drive Limité
https://www.googleapis.com/auth/drive.metadata Afficher et gérer 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 Autorisez 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 Autoriser 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 champ d'application :

Si votre application nécessite l'accès à d'autres API Google, vous pouvez également ajouter ces champs d'application. 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 passe par le Centre d'aide pour la validation des applications OAuth. Consultez les questions fréquentes sur les applications OAuth pour déterminer quand votre application doit être validée et quel type de validation est requis. Consultez également les Conditions d'utilisation de Drive.

Types d'authentification requis

Cette section explique quels types d'authentification sont 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 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 d'abonnements auxquels l'utilisateur authentifié peut accéder. Si vous utilisez l'authentification par application, l'API renvoie la 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 Chat.

Le tableau suivant indique les champs d'application et les types d'authentification 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 par l'application compatible (applications Chat uniquement) Champs d'application des autorisations compatibles
Créer un abonnement —

Avec l'authentification des utilisateurs, 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
  • chat.users.readstate
  • chat.users.readstate.readonly
  • chat.users.availability
  • chat.users.availability.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

Avec l'authentification de l'application et l'approbation de l'administrateur (applications Google Chat uniquement), nécessite un champ d'application compatible pour chaque type d'événement :

  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.messages.readonly
  • chat.app.all.memberships.readonly
  • chat.app.all.spaces.readonly
  • chat.app.all.messages.readonly
  • chat.app.all.users.readstate.readonly
Souscrire un abonnement Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application qui accepte au moins un type d'événement pour l'abonnement.

Avec l'authentification par l'application (applications Chat uniquement) :

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

Avec l'authentification par l'application (applications Chat uniquement) :

  • chat.bot
Mettre à jour un abonnement —

Avec l'authentification des utilisateurs, 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
  • chat.users.readstate
  • chat.users.readstate.readonly
  • chat.users.availability
  • chat.users.availability.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

Avec l'authentification de l'application et l'approbation de l'administrateur (applications Google Chat uniquement), nécessite un champ d'application compatible pour chaque type d'événement :

  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.messages.readonly
  • chat.app.all.memberships.readonly
  • chat.app.all.spaces.readonly
  • chat.app.all.messages.readonly
  • chat.app.all.users.readstate.readonly
Réactiver un abonnement —

Avec l'authentification des utilisateurs, 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
  • chat.users.readstate
  • chat.users.readstate.readonly
  • chat.users.availability
  • chat.users.availability.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

Avec l'authentification de l'application et l'approbation de l'administrateur (applications Chat uniquement), nécessite un champ d'application compatible pour chaque type d'événement :

  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.messages.readonly
  • chat.app.all.memberships.readonly
  • chat.app.all.spaces.readonly
  • chat.app.all.messages.readonly
  • chat.app.all.users.readstate.readonly
Supprimer un abonnement Avec l'authentification des utilisateurs, cette méthode nécessite un champ d'application qui accepte au moins un type d'événement pour l'abonnement.

Avec l'authentification par l'application (applications Chat uniquement) :

  • chat.bot

Champs d'application 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 d'autorisation compatibles avec chaque type d'événement :

Événements Types d'événements Champs d'application des autorisations compatibles
Chat  
Un message est publié ou mis à jour.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
Avec l'authentification des utilisateurs :
  • chat.messages
  • chat.messages.readonly
Avec l'authentification des applications et l'approbation de l'administrateur :
  • chat.app.messages.readonly
  • chat.app.all.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
Avec l'authentification des utilisateurs :
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
Avec l'authentification des applications et l'approbation de l'administrateur :
  • chat.app.messages.readonly
  • chat.app.all.messages.readonly
Une appartenance est créée, mise à jour ou supprimée, ou plusieurs appartenances 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
Avec l'authentification des utilisateurs :
  • chat.memberships
  • chat.memberships.readonly
Avec l'authentification des applications et l'approbation de l'administrateur :
  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.all.memberships.readonly
Un espace est mis à jour ou supprimé.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
Avec l'authentification des utilisateurs :
  • chat.spaces
  • chat.spaces.readonly
Avec l'authentification des applications et l'approbation de l'administrateur :
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.all.spaces.readonly
L'état de lecture de l'espace ou l'état de lecture du fil de discussion d'un utilisateur est mis à jour.
  • google.workspace.chat.spaceReadState.v1.updated
  • google.workspace.chat.threadReadState.v1.updated
  • google.workspace.chat.spaceReadState.v1.batchUpdated
  • google.workspace.chat.threadReadState.v1.batchUpdated
Avec l'authentification des utilisateurs :
  • chat.users.readstate
  • chat.users.readstate.readonly
Avec l'authentification des applications et l'approbation de l'administrateur :
  • chat.app.all.users.readstate.readonly
Une disponibilité est mise à jour.
  • google.workspace.chat.availability.v1.updated
Avec l'authentification des utilisateurs :
  • chat.users.availability
  • chat.users.availability.readonly
Drive  
Un fichier est créé, modifié, déplacé, supprimé, renommé, placé dans 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.renamed
  • google.workspace.drive.file.v3.trashed
  • google.workspace.drive.file.v3.untrashed
  • drive
  • drive.file
  • drive.readonly
  • 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.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Une approbation est annulée, terminée, créée ou réinitialisée, ou les réviseurs ont été modifiés ou ont répondu à une demande d'approbation pour un fichier.
  • google.workspace.drive.approval.v3.cancelled
  • google.workspace.drive.approval.v3.completed
  • google.workspace.drive.approval.v3.created
  • google.workspace.drive.approval.v3.reset
  • google.workspace.drive.approval.v3.reviewersChanged
  • google.workspace.drive.approval.v3.reviewerResponded
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Un commentaire est créé, supprimé, modifié, rouvert ou résolu dans un fichier.
  • google.workspace.drive.comment.v3.created
  • google.workspace.drive.comment.v3.deleted
  • google.workspace.drive.comment.v3.edited
  • google.workspace.drive.comment.v3.reopened
  • google.workspace.drive.comment.v3.resolved
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Une réponse est créée, supprimée ou modifiée dans un fichier.
  • google.workspace.drive.reply.v3.created
  • google.workspace.drive.reply.v3.deleted
  • google.workspace.drive.reply.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Une autorisation est créée, supprimée ou modifiée sur un fichier.
  • google.workspace.drive.permission.v3.created
  • google.workspace.drive.permission.v3.deleted
  • google.workspace.drive.permission.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
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