Этот документ содержит информацию об авторизации и аутентификации, специфичную для API Gmail. Перед прочтением этого документа обязательно ознакомьтесь с общей информацией об аутентификации и авторизации в Google Workspace в разделе «Узнайте об аутентификации и авторизации» .
Настройте OAuth 2.0 для авторизации
Настройте экран согласия OAuth и выберите области действия , чтобы определить, какая информация будет отображаться пользователям и рецензентам приложения, а также зарегистрируйте свое приложение, чтобы вы могли опубликовать его позже.
Области действия API Gmail
Чтобы определить уровень доступа, предоставляемый вашему приложению, необходимо определить и объявить области авторизации . Область авторизации — это строка URI OAuth 2.0, содержащая название приложения Google Workspace, тип данных, к которым оно получает доступ, и уровень доступа. Области авторизации — это запросы вашего приложения на работу с данными Google Workspace, включая данные учётных записей Google пользователей.
При установке вашего приложения пользователю предлагается подтвердить используемые им области действия. Как правило, следует выбирать максимально узкую область действия и избегать запроса областей действия, которые не требуются вашему приложению. Пользователи охотнее предоставляют доступ к ограниченным, чётко описанным областям действия.
API Gmail поддерживает следующие области действия:
| Код области действия | Описание | Использование |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose | Управляйте черновиками и отправляйте электронные письма при взаимодействии с дополнением. | Нечувствительный |
https://www.googleapis.com/auth/gmail.addons.current.message.action | Просматривайте сообщения электронной почты при взаимодействии с дополнением. | Нечувствительный |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata | Просматривайте метаданные сообщений электронной почты, когда надстройка запущена. | Чувствительный |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly | Просматривайте сообщения электронной почты, когда дополнение запущено. | Чувствительный |
https://www.googleapis.com/auth/gmail.labels | Только создание, чтение, обновление и удаление меток. | Нечувствительный |
https://www.googleapis.com/auth/gmail.send | Только отправлять сообщения. Нет прав на чтение или изменение почтового ящика. | Чувствительный |
https://www.googleapis.com/auth/gmail.readonly | Чтение всех ресурсов и их метаданных — без операций записи. | Ограниченный |
https://www.googleapis.com/auth/gmail.compose | Создавайте, читайте, обновляйте и удаляйте черновики. Отправляйте сообщения и черновики. | Ограниченный |
https://www.googleapis.com/auth/gmail.insert | Только вставка и импорт сообщений. | Ограниченный |
https://www.googleapis.com/auth/gmail.modify | Все операции чтения/записи, за исключением немедленного и безвозвратного удаления потоков и сообщений, минуя Корзину. | Ограниченный |
https://www.googleapis.com/auth/gmail.metadata | Чтение метаданных ресурсов, включая метки, записи истории и заголовки сообщений электронной почты, но не тела сообщения или вложений. | Ограниченный |
https://www.googleapis.com/auth/gmail.settings.basic | Управление основными настройками почты. | Ограниченный |
https://www.googleapis.com/auth/gmail.settings.sharing | Управляйте конфиденциальными настройками почты, включая правила пересылки и псевдонимы. Примечание: Операции, контролируемые этой областью, предназначены только для административного использования. Они доступны только клиентам Google Workspace, использующим сервисную учетную запись с делегированием полномочий на уровне домена. | Ограниченный |
https://mail.google.com/ | Полный доступ к почтовым ящикам учетной записи, включая безвозвратное удаление потоков и сообщений. Эту область следует запрашивать только в том случае, если вашему приложению необходимо немедленно и безвозвратно удалять потоки и сообщения, минуя Корзину; все остальные действия можно выполнить с помощью менее разрешительных областей. | Ограниченный |
Столбец «Использование» в таблице выше указывает чувствительность каждой области в соответствии со следующими определениями:
Неконфиденциальные — эти области предоставляют наименьшую сферу доступа к авторизации и требуют только базовой проверки приложения. Подробнее об этом требовании см. в разделе «Подготовка к проверке» .
Конфиденциальные — эти области доступа предоставляют доступ к пользовательским данным Google и требуют проверки конфиденциальных данных. Подробнее об этом требовании см. в разделе «Сервисы API Google: политика в отношении пользовательских данных» . Для этих областей доступа оценка безопасности не требуется.
Ограниченные — эти области предоставляют широкий доступ к данным пользователей Google и требуют прохождения процедуры проверки ограниченной области. Подробнее об этом требовании см. в разделе «Сервисы API Google: политика в отношении пользовательских данных и дополнительные требования к конкретным областям API» . Если вы храните данные ограниченной области на серверах (или передаете их), вам необходимо пройти оценку безопасности.
Дополнительную информацию, регулирующую использование и доступ к API Gmail при запросе доступа к пользовательским данным, можно найти в Политике использования пользовательских данных и политики разработчиков API Gmail .
Если вашему приложению требуется доступ к другим API Google, вы также можете добавить эти области действия. Подробнее об областях действия API Google см. в статье «Использование OAuth 2.0 для доступа к API Google» .
Проверка OAuth
Использование некоторых конфиденциальных областей OAuth может потребовать от вашего приложения прохождения проверки OAuth от Google . Ознакомьтесь с часто задаваемыми вопросами о проверке OAuth , чтобы определить, когда ваше приложение должно проходить проверку и какой тип проверки требуется. См. также Политику в отношении пользовательских данных Google API Services .