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

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

Configurer OAuth 2.0 pour l'autorisation

Configurer l'écran de consentement OAuth et choisir les niveaux d'accès de définir les informations présentées aux utilisateurs et aux examinateurs de l'application, 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 niveaux 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 le niveau d'accès. Les champs d'application correspondent aux demandes de votre application à utiliser les données Google Workspace, y compris des utilisateurs Données du compte Google.

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 la portée la plus ciblée et évitez de demander des niveaux d'accès dont votre application n'a pas besoin. Plus d'utilisateurs accorder facilement un accès à des portées limitées et clairement décrites.

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

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

Le tableau suivant présente les champs d'application acceptés pour le 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. Dons l'accès à toutes les fonctionnalités disponibles pour les applications Chat. <ph type="x-smartling-placeholder"> Non sensible
https://www.googleapis.com/auth/chat.memberships Affichez les 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é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 Affichez le chat et les espaces dans Google Chat.
Sensible
https://www.googleapis.com/auth/chat.messages.reaction s Affichez, ajoutez et supprimez des réactions aux messages dans Chat.
Sensible
https://www.googleapis.com/auth/chat.messages.reactions.readonly Affichez 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 Affichez les messages et les réactions dans Google Chat.
Restreint
Google Meet  
https://www.googleapis.com/auth/meetings.space.created Autoriser 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 de n'importe quel espace de réunion auquel l'utilisateur a accès.
Sensible

La colonne Utilisation dans le tableau précédent indique le degré de sensibilité de chaque champ d’application, conformément aux définitions suivantes:

  • Non sensible : ces champs d'application fournissent le champ d'application le plus limité possible autorisation d'accès et ne nécessite qu'une vérification de base de l'application. Pour plus d'informations sur cette exigence, consultez la section Étapes pour préparer validation.

  • Sensible : ces niveaux d'accès permettent d'accéder à des données utilisateur Google spécifiques autorisé par l'utilisateur pour votre application. Cela nécessite de passer par une validation supplémentaire de l'application. Pour plus d'informations sur cette exigence, consultez la section Étapes pour les applications demandant des informations champs d'application

  • Limité : ces niveaux d'accès offrent un large accès aux données utilisateur Google. et exigent que vous vous soumettiez à une procédure de validation limitée du champ d'application. Pour pour plus d'informations à ce sujet, consultez la page Google API Services: User Data Règlement et les exigences supplémentaires pour une API spécifique Champs d'application. Si vous stockez des données à champ d'application restreint sur des serveurs (ou si vous les transmettez), vous devez passer une évaluation de sécurité.

Si votre application a besoin d'accéder à d'autres API Google, vous pouvez ajouter ces niveaux d'accès . Pour plus d'informations sur les champs d'application des API Google, consultez la page Utilisation d'OAuth 2.0 pour Accédez aux API Google.

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

Validation OAuth

L'utilisation de certaines habilitations OAuth peut nécessiter que votre application passe par les Validation OAuth processus. Lisez l'article Validation de l'API OAuth Questions fréquentes pour déterminer quand votre application doit être validée, ainsi que le type une validation est requise. Consultez également les Conditions supplémentaires de Google Drive d'assistance.

Types d'authentification requises

Cette section décrit les types d'authentification requis et pris en charge. et fournit les champs d'application acceptés pour chaque méthode API Google Workspace Events.

Pour les abonnements à des é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 API prend en charge les deux identifiants, le type utilisé dans l'appel a une incidence sur le résultat renvoyé. Par exemple, si vous appelez la méthode subscriptions.list() avec authentification de l'utilisateur, l'API renvoie une liste d'abonnements auquel l'utilisateur authentifié peut accéder. Si vous utilisez l'authentification des applications, l'API renvoie une liste d'abonnements auxquels l'application peut accéder. Pour en savoir plus sur les types d'authentification Chat, consultez la section Authentifier et autoriser Applications de chat et API Google Chat requêtes.

Le tableau suivant indique les champs d'application et les types sont requises ou compatibles avec chaque API Google Workspace Events méthode:

Méthode Authentification de l'utilisateur requise ou compatible Authentification des applications disponible (applications Google Chat uniquement) Champs d'application d'autorisation 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 qui accepte au moins un type d'événement pour l'abonnement.

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

  • chat.bot
Lister 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 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 qui accepte au moins un type d'événement pour l'abonnement.

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

  • chat.bot

Champs d'application par type d'événement

Lorsque vous appelez l'API Google Workspace Events via l'authentification des utilisateurs, vous doit spécifier un ou plusieurs champs d'application correspondant aux types d'événements du 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 a été créée, mise à jour ou supprimée, ou plusieurs adhésions 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 modifié 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