Ce document contient les autorisations et les autorisations spécifiques à l'API Gmail 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 des API Gmail
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.
L'API Gmail accepte les champs d'application suivants:
| Code du champ d'application | Description | Utilisation |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Gérez les brouillons et envoyez des e-mails lorsque vous interagissez avec l'appli un module complémentaire. | Non sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Afficher vos e-mails lorsque vous interagissez avec l'application un module complémentaire. | Non sensible |
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. | Contenu à caractère sensible |
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. | Contenu à caractère sensible |
https://www.googleapis.com/auth/gmail.labels |
Créer, lire, mettre à jour et supprimer des étiquettes uniquement. | Non sensible |
https://www.googleapis.com/auth/gmail.send |
Envoyer uniquement des messages Aucun droit de lecture ni de modification sur la boîte aux lettres. | Contenu à caractère sensible |
https://www.googleapis.com/auth/gmail.readonly |
Lire toutes les ressources et leurs métadonnées, aucune opération d'écriture | Limité |
https://www.googleapis.com/auth/gmail.compose |
Créez, lisez, mettez à jour et supprimez des brouillons. envoyer des messages et des brouillons ; | Limité |
https://www.googleapis.com/auth/gmail.insert |
Insérer et importer uniquement des messages | Limité |
https://www.googleapis.com/auth/gmail.modify |
Toutes les opérations de lecture/écriture, à l'exception de la suppression immédiate et définitive des les fils de discussion et les messages, sans passer par la corbeille. | Limité |
https://www.googleapis.com/auth/gmail.metadata |
Lire les métadonnées des ressources, y compris les étiquettes, les enregistrements d'historique et les e-mails mais pas le corps ni les pièces jointes du message. | Limité |
https://www.googleapis.com/auth/gmail.settings.basic |
Gérez les paramètres de base des e-mails. | Limité |
https://www.googleapis.com/auth/gmail.settings.sharing |
Gérez les paramètres de messagerie sensibles, y compris les règles de transfert et les alias.
Remarque:Les opérations protégées par ce champ d'application sont limitées qu'à usage administratif. Ils ne sont disponibles que pour les clients Google Workspace. à l'aide d'un compte de service avec délégation au niveau du domaine. |
Limité |
https://mail.google.com/ |
Accès complet aux boîtes aux lettres du compte, avec suppression définitive fils de discussion et messages. Ce champ d'application ne doit être demandé que si votre application doit supprimer immédiatement et définitivement les fils de discussion et les messages, en contournant Corbeille ; toutes les autres actions peuvent être effectuées avec des champs d'application moins permissifs. | Limité |
La colonne Utilisation dans le tableau ci-dessus indique le degré de sensibilité de chaque champ d’application, conformément aux définitions suivantes:
Non sensible : ces champs d'application fournissent la plus petite sphère de autorisation d'accès et ne nécessitent qu'une vérification de base de l'application. Pour plus d'informations sur cette exigence, consultez Étapes à suivre pour préparer la validation
Sensible : ces champs d'application permettent d'accéder aux données utilisateur Google et requièrent un processus de vérification du champ d’application sensible. Pour en savoir plus sur cette exigence, consultez Services d'API Google: règles sur les données utilisateur Ces champs d'application ne nécessitent pas d'évaluation de sécurité.
Restreint : ces niveaux d'accès offrent un large accès aux données utilisateur Google et vous obligeront à suivre une procédure de validation du champ d'application restreint. Pour pour en savoir plus sur cette exigence, consultez Services d'API Google: règles sur les données utilisateur Exigences supplémentaires pour des champs d'application d'API spécifiques. 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é.
Informations supplémentaires régissant votre utilisation des API Gmail et votre accès à celles-ci lorsque vous demande d'accès aux données de l'utilisateur figure dans le Données utilisateur et règlement pour les développeurs dans les services d'API Gmail.
Si votre application a besoin d'accéder à d'autres API Google, vous pouvez ajouter ces champs d'application. Pour en savoir plus sur les champs d'application des API Google, voir Utiliser le protocole OAuth 2.0 pour accéder aux API Google
Validation OAuth
L'utilisation de certains champs d'application OAuth sensibles peut nécessiter que votre application passe par Procédure de validation OAuth de Google. Consultez les questions fréquentes sur la validation OAuth. pour déterminer quand votre application doit être validée, ainsi que le type une validation est requise. Consultez également les Services d'API Google: règles sur les données utilisateur