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, consultez 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 autorisations pour définir les informations qui s'affichent auprès des utilisateurs et des examinateurs de l'application, 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 de l'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 correspondent aux demandes de votre application pour utiliser les données Google Workspace, y compris les données du compte Google des utilisateurs.

Lorsque votre application est installée, un 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 ciblé 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.

Dans la mesure du possible, nous vous recommandons d'utiliser des champs d'application non sensibles, car ils accordent un champ d'application par fichier et limitent l'accès aux fonctionnalités spécifiques requises par 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'ajouter de champs d'application supplémentaires pour utiliser l'API Google Workspace Events.

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

Code de champ d'application Description Utilisation
Google Chat  
https://www.googleapis.com/auth/chat.bot Permet aux applications Google Chat d'afficher les chats 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 Google Chat, ajouter des participants 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 Voir les discussions et 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 Meet  
https://www.googleapis.com/auth/meetings.space.created Autorisez les applications à créer, modifier et lire des métadonnées sur les espaces de réunion créés par votre application.
Sensible
https://www.googleapis.com/auth/meetings.space.readonly Autorisez les applications à lire les métadonnées de tout espace de réunion auquel l'utilisateur a accès.
Sensible

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

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 la section Utiliser OAuth 2.0 pour accéder aux API Google.

Pour en savoir plus sur des champs d'application OAuth 2.0 spécifiques, consultez la section 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 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 validée et quel type de validation est requis. Consultez également les Conditions d'utilisation supplémentaires de Google Drive.

Types d'authentification requis

Cette section explique les types d'authentification requis ou acceptés, et fournit les champs d'application compatibles 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 utilisateur et l'authentification de l'application 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 de l'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 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 compatible Authentification de l'application 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 utilisateur, cette méthode nécessite une portée 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
Répertorier les abonnements Avec l'authentification utilisateur, cette méthode nécessite une portée 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 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 utilisateur, cette méthode nécessite une portée 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 utilisateur, 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
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
  • chat.messages
  • chat.messages.readonly
Un abonnement est créé, mis à jour ou supprimé, ou plusieurs abonnements sont modifiés.
  • 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  
Début ou fin d'une conférence.
  • 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