На этой странице представлен обзор того, как администраторы Google Workspace могут использовать API Google Chat для управления пространствами Google Chat в рамках своей организации.
Для управления пространствами чата администраторы Google Workspace могут использовать инструмент управления пространствами в консоли администратора Google или вызывать API Google Chat. Используя API Chat, администраторы могут создавать приложения Google Chat, которые управляют пространствами в больших масштабах и автоматизируют их распространенные или повторяющиеся задачи.
Что администраторы могут делать с API чата
Администратор может выполнять задачи управления в соответствии со своими назначенными ему ролями администратора .
Как администратор Google Workspace, вы можете выполнять ряд задач управления с помощью API чата, например, следующие:
- Поиск пространств на основе заданных критериев
- Список участников пространства
- Добавлять и удалять участников из пространства
- Получите подробную информацию об участнике и помещении.
- Обновить или удалить пробел
- Обновить членство пользователя
Как пройти аутентификацию и авторизацию в качестве администратора Google Workspace
При использовании API чата для задач управления администраторы могут аутентифицировать и авторизовать запросы, используя права администратора или настроив делегирование полномочий в масштабах всего домена для учетной записи службы приложения.
В таблице ниже описаны способы аутентификации администраторов при использовании API чата.
| Аутентификация пользователя | Кто вызывает метод API? | Что видят пользователи в чате |
|---|---|---|
| Права администратора | Администратор с useAdminAccess=true | «Администратор организации выполнил [действие]». Например: «Администратор организации назначил Кирана Б. менеджером по организации пространства». Она не идентифицирует имя пользователя-администратора, идентификатор пользователя или название приложения для чата. |
| Делегирование в масштабе всего домена | Сервисный аккаунт от имени пользователя | «[Пользователь] выполнил [действие] через [название приложения]». Например, «Саша Т. переименовала это пространство в «Обсуждение проекта релиза». Пользователь, от имени которого сервис выдает себя, идентифицируется как совершивший данное действие. |
Используйте API чата для вашей организации.
Примеры в этом разделе демонстрируют, как администраторы используют API чата при управлении пространствами своей организации и участниками с правами администратора .
Следующие методы API чата предоставляют права администратора с useAdminAccess=true .
-
spaces.delete -
spaces.get -
spaces.patch -
spaces.search -
spaces.members.create -
spaces.members.delete -
spaces.members.get -
spaces.members.list -
spaces.members.patch
Управление членством пользователей в пространстве
Ниже описаны способы, с помощью которых вы, как администратор Google Workspace, можете управлять членством пользователей в пространстве вашей организации с помощью API чата.
Добавить пользователей в пространства
С помощью spaces.members.create администраторы могут добавить пользователя в любое пространство в организации.
В сочетании с spaces.search администраторы могут добавлять пользователей в набор пространств, определяемый их поисковым запросом. Это может быть полезно при приеме на работу новых сотрудников в организацию; это позволяет администраторам автоматизировать рутинный процесс.
Найти пользователей и удалить их из пространств.
С помощью spaces.members.get администраторы могут определить, является ли пользователь (внутри организации или вне её) членом какого-либо пространства в организации.
В сочетании с spaces.search администраторы могут найти все пространства, в которых состоит пользователь, а затем удалить его из этих пространств с помощью spaces.members.delete . Это может быть полезно, когда сотрудники переходят в другие команды внутри организации или при увольнении сотрудников, которые больше не работают в организации; это позволяет администраторам автоматизировать рутинный процесс.
Повысить пользователей до должности менеджера по организации пространства.
С помощью spaces.members.patch администраторы могут изменить роль участника, обновив его MembershipRole , выбрав один из следующих вариантов:
-
ROLE_MEMBER: Участник пространства. В пользовательском интерфейсе чата эта роль называется Member . -
ROLE_ASSISTANT_MANAGER: Менеджер пространства. В пользовательском интерфейсе чата эта роль называется Manager . -
ROLE_MANAGER: Владелец пространства. В пользовательском интерфейсе чата эта роль называется Owner .
В сочетании с spaces.search администраторы могут находить пространства, у которых нет менеджера или владельца, а затем повышать статус существующего участника до менеджера или владельца с помощью spaces.members.patch .
Найти внешних участников пространства
Используя spaces.members.list , администраторы могут получить список участников пространства, получить профили пользователей из API People или Directory организации, а затем отфильтровать результаты, выбрав тех, кто является членами внешнего домена или организации. Для получения дополнительной информации см. раздел «Как чат идентифицирует пользователей» .
Проведение аудита и управление помещениями.
Ниже описаны способы, с помощью которых вы, как администратор Google Workspace, можете проводить аудит и управлять рабочими пространствами в вашей организации с помощью API чата.
Найти и удалить неактивные пространства
Неиспользуемые пространства чата могут занимать ценное место в памяти и создавать беспорядок в пользовательском интерфейсе. Администраторы могут использовать spaces.search для поиска неактивных пространств, а затем spaces.delete для их удаления. Дополнительные рекомендации и пример кода см. в разделе «Поиск и удаление неактивных пространств чата» .
Помещения для аудита в организации
С помощью spaces.search администраторы могут получить список всех пространств в организации с подробной информацией о настройках и метаданных каждого пространства, таких как дата создания, дата последней активности, количество участников, статус настройки истории и возможность приглашения внешних гостей.
Экспорт списка помещений на основе критериев поиска.
С помощью spaces.search администраторы могут получить список пространств, соответствующих критериям, указанным в query , и экспортировать результаты в CSV-файл для анализа.
Найти участников сообщества на основе критериев поиска
С помощью spaces.members.list администраторы могут получить список участников для любого пространства в организации и проанализировать результаты по определенным критериям.
Найдите управляющих помещением.
Используя spaces.members.list , администраторы могут получить список участников пространства, отфильтрованного по параметру MembershipState=ROLE_MANAGER .
Чтобы найти всех менеджеров пространств в вашей организации, во всех пространствах, вы можете использовать spaces.search для вывода их списка. Затем для каждого пространства в списке используйте spaces.members.list для получения менеджеров.
Связанные темы
- Аутентификация и авторизация с использованием прав администратора.
- Ищите и управляйте пространствами Google Chat с помощью Google Chat API, будучи администратором Google Workspace.
- метод
spaces.search