В этом документе содержится информация об авторизации и аутентификации, специфичная для API событий Google Workspace. Перед прочтением этого документа обязательно ознакомьтесь с общей информацией об аутентификации и авторизации в Google Workspace по ссылке «Узнайте об аутентификации и авторизации» .
Настройте OAuth 2.0 для авторизации.
Настройте экран согласия OAuth и выберите области действия , чтобы определить, какая информация отображается пользователям и рецензентам приложения, а также зарегистрируйте свое приложение, чтобы вы могли опубликовать его позже.
Области действия API событий Google Workspace
Чтобы определить уровень доступа, предоставляемый вашему приложению, необходимо идентифицировать и объявить области авторизации . Область авторизации — это строка URI OAuth 2.0, содержащая имя приложения Google Workspace, тип данных, к которым оно получает доступ, и уровень доступа. Области авторизации — это запросы вашего приложения на работу с данными Google Workspace, включая данные учетных записей Google пользователей.
При установке вашего приложения пользователю предлагается подтвердить области действия, используемые приложением. Как правило, следует выбирать максимально узкую область действия и избегать запросов на области, которые вашему приложению не требуются. Пользователи охотнее предоставляют доступ к ограниченным, четко описанным областям действия.
API событий Google Workspace использует области действия (scopes) из приложений Google Workspace, поддерживающих подписки. Если ваше приложение уже использует области действия, необходимые для вашей подписки, вам не нужно добавлять новые области действия для использования API событий Google Workspace. Если вы все же добавляете области действия, выберите наименее конфиденциальную область, которая все еще позволяет вашему приложению функционировать. Подробную информацию о категориях областей действия см. в разделе «Категории областей действия» .
В таблице ниже перечислены поддерживаемые области действия API событий Google Workspace:
| Код области действия | Описание | Использование | ||
|---|---|---|---|---|
| Google Чат | ||||
https://www.googleapis.com/auth/chat.bot | Позволяет приложениям для чата просматривать чаты и отправлять сообщения. Предоставляет доступ ко всем функциям, доступным приложениям для чата. | Нечувствительный | ||
https://www.googleapis.com/auth/chat.memberships | Просматривайте, добавляйте и удаляйте участников из бесед в чате. | Чувствительный | ||
https://www.googleapis.com/auth/chat.memberships.readonly | Просматривайте сообщения участников в чате. | Чувствительный | ||
https://www.googleapis.com/auth/chat.app.memberships | Просматривайте, добавляйте, обновляйте и удаляйте участников из бесед и пространств в чате как в приложении для чата. Требуется одобрение администратора . Данная область действия поддерживает аутентификацию только приложений с использованием учетных записей служб. Аутентификация с использованием учетных данных пользователей или делегирования полномочий в масштабе домена с помощью данной области действия невозможна. | Чувствительный | ||
https://www.googleapis.com/auth/chat.spaces | Создавайте беседы и пространства, а также просматривайте или обновляйте метаданные (включая настройки истории) в чате. | Чувствительный | ||
https://www.googleapis.com/auth/chat.spaces.readonly | Просматривайте чат и пространства в чате. | Чувствительный | ||
https://www.googleapis.com/auth/chat.app.spaces | Создавайте беседы и пространства, а также просматривайте или обновляйте метаданные (включая настройки истории) в чате как в приложении для чата. Требуется одобрение администратора . Данная область действия поддерживает аутентификацию только приложений с использованием учетных записей служб. Аутентификация с использованием учетных данных пользователей или делегирования полномочий в масштабе домена с помощью данной области действия невозможна. | Чувствительный | ||
https://www.googleapis.com/auth/chat.messages.reaction | Просматривайте, добавляйте и удаляйте реакции на сообщения в чате. | Чувствительный | ||
https://www.googleapis.com/auth/chat.messages.reactions.readonly | Просматривайте реакции на сообщение в чате. | Чувствительный | ||
https://www.googleapis.com/auth/chat.messages | Просматривайте, создавайте, отправляйте, обновляйте и удаляйте сообщения, а также добавляйте, просматривайте и удаляйте реакции на сообщения. | Ограниченный | ||
https://www.googleapis.com/auth/chat.messages.readonly | Просматривайте сообщения и реакции в чате. | Ограниченный | ||
https://www.googleapis.com/auth/chat.app.messages.readonly | Просматривайте сообщения и реакции в чате как в обычном приложении для чата. Требуется одобрение администратора . Данная область действия поддерживает аутентификацию только приложений с использованием учетных записей служб. Аутентификация с использованием учетных данных пользователей или делегирования полномочий в масштабе домена с помощью данной области действия невозможна. | Ограниченный | ||
| Google Диск | ||||
https://www.googleapis.com/auth/drive.file | Создавайте новые файлы в Google Диске или изменяйте существующие файлы, которые вы открываете с помощью приложения или которыми пользователь делится с приложением, используя API Google Picker или встроенную в приложение функцию выбора файлов. | Нечувствительный | ||
https://www.googleapis.com/auth/drive | Просматривайте и управляйте всеми своими файлами на Google Диске. | Ограниченный | ||
https://www.googleapis.com/auth/drive.readonly | Просмотрите и скачайте все свои файлы на Google Диске. | Ограниченный | ||
https://www.googleapis.com/auth/drive.metadata | Просматривайте и управляйте метаданными файлов на вашем Диске. | Ограниченный | ||
https://www.googleapis.com/auth/drive.metadata.readonly | Просмотрите метаданные файлов на вашем Диске. | Ограниченный | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created | Разрешите приложениям создавать, изменять и считывать метаданные о местах для проведения встреч, созданных вашим приложением. | Чувствительный | ||
https://www.googleapis.com/auth/meetings.space.readonly | Разрешите приложениям считывать метаданные о любом конференц-зале, к которому пользователь имеет доступ. | Чувствительный | ||
В столбце «Использование» в предыдущей таблице указан уровень чувствительности каждой области видимости:
Неконфиденциальная информация : Эти области доступа обеспечивают минимальный уровень авторизации и требуют лишь базовой проверки приложения. Для получения дополнительной информации об этом требовании см. раздел «Требования к проверке» .
Конфиденциальные данные : Эти области доступа предоставляют доступ к определенным пользовательским данным Google, разрешенный пользователем для вашего приложения. Для этого требуется дополнительная проверка приложения. Информацию об этом требовании см. в разделе «Требования к конфиденциальным и ограниченным областям доступа» .
Ограниченный доступ : Эти области доступа предоставляют широкий доступ к пользовательским данным Google и требуют прохождения процедуры проверки на наличие ограничений. Информацию об этом требовании см. в разделе «Сервисы Google API: Политика в отношении пользовательских данных и дополнительные требования для конкретных областей доступа API» . Если вы храните данные с ограниченным доступом на серверах (или передаете их), вам необходимо пройти оценку безопасности.
Если вашему приложению требуется доступ к другим API Google, вы также можете добавить соответствующие области действия. Дополнительную информацию об областях действия API Google см. в разделе «Использование OAuth 2.0 для доступа к API Google» .
Для получения дополнительной информации о конкретных областях действия OAuth 2.0 см. раздел «Области действия OAuth 2.0 для API Google» .
Проверка OAuth
Использование определенных областей действия OAuth может потребовать прохождения вашим приложением проверки OAuth через Центр поддержки . Ознакомьтесь с часто задаваемыми вопросами о приложениях OAuth , чтобы определить, когда ваше приложение должно пройти проверку и какой тип проверки требуется. См. также Условия предоставления услуг Drive .
Типы необходимой аутентификации
В этом разделе объясняется, какие типы аутентификации требуются или поддерживаются, и приводятся поддерживаемые области действия для каждого метода API событий Google Workspace.
Для подписок на события чата API событий Google Workspace поддерживает как аутентификацию пользователя, так и аутентификацию приложения для вызова некоторых своих методов. Если метод API поддерживает оба типа учетных данных, тип используемых учетных данных влияет на возвращаемый результат. Например, если вы вызываете метод subscriptions.list с аутентификацией пользователя, API возвращает список подписок, к которым может получить доступ аутентифицированный пользователь . Если вы используете аутентификацию приложения, API возвращает список подписок, к которым может получить доступ приложение . Чтобы узнать больше о типах аутентификации чата, см. раздел «Аутентификация и авторизация приложений чата и запросов API чата» .
В таблице ниже показано, какие области действия и типы аутентификации требуются или поддерживаются для каждого метода API событий Google Workspace:
| Метод | Требуется или поддерживается аутентификация пользователя | Поддерживается аутентификация приложения (только в чат-приложениях). | Поддерживаемые области авторизации | |
|---|---|---|---|---|
| Создать подписку | — | При аутентификации пользователя требуется указать поддерживаемую область действия для каждого типа событий :
Предварительная версия для разработчиков : При аутентификации приложения и подтверждении администратора (только для чат-приложений) требуется поддерживаемая область действия для каждого типа событий :
| ||
| Оформите подписку | При использовании аутентификации пользователя этот метод требует, чтобы область действия подписки поддерживала как минимум один тип событий . С аутентификацией через приложение (только для чат-приложений):
| |||
| Список подписок | При использовании аутентификации пользователя этот метод требует, чтобы область действия подписки поддерживала как минимум один тип событий . С аутентификацией через приложение (только для чат-приложений):
| |||
| Обновить подписку | — | При аутентификации пользователя требуется указать поддерживаемую область действия для каждого типа событий :
Предварительная версия для разработчиков : При аутентификации приложения и подтверждении администратора (только для чат-приложений) требуется поддерживаемая область действия для каждого типа событий :
| ||
| Возобновить подписку | — | При аутентификации пользователя требуется указать поддерживаемую область действия для каждого типа событий :
Предварительная версия для разработчиков : При аутентификации приложения и подтверждении администратора (только для чат-приложений) требуется поддерживаемая область действия для каждого типа событий :
| ||
| Удалить подписку | При использовании аутентификации пользователя этот метод требует, чтобы область действия подписки поддерживала как минимум один тип событий . С аутентификацией через приложение (только для чат-приложений):
| |||
Области действия по типу события
При вызове API событий Google Workspace с использованием аутентификации пользователя необходимо указать одну или несколько областей действия, соответствующих типам событий подписки.
В таблице ниже показано, какие области авторизации поддерживаются для каждого типа событий:
| События | Типы событий | Поддерживаемые области авторизации | ||||||
|---|---|---|---|---|---|---|---|---|
| Чат | ||||||||
| Сообщение опубликовано или обновлено. |
| При аутентификации пользователя :
| ||||||
| В результате реакции добавляется или удаляется одна реакция, либо изменяется несколько реакций. |
|
| ||||||
| Создается, обновляется или удаляется членство , либо изменяется несколько членств. |
| При аутентификации пользователя :
| ||||||
| Пробел обновляется или удаляется. |
| При аутентификации пользователя :
| ||||||
| Водить машину | ||||||||
| Файл создается, изменяется, перемещается, удаляется, переименовывается, отправляется в корзину или извлекается из корзины. |
|
| ||||||
| Запрос на доступ создается или обрабатывается для файла. |
|
| ||||||
| Утверждение аннулируется, завершается, создается, сбрасывается, меняются рецензенты или рецензенты отвечают на запрос по файлу. |
|
| ||||||
| Комментарий создается, удаляется, редактируется, повторно открывается или разрешается в отношении файла. |
|
| ||||||
| Ответ создается, удаляется или редактируется в файле. |
|
| ||||||
| Разрешение создается, удаляется или редактируется для файла. |
|
| ||||||
| Встретиться | ||||||||
| Конференция начинается или заканчивается. |
|
| ||||||
| Участник присоединяется к конференции или покидает её. |
|
| ||||||
| Была сделана запись . |
|
| ||||||
| Была создана расшифровка . |
|
| ||||||