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 |
Identificador. Es el nombre del recurso del espacio. Formato: En el que |
type |
Solo salida. Obsoleto: Usa |
space |
Opcional. Es el tipo de espacio. Obligatorio cuando se crea un espacio o se actualiza el tipo de espacio. Solo salida para otro uso. |
single |
Opcional. Si el espacio es un MD entre una app de chat y una sola persona. |
threaded |
Solo salida. Obsoleto: Usa |
display |
Opcional. Es el nombre visible del espacio. Obligatorio cuando se crea un espacio con un En el caso de los mensajes directos, este campo puede estar vacío. Admite hasta 128 caracteres. |
external |
Opcional. Inmutable. Si este espacio permite que cualquier usuario de Google Chat sea miembro. Se ingresa 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. |
space |
Solo salida. El estado de los subprocesos en el espacio de Chat |
space |
Opcional. Detalles sobre el espacio, incluida la descripción y las reglas |
space |
Opcional. El estado del historial de mensajes de los mensajes y las conversaciones de este espacio. |
import |
Opcional. Si este espacio se crea en Para crear un espacio en |
create |
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 de modo de importación. En el caso de los espacios del 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 |
last |
Solo salida. Marca de tiempo del último mensaje en el espacio. |
admin |
Solo salida. En el caso de los espacios de mensajes directos (MD) con una app de Chat, si un administrador de Google Workspace creó el espacio. 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 de administrador, tu app de Chat debe incluir mensajes directos. |
membership |
Solo salida. Es el recuento de membresías unidas agrupadas por tipo de miembro. Se propaga cuando |
access |
Opcional. Especifica la configuración de acceso del espacio. Solo se propaga cuando |
space |
Solo salida. Es el URI que permite que un usuario acceda al espacio. |
customer |
Opcional. Inmutable. El ID de cliente del dominio del espacio. Solo es obligatorio cuando se crea un espacio con autenticación de apps y En el formato En el caso de los mensajes directos, este campo no se completa. |
Campo de unión Requiere autenticación del usuario. Las direcciones ( |
|
predefined |
Opcional. Solo entrada. Configuración predefinida de permisos del espacio, que se ingresa solo cuando se crea un espacio. Si no se establece el campo, se crea un espacio de colaboración. Después de crear el espacio, la configuración se propaga en el campo |
permission |
Opcional. Configuración de permisos de los espacios existentes Entrada para actualizar la configuración exacta de permisos de espacio, en la que se reemplaza la configuración de permisos existente. El resultado muestra la configuración de permisos actual. |
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 planos. Ten en cuenta que esto no incluye los mensajes directos entre dos personas. |
SpaceType
Es el tipo de espacio. Obligatorio cuando se crea o actualiza un espacio. Solo salida para otro uso.
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 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 conversaciones de mensajes Cuando los usuarios responden un mensaje, pueden hacerlo 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 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. 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 |
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 durante 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 durante 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 los subprocesos. |
MembershipCount
Representa el recuento de membresías de un espacio, agrupadas en categorías.
Representación JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Campos | |
---|---|
joined |
Solo salida. Es el recuento de usuarios humanos que se unieron directamente al espacio, sin contar a los usuarios que se unieron por tener membresía en un grupo al que se unieron. |
joined |
Solo salida. Es el 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 | |
---|---|
access |
Solo salida. Indica el estado de acceso del espacio. |
audience |
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. Si no se establece, solo podrán acceder al espacio los usuarios o los Grupos de Google a los que se haya invitado o agregado de forma individual. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para un público objetivo. Formato: Para usar el público objetivo predeterminado de la organización de Google Workspace, establece Leer el público objetivo permite lo siguiente:
Este campo no se propaga cuando se usa el alcance 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 |
Un administrador del espacio le otorgó acceso a un público objetivo. Los usuarios o Grupos de Google que se hayan agregado o invitado de forma individual 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
Es la configuración de permisos predefinida 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 de los espacios nombrados, consulta Obtén información sobre los espacios.
Enumeraciones | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Sin especificar. No lo uses. |
COLLABORATION_SPACE |
Es la configuración para hacer que el espacio sea de colaboración, en el que todos los miembros puedan publicar mensajes. |
ANNOUNCEMENT_SPACE |
Es la configuración para hacer que el espacio sea un espacio de anuncios en el que solo los administradores del espacio puedan 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 creas un espacio, especifica el campo PredefinedPermissionSettings
en tu solicitud.
Representación JSON |
---|
{ "manageMembersAndGroups": { object ( |
Campos | |
---|---|
manage |
Opcional. Configuración para administrar miembros y grupos en un espacio. |
modify |
Opcional. Configuración para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio |
toggle |
Opcional. Configuración para activar o desactivar el historial del espacio. |
use |
Opcional. Configuración para usar @todos en un espacio |
manage |
Opcional. Configuración para administrar apps en un espacio. |
manage |
Opcional. Configuración para administrar webhooks en un espacio. |
post |
Solo salida. Configuración para publicar mensajes en un espacio. |
reply |
Opcional. 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 | |
---|---|
managers |
Opcional. Si los administradores de espacios tienen este permiso |
members |
Opcional. Si los miembros que no son administradores tienen este permiso |
Métodos |
|
---|---|
|
Completa el proceso de importación del espacio especificado y lo hace visible para los usuarios. |
|
Crea un espacio sin miembros. |
|
Borra un espacio con nombre. |
|
Muestra el mensaje directo existente con el usuario especificado. |
|
Muestra los detalles de un espacio. |
|
Muestra una lista de los espacios de los que es miembro el llamador. |
|
Actualiza un espacio. |
|
Devuelve una lista de espacios en una organización de Google Workspace según la búsqueda de un administrador. |
|
Crea un espacio y agrega a los usuarios especificados. |