В этом документе содержится информация об авторизации и аутентификации, относящаяся к Google Workspace Events API. Прежде чем читать этот документ, ознакомьтесь с общей информацией об аутентификации и авторизации в Google Workspace в статье Об аутентификации и авторизации.
Как настроить OAuth 2.0 для авторизации
Настройте окно запроса доступа OAuth и выберите области действия, чтобы определить, какая информация будет показываться пользователям и проверяющим приложения, и зарегистрируйте приложение, чтобы опубликовать его позже.
Области действия Google Workspace Events API
Чтобы определить уровень доступа, предоставляемый вашему приложению, вам необходимо определить и объявить области авторизации. Область авторизации – это строка URI OAuth 2.0, которая содержит название приложения Google Workspace, тип данных, к которым оно получает доступ, и уровень доступа. Области действия – это запросы приложения на работу с данными Google Workspace, включая данные аккаунтов Google пользователей.
При установке приложения пользователю предлагается подтвердить области действия, используемые приложением. Как правило, следует выбирать наиболее узкую область действия и избегать запроса областей действия, которые не требуются вашему приложению. Пользователи охотнее предоставляют доступ к ограниченным и четко описанным областям.
Google Workspace Events API использует области действия из приложений Google Workspace, которые поддерживают подписки. Если в вашем приложении уже используются области действия, необходимые для подписки, вам не нужно добавлять области действия для использования Google Workspace Events API. Если вы добавляете области действия, выбирайте наименее конфиденциальные, которые позволяют вашему приложению работать. Подробнее о категориях областей действия…
В таблице ниже перечислены поддерживаемые области действия для Google Workspace Events API.
| Код области действия | Описание | Использование | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Позволяет приложениям для Chat просматривать чаты и отправлять сообщения. Предоставляет доступ ко всем функциям, доступным для приложений Chat. | Неконфиденциальные | ||
https://www.googleapis.com/auth/chat.memberships |
Просмотр, добавление и удаление участников чатов в Chat. | Конфиденциально |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Просмотр участников чатов в Google Chat | Конфиденциально |
||
https://www.googleapis.com/auth/chat.app.memberships |
Просмотр, добавление или удаление участников, а также обновление их списка в чатах и чат-группах в Chat в качестве приложения Chat. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Конфиденциально |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Просмотр участников чатов и чат-групп в Google Chat в качестве приложения Chat Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Конфиденциально |
||
https://www.googleapis.com/auth/chat.spaces |
Создание чатов и чат-групп, а также просмотр или обновление их метаданных (включая настройки сохранения истории) в Chat. | Деликатный контент | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Просмотр чата и чат-групп в Chat. | Конфиденциальные данные |
||
https://www.googleapis.com/auth/chat.app.spaces |
Создание чатов и чат-групп, а также просмотр и обновление их метаданных (включая настройки сохранения истории) в Chat в качестве приложения Chat. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Конфиденциально |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Просмотр метаданных (включая настройки сохранения истории) в Google Chat в качестве приложения Chat. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Конфиденциальные данные |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Просмотр, добавление и удаление откликов на сообщения в Chat. | Конфиденциально |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Просмотр откликов на сообщение в Chat. | Конфиденциально |
||
https://www.googleapis.com/auth/chat.messages |
Просмотр, создание, отправка, изменение и удаление сообщений, а также добавление, просмотр и удаление откликов на сообщения | Доступ ограничен | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Просмотр сообщений и откликов в Chat. | Доступ ограничен |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Просмотр сообщений и откликов в Chat от имени приложения Chat. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Доступ ограничен |
||
https://www.googleapis.com/auth/chat.users.readstate |
Просмотр и обновление статуса прочтения пользователя в Chat. | Конфиденциально |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Просмотр статуса прочтения пользователем в Chat. | Конфиденциально |
||
https://www.googleapis.com/auth/chat.users.availability |
Просмотр и изменение статуса в Chat. | Конфиденциально |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
Просмотр статуса в Chat. | Конфиденциально |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Просмотр метаданных всех чат-групп и чатов в Google Chat в вашей организации Google Workspace, даже если приложение Chat не добавлено в них как участник. Эта область действия поддерживается только для подписок клиентов. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Доступ ограничен | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
Просмотр всех участников чат-групп и чатов Google Chat в вашей организации Google Workspace, даже если приложение Chat не добавлено в них как участник. Эта область действия поддерживается только для подписок клиентов. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Доступ ограничен | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
Просматривать все сообщения и реакции в вашей организации Google Workspace, даже если приложение Chat не добавлено в чат-группу или чат как участник. Эта область действия поддерживается только для подписок клиентов. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Доступ ограничен | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Просмотр времени последнего прочтения сообщений каждого пользователя во всех чат-группах и чатах вашей организации Google Workspace, даже если приложение Chat не добавлено как участник. Эта область действия поддерживается только для подписок клиентов. Требуется одобрение администратора. Эта область действия поддерживает только аутентификацию приложений с сервисными аккаунтами. Вы не можете выполнить аутентификацию с учетными данными пользователя или с помощью делегирования доступа к данным в домене, используя эту область действия. |
Доступ ограничен | ||
| Google Диск | ||||
https://www.googleapis.com/auth/drive.file |
Создание новых файлов на Диске или изменение существующих, которые вы открываете с помощью приложения или которыми пользователь делится с приложением при использовании Google Picker API или окна выбора файлов в приложении. | Неконфиденциальные | ||
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 Meet | ||||
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 может потребовать, чтобы ваше приложение прошло проверку приложения в Справочном центре. Ознакомьтесь с часто задаваемыми вопросами о приложениях OAuth, чтобы определить, когда ваше приложение должно пройти проверку и какой тип проверки требуется. Ознакомьтесь с Условиями использования Google Диска.
Типы обязательной аутентификации
В этом разделе объясняется, какие типы аутентификации требуются или поддерживаются, и приводятся поддерживаемые области действия для каждого метода Google Workspace Events API.
Для подписок на события Chat Google Workspace Events API поддерживает аутентификацию пользователей и приложений для вызова некоторых методов. Если метод API поддерживает оба типа учетных данных, то от того, какой из них используется в вызове, зависит возвращаемый результат. Например, если вы вызываете метод subscriptions.list с аутентификацией пользователя, API возвращает список подписок, к которым у аутентифицированного пользователя есть доступ. Если вы используете аутентификацию приложения, API возвращает список подписок, к которым у приложения есть доступ. Подробнее о типах аутентификации в Chat…
В таблице ниже показано, какие области действия и типы аутентификации требуются или поддерживаются для каждого метода Google Workspace Events API.
| Метод | Требуется или поддерживается аутентификация пользователей | Поддерживается аутентификация приложений (только для приложений Chat). | Поддерживаемые области авторизации | |
|---|---|---|---|---|
| Как создать подписку | — |
При аутентификации пользователя требуется поддерживаемая область действия для каждого типа события:
С аутентификацией приложения и одобрением администратора (только для приложений Google Chat) требуется поддерживаемая область действия для каждого типа событий:
|
||
| Как оформить подписку |
При аутентификации пользователя для этого метода требуется область действия, которая поддерживает хотя бы один тип событий для подписки.
При аутентификации приложения (только для приложений Chat):
|
|||
| Просмотр подписок |
При аутентификации пользователя для этого метода требуется область действия, которая поддерживает хотя бы один тип событий для подписки.
При аутентификации приложения (только для приложений Chat):
|
|||
| Как изменить подписку | — |
При аутентификации пользователя требуется поддерживаемая область действия для каждого типа события:
При аутентификации приложения и одобрении администратора (только для приложений Google Chat) требуется поддерживаемая область действия для каждого типа событий:
|
||
| Как повторно активировать подписку | — |
При аутентификации пользователя требуется поддерживаемая область действия для каждого типа события:
При использовании аутентификации приложения и одобрения администратора (только для приложений Chat) требуется поддерживаемая область действия для каждого типа событий:
|
||
| Как удалить подписку |
При аутентификации пользователя для этого метода требуется область действия, которая поддерживает хотя бы один тип событий для подписки.
При аутентификации приложения (только для приложений Chat):
|
|||
Области действия по типам событий
При вызове Google Workspace Events API с использованием аутентификации пользователя необходимо указать одну или несколько областей действия, соответствующих типам событий подписки.
В таблице ниже показано, какие области авторизации поддерживаются для каждого типа событий.
| События | Типы событий | Поддерживаемые области авторизации | ||||||
|---|---|---|---|---|---|---|---|---|
| Chat | ||||||||
| Сообщение опубликовано или обновлено. |
|
Если выбрана аутентификация пользователя:
|
||||||
| Добавлена или удалена реакция, или изменено несколько реакций. |
|
При использовании аутентификации пользователей:
|
||||||
| Создано, обновлено или удалено участие или изменено несколько участий. |
|
Если выбрана аутентификация пользователя:
|
||||||
| Чат-группа обновлена или удалена. |
|
Если выбрана аутентификация пользователя:
|
||||||
| Статус прочитанной или непрочитанной чат-группы или статус прочитанной или непрочитанной цепочки пользователя обновлен. |
|
Если выбрана аутентификация пользователя:
|
||||||
| Обновлена информация о наличии. |
|
Если выбрана аутентификация пользователя:
|
||||||
| Диск | ||||||||
| Файл создан, изменен, перемещен, удален, переименован, помещен в корзину или удален из нее. |
|
|
||||||
| Создан или разрешен запрос на доступ к файлу. |
|
|
||||||
| Одобрение отменено, завершено, создано, сброшено, изменен список проверяющих или проверяющие ответили на запрос. |
|
|
||||||
| Комментарий создан, удален, изменен, повторно открыт или решен в файле. |
|
|
||||||
| Ответ на комментарий к файлу создан, удален или изменен. |
|
|
||||||
| Создано, удалено или изменено разрешение для файла. |
|
|
||||||
| Meet | ||||||||
| Начало или окончание конференции. |
|
|
||||||
| Участник присоединяется к видеовстрече или покидает ее. |
|
|
||||||
| Создана запись. |
|
|
||||||
| Была создана расшифровка. |
|
|
||||||