Этот документ содержит информацию об авторизации и аутентификации, специфичную для 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.app.memberships | Просматривайте, добавляйте, обновляйте и удаляйте участников из бесед и чат-групп в приложении 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.app.spaces | Создавайте беседы и чат-группы, а также просматривайте или обновляйте метаданные (включая настройки истории) в 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. | Ограниченный | ||
https://www.googleapis.com/auth/chat.app.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 | Разрешить приложениям считывать метаданные о любом месте проведения встреч, к которому у пользователя есть доступ. | Чувствительный | ||
Столбец «Использование» в предыдущей таблице указывает чувствительность каждой области в соответствии со следующими определениями:
Неконфиденциальные : эти области предоставляют минимальный объем доступа к авторизации и требуют только базовой проверки приложения. Подробнее об этом требовании см. в разделе «Требования к проверке» .
Конфиденциальные : эти области предоставляют доступ к определённым данным пользователя 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 App Verification . Ознакомьтесь с часто задаваемыми вопросами о приложении OAuth , чтобы определить, когда и какой тип проверки требуется для вашего приложения. См. также Условия использования Google Диска .
Типы требуемой аутентификации
В этом разделе объясняется, какие типы аутентификации требуются или поддерживаются, а также указаны поддерживаемые области для каждого метода 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):
| |||
| Обновить подписку | — | При аутентификации пользователя требуется поддерживаемая область для каждого типа событий :
Предварительный просмотр для разработчиков : с аутентификацией приложения и одобрением администратора (только приложения Google Chat), требуется поддерживаемая область для каждого типа событий :
| ||
| Повторно активировать подписку | — | При аутентификации пользователя требуется поддерживаемая область для каждого типа событий :
Предварительный просмотр для разработчиков : с аутентификацией приложения и одобрением администратора (только приложения Google Chat), требуется поддерживаемая область для каждого типа событий :
| ||
| Удалить подписку | При аутентификации пользователя этот метод требует области действия, которая поддерживает хотя бы один тип событий для подписки. С аутентификацией приложения (только приложения Google Chat):
| |||
Области действия по типу события
При вызове API событий Google Workspace с использованием аутентификации пользователя необходимо указать одну или несколько областей, соответствующих типам событий подписки.
В следующей таблице показано, какие области авторизации поддерживаются для каждого типа событий:
| События | Типы событий | Поддерживаемые области авторизации | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Чат | ||||||||
| Сообщение опубликовано или обновлено. |
| С аутентификацией пользователя :
| ||||||
| Добавляется или удаляется реакция , или изменяются несколько реакций. |
|
| ||||||
| Членство создается, обновляется или удаляется, или изменяются несколько членств. |
| С аутентификацией пользователя :
| ||||||
| Пространство обновлено или удалено. |
| С аутентификацией пользователя :
| ||||||
| Google Диск | ||||||||
| Файл создается, изменяется, перемещается, удаляется, помещается в корзину или удаляется из корзины. |
|
| ||||||
| Предложение о доступе создано или разрешено для файла. |
|
| ||||||
| Google Встреча | ||||||||
| Конференция начинается или заканчивается. |
|
| ||||||
| Участник присоединяется к конференции или покидает ее. |
|
| ||||||
| Была создана запись . |
|
| ||||||
| Была создана стенограмма . |
|
| ||||||