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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
Campos
name

string

Es el nombre del recurso del espacio.

Formato: spaces/{space}

type
(deprecated)

enum (Type)

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

spaceType

enum (SpaceType)

El tipo de espacio. Es obligatorio cuando se crea un espacio o se actualiza su tipo. Salida solo para otros usos.

singleUserBotDm

boolean

Opcional. 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 como conversaciones en este espacio.

displayName

string

Es el nombre visible del espacio. Obligatorio cuando se crea un espacio. Si recibes el mensaje de error ALREADY_EXISTS cuando creas un espacio o actualizas displayName, prueba con otra 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

Inmutable. Indica si este espacio permite que cualquier usuario de Google Chat sea miembro. 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 utiliza una cuenta personal (cuenta de usuario no administrada). De forma predeterminada, los espacios creados por una cuenta personal permiten a cualquier usuario de Google Chat.

  • El espacio se utiliza para importar datos a Google Chat porque los espacios en el modo de importación solo deben permitir miembros de la misma organización de Google Workspace. Sin embargo, como parte del Programa de Versión preliminar para desarrolladores de Google Workspace, los espacios en modo de importación pueden permitir que cualquier usuario de Google Chat se pueda configurar con este campo para los espacios en modo de importación.

Para los espacios existentes, este campo es solo de salida.

spaceThreadingState

enum (SpaceThreadingState)

Solo salida. El estado de las conversaciones en el espacio de Chat

spaceDetails

object (SpaceDetails)

Detalles sobre el espacio, incluidas la descripción y las reglas.

spaceHistoryState

enum (HistoryState)

El estado del historial de mensajes de los mensajes y las conversaciones de este espacio.

importMode

boolean

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

createTime

string (Timestamp format)

Opcional. Inmutable. En el caso de los espacios creados en Chat, la hora en que se creó el espacio. 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 preservar la hora de creación original.

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

adminInstalled

boolean

Solo salida. Si un administrador de Google Workspace instaló la app de Chat. Los administradores pueden instalar una app de Chat para su dominio, unidad organizativa o un grupo de usuarios.

Los administradores solo pueden instalar apps de Chat para enviar mensajes directos entre los usuarios y la app. Para admitir la instalación de administradores, tu app debe incluir mensajería directa.

accessSettings

object (AccessSettings)

Opcional. Especifica la configuración de acceso del espacio. Solo se completa cuando el valor de spaceType es SPACE.

spaceUri

string

Solo salida. El URI del espacio.

Tipo

Obsoleto: usa SpaceType en su lugar.

Enumeradores
TYPE_UNSPECIFIED
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 planos. Ten en cuenta que esto no incluye los mensajes directos entre dos personas.

SpaceType

El tipo de espacio. Es obligatorio cuando se crea o actualiza un espacio. Salida solo para otros usos.

Enumeradores
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 una persona y una app de Chat

SpaceThreadingState

Especifica el tipo de estado de conversación en el espacio de Chat.

Enumeradores
SPACE_THREADING_STATE_UNSPECIFIED Reservado.
THREADED_MESSAGES Espacios con nombre que admiten conversaciones de mensajes. Cuando los usuarios responden un mensaje, pueden responder en la conversación, lo que mantiene su respuesta en el contexto del mensaje original.
GROUPED_MESSAGES Espacios con nombre en los que la conversación está organizada 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

Detalles sobre el espacio, incluidas 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 del espacio, el propósito funcional o los participantes.

Admite hasta 150 caracteres.

guidelines

string

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

Admite hasta 5,000 caracteres.

HistoryState

El estado del historial de los mensajes y espacios. Especifica por cuánto tiempo se conservan los mensajes y las conversaciones después de su creación.

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

AccessSettings

Representa la 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. El nombre del recurso del público objetivo que puede acceder al espacio. Establece este campo en un ID de público objetivo válido para que el espacio sea detectable o usa el alias audiences/default para configurarlo con el parámetro de configuración de acceso predeterminado en la Consola del administrador. Si quieres obtener más información, consulta Cómo hacer que un espacio sea detectable para un público objetivo. Anula este campo para restringir el espacio. Solo se completa cuando el espacio es detectable. Formato: audiences/{audience}, audiences/default puede usarse como alias del parámetro de configuración de uso compartido predeterminado de Chat.

AccessState

Representa el estado de acceso del espacio.

Enumeradores
ACCESS_STATE_UNSPECIFIED El estado de acceso es desconocido o no se admite en esta API.
PRIVATE Los miembros o grupos agregados o invitados pueden encontrar el espacio.
DISCOVERABLE El público objetivo seleccionado y los miembros o grupos agregados o invitados pueden encontrar el espacio.

Métodos

completeImport

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

create

Crea un espacio con nombre.

delete

Borra un espacio con nombre.

findDirectMessage

Muestra el mensaje directo existente con el usuario especificado.

get

Devuelve detalles sobre un espacio.

list

Muestra una lista de los espacios de los que es miembro el emisor.

patch

Actualiza un espacio.

setup

Crea un espacio y le agrega los usuarios especificados.