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 ( |
Campos | |
---|---|
name |
Es el nombre del recurso del espacio. Formato: |
type |
Solo salida. Obsoleto: usa |
spaceType |
El tipo de espacio. Es obligatorio cuando se crea un espacio o se actualiza su tipo. Salida solo para otros usos. |
singleUserBotDm |
Opcional. Si el espacio es un MD entre una app de Chat y una sola persona |
threaded |
Solo salida. Obsoleto: usa |
displayName |
Es el nombre visible del espacio. Obligatorio cuando se crea un espacio. Si recibes el mensaje de error En el caso de los mensajes directos, este campo puede estar vacío. Admite hasta 128 caracteres. |
externalUserAllowed |
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:
Para los espacios existentes, este campo es solo de salida. |
spaceThreadingState |
Solo salida. El estado de las conversaciones en el espacio de Chat |
spaceDetails |
Detalles sobre el espacio, incluidas la descripción y las reglas. |
spaceHistoryState |
El estado del historial de mensajes de los mensajes y las conversaciones de este espacio. |
importMode |
Opcional. Indica si este espacio se crea en |
createTime |
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 |
lastActiveTime |
Solo salida. Marca de tiempo del último mensaje en el espacio. |
adminInstalled |
Solo salida. Para los espacios de mensajes directos (MD) con una app de Chat, ya sea que el espacio lo haya creado 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 del administrador, tu app de Chat debe incluir mensajería directa. |
membershipCount |
Solo salida. La cantidad de membresías unidas agrupadas por tipo de miembro. Se propaga cuando la |
accessSettings |
Opcional. Especifica la configuración de acceso del espacio. Solo se completa cuando el valor de |
spaceUri |
Solo salida. El URI del espacio. |
Tipo
Obsoleto: usa SpaceType
en su lugar.
Enumeradores | |
---|---|
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 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 |
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 |
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. |
MembershipCount
Representación JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Campos | |
---|---|
joinedDirectHumanUserCount |
Recuento de usuarios humanos que se unieron directamente al espacio, sin contar los usuarios que se unieron por formar parte de un grupo. |
joinedGroupCount |
Recuento de todos los grupos que se unieron directamente al espacio. |
AccessSettings
Representa la configuración de acceso del espacio.
Representación JSON |
---|
{
"accessState": enum ( |
Campos | |
---|---|
accessState |
Solo salida. Indica el estado de acceso del espacio. |
audience |
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 |
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 |
|
---|---|
|
Completa el proceso de importación para el espacio especificado y lo hace visible para los usuarios. |
|
Crea un espacio con nombre. |
|
Borra un espacio con nombre. |
|
Muestra el mensaje directo existente con el usuario especificado. |
|
Devuelve detalles sobre un espacio. |
|
Muestra una lista de los espacios de los que es miembro el emisor. |
|
Actualiza un espacio. |
|
|
|
Crea un espacio y le agrega los usuarios especificados. |