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