В этом руководстве объясняется, как использовать метод setUp() ресурса Space API Google Chat для создания пространства чата и добавления в него участников.
Ресурс Space представляет собой место, где пользователи и чат-приложения могут отправлять сообщения, обмениваться файлами и работать вместе. Существует несколько типов пространств:
- Прямые сообщения (ЛС) — это беседы между двумя пользователями или пользователем и приложением чата.
- Групповые чаты — это беседы между тремя и более пользователями и приложениями чата.
- Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.
Метод setUp() можно использовать для выполнения любого из следующих действий:
- Создайте именованное пространство с начальными участниками.
- Создайте прямое сообщение (DM) между двумя людьми.
- Настройте групповое сообщение между несколькими людьми.
При организации пространства учтите следующее:
- Вызывающий (аутентифицированный) пользователь автоматически добавляется в пространство, поэтому вам не нужно указывать членство пользователя в запросе.
- При создании прямого сообщения (DM), если DM существует между двумя пользователями, то DM возвращается. В противном случае DM создаётся.
- При создании группового чата, если ни одно из членств, указанных в запросе, не было успешно добавлено в групповой чат (например, из-за проблем с разрешениями), то может быть создан пустой групповой чат (включающий только вызывающего пользователя).
- Вы не сможете создавать пространства с цепочками ответов или добавлять людей за пределами вашей организации Google Workspace.
- Дублирующиеся данные о членстве (включая вызывающего пользователя), указанные в запросе, отфильтровываются, а не приводят к ошибке запроса.
- Когда администратор Google Workspace устанавливает приложение Chat для всей своей организации Google Workspace , Google Chat создаёт прямую переписку между установленным приложением Chat и каждым пользователем в организации, поэтому нет необходимости программно настраивать личные сообщения. Вместо этого вы можете перечислить все личные сообщения или найти личные сообщения, чтобы получить информацию о конкретном личном сообщении.
Предпосылки
Node.js
- Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Node.js.
- Создайте учётные данные OAuth-клиента для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учётные данные в виде JSON-файла с именем
credentials.jsonв локальном каталоге.
- Выберите область авторизации , поддерживающую аутентификацию пользователя.
Питон
- Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Установите клиентскую библиотеку Python Cloud .
- Создайте учётные данные OAuth-клиента для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учётные данные в виде JSON-файла с именем
credentials.jsonв локальном каталоге.
- Выберите область авторизации , поддерживающую аутентификацию пользователя.
Ява
- Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Установите клиентскую библиотеку Java Cloud .
- Создайте учётные данные OAuth-клиента для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учётные данные в виде JSON-файла с именем
credentials.jsonв локальном каталоге.
- Выберите область авторизации , поддерживающую аутентификацию пользователя.
Скрипт приложений
- Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Создайте автономный проект Apps Script и включите расширенную службу чата .
- Выберите область авторизации , поддерживающую аутентификацию пользователя.
Создайте пространство
Чтобы настроить пространство, укажите в запросе следующее:
- Укажите область авторизации
chat.spaces.createилиchat.spaces. - Вызовите метод
SetUpSpace(). - Передайте
spaceкак экземплярSpaceсо всеми необходимыми полями, такими какdisplayNameилиspaceType. - Передавайте
membershipsкак массив экземпляровMembership. Для каждого экземпляра:- Чтобы добавить пользователя-человека в качестве участника пространства, укажите значение
users/{user}, где{user}— это либо{person_id}personиз API People, либо идентификаторuserв API Directory. Например, еслиresourceNameпользователя в API People —people/123456789, вы можете добавить пользователя в пространство, указав членство сusers/123456789в качествеmember.name. - Укажите
groups/{group}, чтобы добавить группу в качестве участника пространства, где{group}— это идентификатор группы, для которой вы хотите создать членство. Идентификатор группы можно получить с помощью API Cloud Identity . Например, если API Cloud Identity возвращает группу с названиемgroups/123456789, то установите дляmembership.groupMember.nameзначениеgroups/123456789. Группы Google нельзя добавить в групповой чат или личные сообщения, можно добавить только в именованное пространство.
- Чтобы добавить пользователя-человека в качестве участника пространства, укажите значение
Чтобы создать DM между вызывающим пользователем и другим пользователем-человеком, укажите членство пользователя-человека в вашем запросе.
Чтобы создать DM между вызывающим пользователем и вызывающим приложением, установите для space.singleUserBotDm значение true и не указывайте никаких членств. Этот метод можно использовать только для создания DM с вызывающим приложением. Чтобы добавить вызывающее приложение в качестве участника пространства или существующей DM между двумя пользователями, см. раздел Создание членства .
В следующем примере создается именованное пространство и одно членство в пространстве для двух пользователей-людей (аутентифицированного пользователя и еще одного пользователя).
Node.js
Питон
Ява
Скрипт приложений
Чтобы запустить образец, замените следующее:
-
DISPLAY_NAME: отображаемое имя нового пространства. -
USER_NAME: идентификатор другого пользователя, для которого требуется включить членство.
Чтобы перейти в чат-группу, используйте идентификатор ресурса чат-группы для создания её URL-адреса. Идентификатор ресурса можно получить из name чат-группы в теле ответа Google Chat. Например, если name вашей чат-группы — spaces/1234567 , вы можете перейти в неё по следующему URL-адресу: https://mail.google.com/chat/u/0/#chat/space/1234567 .
Похожие темы
- Создайте пространство .
- Получите подробную информацию о пространстве .
- Список пробелов .
- Обновить пространство .
- Удалить пробел .
- Найдите место для прямых сообщений .
- Сделайте пространство видимым для определенных пользователей .