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