Ce document contient des informations sur l'autorisation et l'authentification spécifiques à l'API Gmail. 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 Gmail
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 utiliser 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, utilisez des niveaux d'accès non sensibles pour limiter l'accès aux fonctionnalités spécifiques dont une application a besoin.
Champs d'application non sensibles
Les niveaux d'accès suivants à l'API Gmail sont recommandés pour la plupart des cas d'utilisation :
| Code du champ d'application | Description |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Gérer les brouillons et envoyer des e-mails lors de vos interactions avec le module complémentaire. |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Consulter vos e-mails lorsque vous interagissez avec le module complémentaire |
https://www.googleapis.com/auth/gmail.labels |
Consultez et modifiez vos libellés d'e-mails. |
Niveaux d'accès sensibles
| Code du champ d'application | Description |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Afficher les métadonnées de vos e-mails lorsque le module complémentaire est en cours d'exécution. |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Consulter vos e-mails lorsque le module complémentaire est en cours d'exécution |
https://www.googleapis.com/auth/gmail.send |
Envoyer un e-mail de votre part. |
Niveaux d'accès restreints
| Code du champ d'application | Description |
|---|---|
https://mail.google.com/ |
Lire, rédiger, envoyer et supprimer définitivement des e-mails dans Gmail
Remarque : Ne demandez ce champ d'application que si votre application doit supprimer immédiatement et définitivement des fils de discussion et des messages, en ignorant la corbeille. Vous pouvez effectuer toutes les autres actions à l'aide de champs d'application moins permissifs. |
https://www.googleapis.com/auth/gmail.readonly |
Affichez vos e-mails et vos paramètres de messagerie. |
https://www.googleapis.com/auth/gmail.compose |
Gérez les brouillons et envoyez des e-mails. |
https://www.googleapis.com/auth/gmail.insert |
Ajoutez des e-mails à votre boîte aux lettres Gmail. |
https://www.googleapis.com/auth/gmail.modify |
Consulter, rédiger et envoyer des e-mails à partir de votre compte Gmail Ce champ d'application ne permet pas la suppression immédiate et définitive des fils de discussion et des messages, en contournant la corbeille. |
https://www.googleapis.com/auth/gmail.metadata |
Afficher les métadonnées de vos messages, telles que les libellés et les en-têtes, mais pas le corps des e-mails. |
https://www.googleapis.com/auth/gmail.settings.basic |
Consultez, modifiez ou créez des paramètres et filtres de messagerie dans Gmail. |
https://www.googleapis.com/auth/gmail.settings.sharing |
Gérez les paramètres de messagerie particulièrement sensibles, y compris la liste des personnes autorisées à gérer votre messagerie.
Remarque : Les opérations protégées par ce champ d'application sont réservées à un usage administratif. Elles ne sont disponibles que pour les clients Google Workspace qui utilisent un compte de service avec délégation au niveau du domaine. |
Les niveaux d'accès dans les tableaux précédents indiquent leur sensibilité, selon les définitions suivantes :
Non sensibles : ces niveaux d'accès offrent le plus petit champ d'application d'autorisation et ne nécessitent qu'une validation de base des applications OAuth. Pour en savoir plus, consultez Exigences liées à la validation.
Sensibles : ces habilitations permettent d'accéder à des données utilisateur Google spécifiques que les utilisateurs autorisent pour votre application. Elles nécessitent une validation supplémentaire de l'application OAuth. Pour en savoir plus, consultez Exigences concernant les autorisations sensibles et restreintes.
Restreint : ces habilitations offrent un large accès aux données utilisateur Google et nécessitent une validation des applications OAuth à champ d'application restreint. Pour en savoir plus, consultez le Règlement sur les données utilisateur dans les services d'API Google et les Exigences supplémentaires pour les champs d'application d'API spécifiques.
Si vous stockez (ou transmettez) des données à portée restreinte sur des serveurs, vous devez passer une évaluation de sécurité.
Vous trouverez des informations supplémentaires régissant votre utilisation des API Gmail et votre accès à celles-ci lorsque vous demandez à accéder aux données utilisateur dans les Règles Google Workspace API concernant les données utilisateur et les développeurs.
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 sensibles peut nécessiter que votre application passe le processus de validation OAuth de Google. La FAQ sur la validation des applications OAuth peut vous aider à déterminer si cette étape est nécessaire et quel type de validation est requis.