Этот документ содержит информацию об авторизации и аутентификации, специфичную для Gmail API. Прежде чем читать этот документ, обязательно прочтите общую информацию об аутентификации и авторизации Google Workspace в разделе Подробнее об аутентификации и авторизации .
Настройте OAuth 2.0 для авторизации
Настройте экран согласия OAuth и выберите области, чтобы определить, какая информация будет отображаться пользователям и рецензентам приложений, а также зарегистрируйте свое приложение, чтобы можно было опубликовать его позже.
Области API Gmail
Чтобы определить уровень доступа, предоставленный вашему приложению, вам необходимо определить и объявить области авторизации . Область авторизации – это строка URI OAuth 2.0, содержащая имя приложения Google Workspace, тип данных, к которым оно обращается, и уровень доступа. Области – это запросы вашего приложения на работу с данными Google Workspace, включая данные аккаунтов Google пользователей.
Когда ваше приложение установлено, пользователю предлагается проверить области, используемые приложением. Как правило, вам следует выбирать максимально узконаправленную область действия и избегать запроса областей, которые не требуются вашему приложению. Пользователи с большей готовностью предоставляют доступ к ограниченным, четко описанным областям.
Gmail API поддерживает следующие области:
| Код области действия | Описание | Использование |
|---|---|---|
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 и требуют процедуры проверки конфиденциальной области. Информацию об этом требовании см. в разделе Службы Google API: Политика пользовательских данных . Эти области не требуют оценки безопасности.
Ограниченный — эти области обеспечивают широкий доступ к пользовательским данным Google и требуют от вас пройти процесс проверки ограниченной области. Информацию об этом требовании см. в разделе Службы API Google: Политика пользовательских данных и дополнительные требования для определенных областей API . Если вы храните данные ограниченного объема на серверах (или передаете), вам необходимо пройти оценку безопасности.
Дополнительную информацию, регулирующую использование вами API-интерфейсов Gmail и доступ к ним при запросе доступа к пользовательским данным, можно найти в Политике пользовательских данных и политики разработчиков служб API Gmail .
Если вашему приложению требуется доступ к каким-либо другим API Google, вы также можете добавить эти области. Дополнительную информацию об областях API Google см. в разделе Использование OAuth 2.0 для доступа к API Google .
Проверка OAuth
Использование определенных конфиденциальных областей OAuth может потребовать, чтобы ваше приложение прошло процесс проверки OAuth в Google . Прочтите часто задаваемые вопросы о проверке OAuth, чтобы определить, когда ваше приложение должно проходить проверку и какой тип проверки требуется. См. также Службы Google API: Политика в отношении пользовательских данных .