Создает пространство и добавляет в него указанных пользователей. Вызывающий пользователь автоматически добавляется в пространство и не должен указываться как член в запросе. Пример см. в разделе «Настройка пространства с первоначальными участниками» .
Чтобы указать добавляемых членов-людей, добавьте членство с соответствующим membership.member.name
. Чтобы добавить пользователя-человека, используйте users/{user}
, где {user}
может быть адресом электронной почты пользователя. Для пользователей в одной организации Workspace {user}
также может быть id
человека из API People или id
пользователя в API каталога. Например, если идентификатор профиля пользователя People API для user@example.com
— 123456789
, вы можете добавить пользователя в пространство, задав для membership.member.name
users/user@example.com
илиusers users/123456789
.
Если для именованного пространства или группового чата вызывающий абонент блокируется или заблокирован некоторыми участниками или не имеет разрешения на добавление некоторых участников, то эти участники не добавляются в созданное пространство.
Чтобы создать прямое сообщение (DM) между вызывающим пользователем и другим пользователем-человеком, укажите ровно одно членство, которое будет представлять пользователя-человека. Если один пользователь блокирует другого, запрос не выполняется и DM не создается.
Чтобы создать DM между вызывающим пользователем и вызывающим приложением, установите для Space.singleUserBotDm
значение true
и не указывайте членство. Вы можете использовать этот метод только для настройки DM с вызывающим приложением. Чтобы добавить вызывающее приложение в качестве участника пространства или существующего DM между двумя пользователями-людьми, см. Приглашение или добавление пользователя или приложения в пространство .
Если DM уже существует между двумя пользователями, даже если один пользователь блокирует другого во время запроса, тогда возвращается существующая DM.
Темы с цепочками ответов не поддерживаются. Если при настройке пространства вы получаете сообщение об ошибке ALREADY_EXISTS
, попробуйте другое displayName
. Возможно, это отображаемое имя уже используется в существующем пространстве в организации Google Workspace.
Требует аутентификации пользователя .
HTTP-запрос
POST https://chat.googleapis.com/v1/spaces:setup
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "space": { object ( |
Поля | |
---|---|
space | Необходимый. Поле Чтобы создать пространство, установите для Чтобы создать групповой чат, установите для Чтобы создать диалог 1:1 между людьми, установите для Чтобы создать диалог 1:1 между человеком и вызывающим приложением чата, установите для Если пространство |
requestId | Необязательный. Уникальный идентификатор этого запроса. Рекомендуется использовать случайный UUID. Указание существующего идентификатора запроса возвращает пространство, созданное с этим идентификатором, вместо создания нового пространства. Указание существующего идентификатора запроса из того же приложения чата с другим пользователем, прошедшим проверку подлинности, возвращает ошибку. |
memberships[] | Необязательный. Пользователи Google Chat, которых можно пригласить присоединиться к группе. Опустите вызывающего пользователя, поскольку он добавляется автоматически. В настоящее время набор допускает до 20 участников (помимо вызывающего абонента). Для человеческого членства поле Необязательно, если для Требуется при установке для Требуется при установке для Должно быть пустым при создании разговора 1:1 между человеком и вызывающим приложением чата (при установке для |
Тело ответа
В случае успеха тело ответа содержит экземпляр Space
.
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/chat.spaces
-
https://www.googleapis.com/auth/chat.spaces.create
Дополнительную информацию см. в руководстве по авторизации .