Crea un espacio y le agrega los usuarios especificados. El usuario que realiza la llamada se agrega automáticamente al espacio y no se debe especificar como una membresía en la solicitud. Para ver un ejemplo, consulta Configura un espacio con miembros iniciales.
Para especificar los miembros humanos que se agregarán, agrega membresías con el membership.member.name
adecuado. Para agregar un usuario humano, usa users/{user}
. {user}
puede ser la dirección de correo electrónico del usuario. Para los usuarios de la misma organización de Workspace, {user}
también puede ser el id
de la persona de la API de People o el id
del usuario de la API de Directory. Por ejemplo, si el ID de perfil de persona de la API de People para user@example.com
es 123456789
, puedes agregar el usuario al espacio configurando membership.member.name
en users/user@example.com
o users/123456789
.
En el caso de un espacio con nombre o chat en grupo, si el llamador bloquea, algunos miembros la bloquean o no tiene permiso para agregar a algunos miembros, esos miembros no se agregan al espacio creado.
Para crear un mensaje directo (MD) entre el usuario que llama y otro usuario humano, especifica exactamente una membresía que represente al usuario humano. Si un usuario bloquea al otro, la solicitud falla y no se crea el DM.
Para crear un MD entre el usuario que realiza la llamada y la app que realiza la llamada, establece Space.singleUserBotDm
en true
y no especifiques ninguna membresía. Solo puedes usar este método para configurar un MD con la app que realiza la llamada. Para agregar la app que realiza la llamada como miembro de un espacio o como MD existente entre dos usuarios humanos, consulta Cómo invitar o agregar un usuario o una app a un espacio.
Si ya existe un DM entre dos usuarios, incluso si uno bloquea al otro en el momento en que se realiza una solicitud, se devuelve el DM existente.
No se admiten espacios con respuestas en múltiples conversaciones. Si recibes el mensaje de error ALREADY_EXISTS
cuando configuras un espacio, prueba con otra displayName
. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.
Requiere la autenticación del usuario.
Solicitud HTTP
POST https://chat.googleapis.com/v1/spaces:setup
La URL usa la sintaxis de la transcodificación gRPC.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "space": { object ( |
Campos | |
---|---|
space |
Obligatorio. El campo Para crear un espacio, establece Para crear un chat en grupo, configura Para crear una conversación 1:1 entre personas, establece Para crear una conversación 1:1 entre una persona y la app de Chat que realiza la llamada, establece Si ya existe un espacio |
requestId |
Opcional. Un identificador único para esta solicitud. Se recomienda usar un UUID aleatorio. Si especificas un ID de solicitud existente, se muestra el espacio creado con ese ID en lugar de crear uno nuevo. Especificar un ID de solicitud existente desde la misma app de Chat con un usuario autenticado diferente muestra un error. |
memberships[] |
Opcional. Los usuarios de Google Chat a los que se invitará a unirse al espacio. Omite al usuario que realiza la llamada, ya que se agrega automáticamente. Actualmente, el conjunto permite hasta 20 membresías (además del llamador). Para la membresía humana, el campo Opcional cuando se configura Obligatorio cuando se configura Se requiere cuando se configura Debe estar vacío cuando se crea una conversación 1:1 entre una persona y la app de Chat que realiza la llamada (cuando se configura |
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Space
.
Alcances de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.create
Para obtener más información, consulta la guía de autorización.