Method: spaces.setup

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}, en el que {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 para la persona de la API de People o el id del usuario en la API de Directory. Por ejemplo, si el ID del perfil de persona de la API de People para user@example.com es 123456789, puedes agregar al usuario al espacio configurando membership.member.name como users/user@example.com o users/123456789.

Para especificar los Grupos de Google que se agregarán, agrega membresías con el membership.group_member.name adecuado. Para agregar o invitar a un Grupo de Google, usa groups/{group}, donde {group} es la id para el grupo de la API de Groups de Cloud Identity. Por ejemplo, puedes usar la API de Cloud Identity Groups lookup para recuperar el ID 123456789 del correo electrónico de grupo group@example.com y, luego, agregar el grupo al espacio configurando membership.group_member.name como groups/123456789. No se admiten los correos electrónicos de grupo, y los Grupos de Google solo se pueden agregar como miembros en espacios con nombre.

En el caso de un espacio con nombre o un chat en grupo, si el emisor bloquea, algunos miembros lo bloquean o no tiene permiso para agregar a algunos miembros, esos miembros no se agregarán al espacio creado.

Para crear un mensaje directo (DM) 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. Si quieres agregar la app que realiza la llamada como miembro de un espacio o un MD existente entre dos usuarios humanos, consulta Cómo invitar o agregar a un usuario o una app a un espacio.

Si ya existe un DM entre dos usuarios, incluso cuando un usuario bloquea al otro en el momento en que se hace una solicitud, se devuelve el DM existente.

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

Se 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 (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 Space.displayName. Si recibes el mensaje de error ALREADY_EXISTS cuando configuras un espacio, prueba con otro displayName. Es posible que un espacio existente en la organización de Google Workspace ya use este nombre visible.

Para crear un chat en grupo, establece Space.spaceType en 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 un espacio nuevo. Si especificas un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se mostrará un error.
memberships[]

object (Membership)

Opcional. Los usuarios o grupos de Google Chat a los que se invitará a unirse al espacio. Omite al usuario que llama, 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 Membership.member debe contener un user con name propagado (formato: users/{user}) y type configurado como User.Type.HUMAN. Solo puedes agregar usuarios humanos cuando configuras un espacio (agregar apps de Chat solo se admite para 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 de {user}. Por ejemplo, user.name puede ser users/example@gmail.com. Para invitar a usuarios de Gmail o de dominios externos de Google Workspace, se debe usar el correo electrónico del usuario para {user}.

Para la pertenencia a un Grupo de Google, el campo Membership.group_member debe contener una group con name propagado (formato groups/{group}). Solo puedes agregar Grupos de Google si configuras Space.spaceType como SPACE.

Es 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 configuras 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.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.