Method: spaces.setup

Crea un espacio y le agrega usuarios específicos. El usuario que realiza la llamada se agrega automáticamente al espacio y no se debe especificar como miembro en la solicitud. Para ver un ejemplo, consulta Cómo configurar un espacio.

Para especificar los miembros humanos que se agregarán, agrega membresías con el member.name adecuado en SetUpSpaceRequest. Para agregar un usuario humano, usa users/{user}, donde {user} puede ser la dirección de correo electrónico del usuario. En el caso de 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 en la API de Directory. Por ejemplo, si el ID de perfil de persona de la API de Personas para user@example.com es 123456789, puedes agregar al usuario al espacio configurando membership.member.name como users/user@example.com o users/123456789.

En un espacio o chat en grupo, si el emisor bloquea o bloquea algunos miembros, esos miembros no se agregarán al espacio creado.

Para crear un mensaje directo (MD) entre el usuario que llama y otro usuario humano, especifica exactamente una membresía para representar al usuario humano. Si un usuario bloquea al otro, la solicitud falla y no se crea el MD.

Para crear un MD entre el usuario que realiza la llamada y la app que realiza la llamada, configura Space.singleUserBotDm como 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 MD existente entre dos usuarios humanos, consulta Crea una membresía.

Si ya existe un MD entre dos usuarios, incluso cuando uno bloquea al otro en el momento en que se realiza una solicitud, se muestra el MD existente.

No se admiten espacios con respuestas en múltiples conversaciones. Si recibes el mensaje de error ALREADY_EXISTS durante la configuración de un espacio, prueba con otro displayName. Es posible que un espacio existente de la organización de Google Workspace ya use este nombre visible.

Requiere la autenticación de usuarios.

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 (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Campos
space

object (Space)

Obligatorio. El campo Space.spaceType es obligatorio.

Para crear un espacio, establece Space.spaceType en SPACE y establece Space.displayName. Si recibes el mensaje de error ALREADY_EXISTS durante la configuración de un espacio, prueba con otro displayName. Es posible que un espacio existente de la organización de Google Workspace ya use este nombre visible.

Para crear un chat en grupo, establece Space.spaceType como GROUP_CHAT. No configures Space.displayName.

Para crear una conversación 1:1 entre personas, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en false. No configures Space.displayName ni Space.spaceDetails.

Para crear una conversación 1:1 entre una persona y la app de Chat que realiza la llamada, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true. No configures Space.displayName ni Space.spaceDetails.

Si ya existe un espacio DIRECT_MESSAGE, se muestra ese espacio en lugar de crear uno nuevo.
requestId

string

Opcional. Es 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. Si especificas un ID de solicitud existente en la misma app de Chat con otro usuario autenticado, se muestra un error.
memberships[]

object (Membership)

Opcional. Los usuarios de Google Chat a los que invitarás 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).

El campo Membership.member debe contener un user con name propagado (formato users/{user}) y un type configurado como User.Type.HUMAN. Durante la configuración de un espacio, solo puede agregar usuarios humanos (solo se pueden agregar apps de Chat en la configuración de mensajes directos con la app de llamadas). También puedes agregar miembros con el correo electrónico del usuario como alias para {user}. Por ejemplo, user.name puede ser users/example@gmail.com". Para invitar a usuarios de Gmail o usuarios de dominios externos de Google Workspace, el correo electrónico del usuario debe usarse para {user}.

Opcional cuando se establece Space.spaceType en SPACE.

Es obligatorio cuando se configura Space.spaceType como GROUP_CHAT, junto con al menos dos membresías.

Es obligatorio cuando se configura Space.spaceType como DIRECT_MESSAGE con un usuario humano, junto con exactamente una membresía.

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 establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true).

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Space.

Permisos de la 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.