REST Resource: spaces

Recurso: Espacio

Un espacio en Google Chat. Los espacios son conversaciones entre dos o más usuarios, o bien mensajes 1:1 entre un usuario y una app de Chat.

Representación JSON 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "importModeExpireTime": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
Campos
name

string

Identificador. Es el nombre del recurso del espacio.

Formato: spaces/{space}

Aquí, {space} representa el ID asignado por el sistema para el espacio. Puedes obtener el ID del espacio llamando al método spaces.list() o desde la URL del espacio. Por ejemplo, si la URL del espacio es https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, el ID del espacio es AAAAAAAAA.
type
(deprecated)

enum (Type)

Solo salida. Obsoleto: Usa spaceType en su lugar. Es el tipo de espacio.
spaceType

enum (SpaceType)

Opcional. Es el tipo de espacio. Se requiere cuando se crea un espacio o se actualiza el tipo de espacio. Solo salida para otros usos.
singleUserBotDm

boolean

Opcional. Indica si el espacio es un MD entre una app de Chat y una sola persona.
threaded
(deprecated)

boolean

Solo salida. Obsoleto: Usa spaceThreadingState en su lugar. Indica si los mensajes se agrupan en hilos en este espacio.
displayName

string

Opcional. Es el nombre visible del espacio. Se requiere cuando se crea un espacio con un spaceType de SPACE. Si recibes el mensaje de error ALREADY_EXISTS cuando creas un espacio o actualizas el displayName, prueba con otro displayName. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

En el caso de los mensajes directos, este campo puede estar vacío.

Admite hasta 128 caracteres.
externalUserAllowed

boolean

Opcional. Inmutable. Indica si este espacio permite que cualquier usuario de Google Chat sea miembro. Es la entrada cuando se crea un espacio en una organización de Google Workspace. Omite este campo cuando crees espacios en las siguientes condiciones:

  • El usuario autenticado usa una cuenta personal (cuenta de usuario no administrada). De forma predeterminada, un espacio creado por una cuenta de consumidor permite a cualquier usuario de Google Chat.

En el caso de los espacios existentes, este campo es solo de salida.
spaceThreadingState

enum (SpaceThreadingState)

Solo salida. Es el estado de los hilos en el espacio de Chat.
spaceDetails

object (SpaceDetails)

Opcional. Son los detalles del espacio, como la descripción y las reglas.
spaceHistoryState

enum (HistoryState)

Opcional. Es el estado del historial de mensajes y conversaciones en este espacio.
importMode

boolean

Opcional. Indica si este espacio se creó en Import Mode como parte de una migración de datos a Google Workspace. Mientras se importan los espacios, los usuarios no los pueden ver hasta que se complete la importación.

Para crear un espacio en Import Mode, se requiere la autenticación del usuario.
createTime

string (Timestamp format)

Opcional. Inmutable. Fecha y hora de creación de los espacios creados en Chat. Este campo es solo de salida, excepto cuando se usa en espacios en modo de importación.

En el caso de los espacios en modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el espacio en la fuente para conservar la hora de creación original.

Solo se propaga en el resultado cuando spaceType es GROUP_CHAT o SPACE.
lastActiveTime

string (Timestamp format)

Solo salida. Es la marca de tiempo del último mensaje en el espacio.
adminInstalled

boolean

Solo salida. En el caso de los espacios de mensajes directos (MD) con una app de Chat, indica si el espacio fue creado por un administrador de Google Workspace. Los administradores pueden instalar y configurar un mensaje directo con una app de Chat en nombre de los usuarios de su organización.

Para admitir la instalación por parte del administrador, tu app de Chat debe incluir la mensajería directa.
membershipCount

object (MembershipCount)

Solo salida. Es el recuento de las membresías a las que se unieron los usuarios, agrupadas por tipo de miembro. Se propaga cuando spaceType es SPACE, DIRECT_MESSAGE o GROUP_CHAT.
accessSettings

object (AccessSettings)

Opcional. Especifica el parámetro de configuración de acceso del espacio. Solo se propaga cuando spaceType es SPACE.
spaceUri

string

Solo salida. Es el URI para que un usuario acceda al espacio.
importModeExpireTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que el sistema borrará automáticamente el espacio si permanece en el modo de importación.

Cada espacio creado en el modo de importación debe salir de este modo antes de la fecha de vencimiento con spaces.completeImport.

Este campo solo se completa para los espacios que se crearon con el modo de importación.
customer

string

Opcional. Inmutable. Es el ID de cliente del dominio del espacio. Solo se requiere cuando se crea un espacio con autenticación de la app y SpaceType es SPACE. De lo contrario, no se debe configurar.

En el formato customers/{customer}, donde customer es el id del [recurso customer del SDK de Admin]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Las apps privadas también pueden usar el alias customers/my_customer para crear el espacio en la misma organización de Google Workspace que la app.

En el caso de los MD, este campo no se completa.
Campo de unión space_permission_settings. Representa la configuración de permisos de un espacio. Solo se propaga cuando space_type es SPACE. space_permission_settings solo puede ser uno de los siguientes:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Opcional. Solo entrada. Son parámetros de configuración de permisos de espacio predefinidos que solo se pueden ingresar cuando se crea un espacio. Si no se establece el campo, se crea un espacio de colaboración. Después de crear el espacio, se completará la configuración en el campo PermissionSettings.

La configuración de permisos predefinida admite lo siguiente:
permissionSettings

object (PermissionSettings)

Opcional. Es la configuración de permisos del espacio para los espacios existentes. Es la entrada para actualizar la configuración de permisos de espacio exactos, en la que se reemplaza la configuración de permisos existente. El resultado muestra la configuración de permisos actual.

La lectura y actualización de la configuración de permisos admite lo siguiente:

Tipo

Obsoleto: Usa SpaceType en su lugar.

Enumeraciones
TYPE_UNSPECIFIED Reservado.
ROOM Conversaciones entre dos o más personas
DM Mensaje directo 1:1 entre una persona y una app de Chat, en el que todos los mensajes son simples. Ten en cuenta que esto no incluye los mensajes directos entre dos personas.

SpaceType

Es el tipo de espacio. Se requiere cuando se crea o actualiza un espacio. Solo salida para otros usos.

Enumeraciones
SPACE_TYPE_UNSPECIFIED Reservado.
SPACE Un lugar donde las personas envían mensajes, comparten archivos y colaboran. Un SPACE puede incluir apps de Chat.
GROUP_CHAT Conversaciones grupales entre 3 o más personas Un GROUP_CHAT puede incluir apps de Chat.
DIRECT_MESSAGE Mensajes 1:1 entre dos personas o entre una persona y una app de Chat

SpaceThreadingState

Especifica el tipo de estado de subprocesos en el espacio de chat.

Enumeraciones
SPACE_THREADING_STATE_UNSPECIFIED Reservado.
THREADED_MESSAGES Espacios con nombre que admiten hilos de mensajes Cuando los usuarios responden un mensaje, pueden hacerlo en el mismo hilo, lo que mantiene su respuesta en el contexto del mensaje original.
GROUPED_MESSAGES Espacios con nombre en los que la conversación se organiza por tema Los temas y sus respuestas se agrupan.
UNTHREADED_MESSAGES Mensajes directos (MD) entre dos personas y conversaciones grupales entre 3 o más personas

SpaceDetails

Son los detalles del espacio, como la descripción y las reglas.

Representación JSON 
{
  "description": string,
  "guidelines": string
}
Campos
description

string

Opcional. Es una descripción del espacio. Por ejemplo, describe el tema de debate, el propósito funcional o los participantes del espacio.

Admite hasta 150 caracteres.
guidelines

string

Opcional. Las reglas, las expectativas y la etiqueta del espacio

Admite hasta 5,000 caracteres.

HistoryState

Es el estado del historial de mensajes y espacios. Especifica cuánto tiempo se conservan los mensajes y los hilos de conversación después de su creación.

Enumeraciones
HISTORY_STATE_UNSPECIFIED Valor predeterminado No lo utilices.
HISTORY_OFF Historial desactivado. Los mensajes y las conversaciones se conservan durante 24 horas.
HISTORY_ON El historial está activado. Las reglas de retención de Vault de la organización especifican por cuánto tiempo se conservan los mensajes y los subprocesos.

MembershipCount

Representa el recuento de membresías de un espacio, agrupadas en categorías.

Representación JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Campos
joinedDirectHumanUserCount

integer

Solo salida. Es el recuento de usuarios humanos que se unieron directamente al espacio, sin contar a los usuarios que se unieron por ser miembros de un grupo unido.
joinedGroupCount

integer

Solo salida. Es el recuento de todos los grupos que se unieron directamente al espacio.

AccessSettings

Representa el parámetro de configuración de acceso del espacio.

Representación JSON 
{
  "accessState": enum (AccessState),
  "audience": string
}
Campos
accessState

enum (AccessState)

Solo salida. Indica el estado de acceso del espacio.
audience

string

Opcional. Es el nombre del recurso del público objetivo que puede descubrir el espacio, unirse a él y obtener una vista previa de los mensajes que contiene. Si no se configura, solo los usuarios o los Grupos de Google que se hayan invitado o agregado individualmente al espacio podrán acceder a él. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para un público objetivo.

Formato: audiences/{audience}

Para usar el público objetivo predeterminado de la organización de Google Workspace, establece el valor en audiences/default.

La lectura del público objetivo admite lo siguiente:

Este campo no se propaga cuando se usa el alcance chat.bot con la autenticación de la app.

Para configurar el público objetivo, se requiere la autenticación del usuario.

AccessState

Representa el estado de acceso del espacio.

Enumeraciones
ACCESS_STATE_UNSPECIFIED El estado de acceso es desconocido o no se admite en esta API.
PRIVATE Solo los usuarios o los Grupos de Google que otros usuarios o administradores de Google Workspace hayan agregado o invitado de forma individual pueden descubrir el espacio y acceder a él.
DISCOVERABLE

El administrador del espacio otorgó acceso a un público objetivo al espacio. Los usuarios o los Grupos de Google que se agregaron o invitaron individualmente al espacio también pueden descubrirlo y acceder a él. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para usuarios específicos.

Para crear espacios detectables, se requiere la autenticación del usuario.

PredefinedPermissionSettings

Son parámetros de configuración de permisos predefinidos que solo puedes especificar cuando creas un espacio con nombre. Es posible que se agreguen más parámetros de configuración en el futuro. Para obtener detalles sobre la configuración de permisos para los espacios con nombre, consulta Obtén información sobre los espacios.

Enumeraciones
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Sin especificar. No lo uses.
COLLABORATION_SPACE Parámetro de configuración para convertir el espacio en un espacio de colaboración en el que todos los miembros pueden publicar mensajes.
ANNOUNCEMENT_SPACE Es el parámetro de configuración para convertir el espacio en un espacio de anuncios en el que solo los administradores del espacio pueden publicar mensajes.

PermissionSettings

Configuración de permisos que puedes especificar cuando actualizas un espacio con nombre existente.

Para establecer la configuración de permisos cuando crees un espacio, especifica el campo PredefinedPermissionSettings en tu solicitud.

Representación JSON 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Campos
manageMembersAndGroups

object (PermissionSetting)

Opcional. Es el parámetro de configuración para administrar miembros y grupos en un espacio.
modifySpaceDetails

object (PermissionSetting)

Opcional. Parámetro de configuración para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio.
toggleHistory

object (PermissionSetting)

Opcional. Es el parámetro de configuración para activar y desactivar el historial de espacios.
useAtMentionAll

object (PermissionSetting)

Opcional. Es el parámetro de configuración para usar @todos en un espacio.
manageApps

object (PermissionSetting)

Opcional. Es un parámetro de configuración para administrar apps en un espacio.
manageWebhooks

object (PermissionSetting)

Opcional. Es un parámetro de configuración para administrar webhooks en un espacio.
postMessages

object (PermissionSetting)

Solo salida. Es el parámetro de configuración para publicar mensajes en un espacio.
replyMessages

object (PermissionSetting)

Opcional. Es el parámetro de configuración para responder mensajes en un espacio.

PermissionSetting

Representa un parámetro de configuración de permiso de espacio.

Representación JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
Campos
managersAllowed

boolean

Opcional. Indica si los administradores de espacios tienen este permiso.
membersAllowed

boolean

Opcional. Indica si los miembros que no son administradores tienen este permiso.

Métodos

completeImport

 Completa el proceso de importación del espacio especificado y lo hace visible para los usuarios.

create

 Crea un espacio.

delete

 Borra un espacio con nombre.

findDirectMessage

 Devuelve el mensaje directo existente con el usuario especificado.

get

 Devuelve detalles sobre un espacio.

list

 Enumera los espacios de los que el llamador es miembro.

patch

 Actualiza un espacio.
Devuelve una lista de espacios en una organización de Google Workspace según la búsqueda de un administrador.

setup

 Crea un espacio y agrega a los usuarios especificados.