Этот документ содержит информацию об авторизации и аутентификации, специфичную для API Google Workspace Events. Прежде чем читать этот документ, обязательно прочтите общую информацию об аутентификации и авторизации Google Workspace в разделе Подробнее об аутентификации и авторизации .
Настройте OAuth 2.0 для авторизации
Настройте экран согласия OAuth и выберите области, чтобы определить, какая информация будет отображаться пользователям и рецензентам приложений, а также зарегистрируйте свое приложение, чтобы можно было опубликовать его позже.
Области действия API Google Workspace Events
Чтобы определить уровень доступа, предоставленный вашему приложению, вам необходимо определить и объявить области авторизации . Область авторизации – это строка URI OAuth 2.0, содержащая имя приложения Google Workspace, тип данных, к которым оно обращается, и уровень доступа. Области – это запросы вашего приложения на работу с данными Google Workspace, включая данные аккаунтов Google пользователей.
Когда ваше приложение установлено, пользователю предлагается проверить области, используемые приложением. Как правило, вам следует выбирать максимально узконаправленную область действия и избегать запроса областей, которые не требуются вашему приложению. Пользователи с большей готовностью предоставляют доступ к ограниченным, четко описанным областям.
Когда это возможно, мы рекомендуем использовать неконфиденциальные области, поскольку они предоставляют область доступа для каждого файла и сужают доступ к определенным функциям, необходимым приложению.
API событий Google Workspace использует области приложений Google Workspace, поддерживающих подписки. Если ваше приложение уже использует области, необходимые для вашей подписки, вам не нужно добавлять дополнительные области для использования API событий Google Workspace.
В следующей таблице показаны поддерживаемые области действия API Google Workspace Events:
| Код области действия | Описание | Использование | ||
|---|---|---|---|---|
| Google Чат | ||||
https://www.googleapis.com/auth/chat.bot | Позволяет приложениям Google 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/meetings.space.created | Разрешите приложениям создавать, изменять и читать метаданные о пространствах для встреч, созданных вашим приложением. | Чувствительный | ||
https://www.googleapis.com/auth/meetings.space.readonly | Разрешите приложениям считывать метаданные о любом пространстве для встреч, к которому у пользователя есть доступ. | Чувствительный | ||
Столбец «Использование» в предыдущей таблице указывает чувствительность каждой области в соответствии со следующими определениями:
Неконфиденциально — эти области обеспечивают наименьший объем авторизационного доступа и требуют только базовой проверки приложения. Информацию об этом требовании см. в разделе «Шаги по подготовке к проверке» .
Конфиденциальный — эти области обеспечивают доступ к определенным пользовательским данным Google, которые разрешены пользователем для вашего приложения. Вам потребуется пройти дополнительную проверку приложения. Информацию об этом требовании см. в разделе Действия для приложений, запрашивающих конфиденциальные области.
Ограниченный — эти области обеспечивают широкий доступ к пользовательским данным Google и требуют прохождения процесса проверки с ограниченным объемом. Информацию об этом требовании см. в разделе Службы API Google: Политика пользовательских данных и дополнительные требования для определенных областей API . Если вы храните данные ограниченного объема на серверах (или передаете), вам необходимо пройти оценку безопасности.
Если вашему приложению требуется доступ к каким-либо другим API Google, вы также можете добавить эти области. Дополнительную информацию об областях API Google см. в разделе Использование OAuth 2.0 для доступа к API Google .
Дополнительную информацию о конкретных областях действия OAuth 2.0 см. в разделе «Области действия OAuth 2.0 для API Google» .
Проверка OAuth
Использование определенных областей OAuth может потребовать, чтобы ваше приложение прошло процесс проверки Google OAuth . Прочтите часто задаваемые вопросы по проверке OAuth API, чтобы определить, когда ваше приложение должно проходить проверку и какой тип проверки требуется. См. также Дополнительные условия использования Google Диска .
Типы необходимой аутентификации
В этом разделе объясняется, какие типы аутентификации требуются или поддерживаются, а также представлены поддерживаемые области для каждого метода API Google Workspace Events.
Для подписок на события Google Chat API Google Workspace Events поддерживает аутентификацию как пользователей, так и приложений для вызова некоторых своих методов. Если метод API поддерживает оба учетных данных, тип учетных данных, используемых в вызове, влияет на возвращаемый результат. Например, если вы вызываете метод subscriptions.list() с аутентификацией пользователя, API возвращает список подписок, к которым может получить доступ аутентифицированный пользователь . Если вы используете аутентификацию приложения, API возвращает список подписок, к которым приложение может получить доступ. Дополнительные сведения о типах аутентификации Chat см. в разделе Аутентификация и авторизация приложений Chat и запросов API Google Chat .
В следующей таблице показано, какие области и типы аутентификации требуются или поддерживаются для каждого метода API Google Workspace Events:
| Метод | Требуется или поддерживается аутентификация пользователя | Поддерживается аутентификация приложений (только приложения Google Chat) | Поддерживаемые области авторизации | |
|---|---|---|---|---|
| Создать подписку | — | Требуется поддерживаемая область для каждого типа событий :
| ||
| Получить подписку | При проверке подлинности пользователя для этого метода требуется область, поддерживающая хотя бы один тип событий для подписки. При аутентификации через приложение (только приложения Google Chat):
| |||
| Получение списка подписок | При проверке подлинности пользователя для этого метода требуется область, поддерживающая хотя бы один тип событий для подписки. При аутентификации через приложение (только приложения Google Chat):
| |||
| Обновить подписку | — | Требуется поддерживаемая область для каждого типа событий :
| ||
| Повторно активировать подписку | — | Требуется поддерживаемая область для каждого типа событий :
| ||
| Удалить подписку | При проверке подлинности пользователя для этого метода требуется область, поддерживающая хотя бы один тип событий для подписки. При аутентификации через приложение (только приложения Google Chat):
| |||
Области действия по типу события
При вызове API событий Google Workspace с использованием аутентификации пользователя необходимо указать одну или несколько областей, соответствующих типам событий подписки.
В следующей таблице показано, какие области авторизации поддерживаются для каждого типа событий:
| События | Типы событий | Поддерживаемые области авторизации | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Чат | ||||||||
| Сообщение опубликовано или обновлено. |
|
| ||||||
| Реакция добавляется или удаляется, либо изменяется несколько реакций. |
|
| ||||||
| Членство создается, обновляется или удаляется, либо изменяется несколько членств. |
|
| ||||||
| Пространство обновляется или удаляется. |
|
| ||||||
| Google Встреча | ||||||||
| Конференция начинается или заканчивается. |
|
| ||||||
| Участник присоединяется к конференции или покидает ее. |
|
| ||||||
| Запись была создана. |
|
| ||||||
| Была создана стенограмма . |
|
| ||||||