Recurso: Espacio
Un espacio en Google Chat Los espacios son conversaciones entre dos o más usuarios, o mensajes 1:1 entre un usuario y una app de Chat.
Representación JSON |
---|
{ "name": string, "type": enum ( |
Campos | |
---|---|
name |
Nombre de recurso del espacio. Formato: Donde |
type |
Solo salida. Obsoleto: Usa |
spaceType |
Indica 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 |
El nombre visible del espacio. Es obligatorio cuando creas un espacio. Si recibes el mensaje de error Para los mensajes directos, este campo puede estar vacío. Admite hasta 128 caracteres. |
externalUserAllowed |
Inmutable. 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 de solo salida. |
spaceThreadingState |
Solo salida. El estado de la conversación en el espacio de Chat |
spaceDetails |
Detalles sobre el espacio, incluida la descripción y las reglas |
spaceHistoryState |
Es el estado del historial de mensajes de los mensajes y las conversaciones de este espacio. |
importMode |
Opcional. Si este espacio se crea en |
createTime |
Opcional. Inmutable. En el caso de los espacios creados en Chat, la hora a la que se creó el espacio. Este campo es solo de salida, excepto cuando se usa en espacios en modo de importación. Para 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 |
lastActiveTime |
Solo salida. Marca de tiempo del último mensaje en el espacio. |
adminInstalled |
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 de administradores, tu app de Chat debe incluir mensajes directos. |
membershipCount |
Solo salida. La cantidad de membresías unidas agrupadas por tipo de miembro. Se propaga cuando |
accessSettings |
Opcional. Especifica la configuración de acceso del espacio. Solo se completa cuando |
spaceUri |
Solo salida. Es el URI para que un usuario acceda al espacio. |
Campo de unión space_permission_settings . Representa la configuración de permisos de un espacio. Solo se completa cuando space_type es SPACE . space_permission_settings puede ser solo una de las siguientes opciones: |
|
predefinedPermissionSettings |
Opcional. Solo entrada. Configuración de permisos de espacios. Entrada para crear un espacio. Si no estableces este campo, se creará un espacio de colaboración. Una vez que crees el espacio, la configuración se completará en el campo |
permissionSettings |
Opcional. La configuración de permisos exacta, que se puede establecer para actualizar el espacio Entrada para actualizar un espacio. De lo contrario, solo muestra el resultado. Para crear espacios, usa |
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 la que todos los mensajes son planos. Ten en cuenta que esto no incluye los mensajes directos entre dos personas. |
SpaceType
Indica el tipo de espacio. Es obligatorio cuando se crea o actualiza un espacio. Salida solo 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 conversación en el espacio de Chat.
Enumeraciones | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Reservado. |
THREADED_MESSAGES |
Espacios con nombre que admiten conversaciones de mensajes Cuando los usuarios responden un mensaje, pueden hacerlo dentro de la conversación, lo que mantiene su respuesta en el contexto del mensaje original. |
GROUPED_MESSAGES |
Son 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
Detalles sobre el espacio, incluida 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 el protocolo del espacio. Admite hasta 5,000 caracteres. |
HistoryState
El estado del historial de los mensajes y espacios. Especifica cuánto tiempo se conservan los mensajes y las conversaciones 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 por 24 horas. |
HISTORY_ON |
Historial activado. Las reglas de retención de Vault de la organización especifican por cuánto tiempo se conservan 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 a 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. Es el nombre de 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 la estableces, solo podrán acceder a él los usuarios o Grupos de Google que se hayan invitado o agregado de forma individual al espacio. Para conocer más detalles, consulta Haz que un espacio sea detectable para el público objetivo. Formato: Para usar el usuario objetivo predeterminado de la organización de Google Workspace, establécelo en |
AccessState
Representa el estado de acceso del espacio.
Enumeraciones | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Se desconoce el estado del acceso o no se admite en esta API. |
PRIVATE |
Solo los usuarios o 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 |
Un administrador del espacio otorgó acceso al espacio a usuarios objetivo. Los usuarios o Grupos de Google que se hayan agregado o invitado de forma individual al espacio también podrán descubrirlo y acceder a él. Para obtener más información, consulta Haz que un espacio sea visible para usuarios específicos. |
PredefinedPermissionSettings
La configuración de permisos de espacio que 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 espacios con nombre, consulta Información sobre los espacios.
Enumeraciones | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Sin especificar. No usar. |
COLLABORATION_SPACE |
Parámetro de configuración para que el espacio sea de colaboración en el que todos los miembros puedan publicar mensajes. |
ANNOUNCEMENT_SPACE |
Parámetro de configuración para convertir este espacio en un espacio de anuncios en el que solo los administradores del espacio puedan publicar mensajes. |
PermissionSettings
Configuración de permisos para un espacio con nombre Para establecer la configuración de permisos cuando creas un espacio, especifica el campo PredefinedPermissionSettings
en la solicitud.
Representación JSON |
---|
{ "manageMembersAndGroups": { object ( |
Campos | |
---|---|
manageMembersAndGroups |
Parámetro de configuración para administrar los miembros y grupos de un espacio. |
modifySpaceDetails |
Parámetro de configuración para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio. |
toggleHistory |
Parámetro de configuración para activar y desactivar el historial de espacio. |
useAtMentionAll |
Parámetro de configuración para usar @todos en un espacio. |
manageApps |
Parámetro de configuración para administrar apps en un espacio. |
manageWebhooks |
Parámetro de configuración para administrar webhooks en un espacio. |
postMessages |
Solo salida. Parámetro de configuración para publicar mensajes en un espacio. |
replyMessages |
Parámetro de configuración para responder mensajes en un espacio. |
PermissionSetting
Representa un parámetro de configuración de permisos de espacio.
Representación JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
Campos | |
---|---|
managersAllowed |
Si los administradores de espacios tienen este permiso |
membersAllowed |
Indica si las personas que no son administradores tienen este permiso. |
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. |
|
Muestra detalles sobre un espacio. |
|
Enumera los espacios de los que es miembro el emisor. |
|
Actualiza un espacio. |
|
|
|
Crea un espacio y le agrega los usuarios especificados. |