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