Package google.chat.v1

ButtonList

Una lista de botones.

ResponseType

Solo entrada. El tipo de respuesta de la app de Chat.

string

Solo entrada. Es la URL que los usuarios deben autenticar o configurar. (Solo para tipos de respuesta REQUEST_CONFIG).

DialogAction

Solo entrada. Es una respuesta a un evento de interacción relacionado con un diálogo. Debe ir acompañado de ResponseType.Dialog.

UpdatedWidget

Solo entrada. Es la respuesta del widget actualizado.

SelectionItem

Un array de objetos SelectionItem.

string

Es el ID del widget actualizado. El ID debe coincidir con el del widget que activó la solicitud de actualización.

SelectionItems

Lista de resultados del widget de autocompletado

Code

El código de estado.

string

Es el mensaje que se enviará a los usuarios sobre el estado de su solicitud. Si no se establece, se envía un mensaje genérico basado en status_code.

AnnotationType

Es el tipo de esta anotación.

int32

Es la longitud de la subcadena en el cuerpo del mensaje de texto sin formato a la que corresponde esta anotación.

int32

Es el índice de inicio (con base en 0 inclusive) en el cuerpo del mensaje de texto sin formato al que corresponde esta anotación.

UserMentionMetadata

Son los metadatos de la mención de un usuario.

SlashCommandMetadata

Los metadatos de un comando de barra.

RichLinkMetadata

Son los metadatos de un vínculo enriquecido.

string

Solo salida. Es la URL que aloja la imagen GIF.

string

Opcional. Es el nombre del recurso del archivo adjunto, con el formato spaces/{space}/messages/{message}/attachments/{attachment}.

string

Solo salida. Es el nombre de archivo original del contenido, no la ruta de acceso completa.

string

Solo salida. Es el tipo de contenido (tipo MIME) del archivo.

string

Solo salida. Es la URL de la miniatura que se debe usar para obtener una vista previa del archivo adjunto para un usuario humano. Las apps de chat no deben usar esta URL para descargar el contenido de los archivos adjuntos.

string

Solo salida. Es la URL de descarga que se debe usar para permitir que un usuario humano descargue el archivo adjunto. Las apps de chat no deben usar esta URL para descargar el contenido de los archivos adjuntos.

Source

Solo salida. Es la fuente del archivo adjunto.

AttachmentDataRef

Opcional. Es una referencia a los datos del archivo adjunto. Este campo se usa para crear o actualizar mensajes con archivos adjuntos, o con la API de Media para descargar los datos de los archivos adjuntos.

DriveDataRef

Solo salida. Es una referencia al archivo adjunto de Google Drive. Este campo se usa con la API de Google Drive.

string

Opcional. Es el nombre del recurso de los datos del archivo adjunto. Este campo se usa con la API de Media para descargar los datos del archivo adjunto.

string

Opcional. Es un token opaco que contiene una referencia a un archivo adjunto subido. Los clientes lo tratan como una cadena opaca y lo usan para crear o actualizar mensajes de Chat con archivos adjuntos.

string

Obligatorio si el mensaje contiene varias tarjetas. Es un identificador único para una tarjeta en un mensaje.

Card

Una tarjeta El tamaño máximo es de 32 KB.

string

Es el espacio del recurso de espacio de Chat vinculado.

Formato: spaces/{space}

string

Es el subproceso del recurso del espacio de Chat vinculado.

Formato: spaces/{space}/threads/{thread}

string

Es el mensaje del recurso de espacio de Chat vinculado.

Formato: spaces/{space}/messages/{message}

string

Obligatorio. Es el nombre del recurso del espacio del modo de importación.

Formato: spaces/{space}

Space

El espacio del modo de importación.

CardHeader

Es el encabezado de la tarjeta. Por lo general, un encabezado contiene un título y una imagen.

Section

Las secciones están separadas por un divisor de línea.

CardAction

Las acciones de esta tarjeta.

string

Es el nombre de la tarjeta.

string

La etiqueta solía mostrarse en el elemento del menú de acciones.

OnClick

Es la acción onclick de este elemento de acción.

string

Se debe especificar el título. El encabezado tiene una altura fija: si se especifican un título y un subtítulo, cada uno ocupa una línea. Si solo se especifica el título, ocupa ambas líneas.

string

Es el subtítulo del encabezado de la tarjeta.

ImageStyle

Es el tipo de imagen (por ejemplo, borde cuadrado o borde circular).

string

Es la URL de la imagen en el encabezado de la tarjeta.

string

Es el encabezado de la sección. Se admite el texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.

WidgetMarkup

Una sección debe contener al menos un widget.

CustomEmoji

Obligatorio. El emoji personalizado que se creará.

string

Obligatorio. Es el nombre del recurso del espacio para el que se creará la membresía.

Formato: spaces/{space}

Membership

Obligatorio. La relación de membresía que se creará.

El campo memberType debe contener un usuario con los campos user.name y user.type propagados. El servidor asignará un nombre de recurso y reemplazará todo lo que se especifique.

Cuando una app de chat crea una relación de membresía para un usuario humano, debe usar ciertos permisos de autorización y establecer valores específicos para ciertos campos:

• Cuando te autenticas como usuario, se requiere el permiso de autorización chat.memberships.

• Cuando te autenticas como una app, se requiere el permiso de autorización chat.app.memberships. La autenticación como app está disponible en

• Establece user.type en HUMAN y user.name con el formato users/{user}, donde {user} puede ser la dirección de correo electrónico del usuario. Para los usuarios de la misma organización de Workspace, {user} también puede ser el id de la persona de la API de Personas o el id del usuario en la API de Directory. Por ejemplo, si el ID de perfil de la persona de la API de People para user@example.com es 123456789, puedes agregar al usuario al espacio configurando membership.member.name como users/user@example.com o users/123456789.

Para invitar a usuarios externos a la organización de Workspace propietaria del espacio, se requiere la autenticación del usuario.

Cuando una app de Chat crea una relación de membresía para sí misma, debe autenticarse como un usuario y usar el permiso chat.memberships.app, establecer user.type en BOT y establecer user.name en users/app.

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.memberships.

No se admite la creación de membresías de apps ni de membresías para usuarios fuera de la organización de Google Workspace del administrador con el acceso de administrador.

string

Obligatorio. Es el nombre del recurso del espacio en el que se creará un mensaje.

Formato: spaces/{space}

Message

Obligatorio. Cuerpo del mensaje.

string

Opcional. Obsoleto: Usa thread.thread_key en su lugar. Es el ID del subproceso. Admite hasta 4,000 caracteres. Para iniciar una conversación o agregarla a una existente, crea un mensaje y especifica un threadKey o el thread.name. Para ver un ejemplo de uso, consulta Cómo iniciar o responder una conversación de mensajes.

string

Opcional. Un ID de solicitud único para este mensaje. Si especificas un ID de solicitud existente, se muestra el mensaje creado con ese ID en lugar de crear uno nuevo.

MessageReplyOption

Opcional. Especifica si un mensaje inicia una conversación o responde una. Solo se admite en espacios con nombre.

Cuando respondes a las interacciones del usuario, se ignora este campo. En el caso de las interacciones dentro de una conversación, la respuesta se crea en la misma conversación. De lo contrario, la respuesta se crea como un subproceso nuevo.

string

Opcional. Un ID personalizado para un mensaje. Permite que las apps de Chat obtengan, actualicen o borren un mensaje sin necesidad de almacenar el ID asignado por el sistema en el nombre del recurso del mensaje (representado en el campo name del mensaje).

El valor de este campo debe cumplir con los siguientes requisitos:

• Comienza con client-. Por ejemplo, client-custom-name es un ID personalizado válido, pero custom-name no lo es.
• Contiene hasta 63 caracteres y solo letras minúsculas, números y guiones.
• Es único dentro de un espacio. Una app de chat no puede usar el mismo ID personalizado para diferentes mensajes.

Para obtener más información, consulta Cómo asignar un nombre a un mensaje.

string

Obligatorio. Es el mensaje en el que se crea la reacción.

Formato: spaces/{space}/messages/{message}

Reaction

Obligatorio. La reacción que se creará.

Space

Obligatorio. Se deben propagar los campos displayName y spaceType. Solo se admiten SpaceType.SPACE y SpaceType.GROUP_CHAT. SpaceType.GROUP_CHAT solo se puede usar si importMode se establece como verdadero.

Si recibes el mensaje de error ALREADY_EXISTS, prueba con otro displayName. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

El espacio name se asigna en el servidor, por lo que se ignorará todo lo que se especifique en este campo.

string

Opcional. Es un identificador único para esta solicitud. Se recomienda usar un UUID aleatorio. Si especificas un ID de solicitud existente, se muestra el espacio creado con ese ID en lugar de crear uno nuevo. Si especificas un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se muestra un error.

string

Identificador. Es el nombre del recurso del emoji personalizado que asigna el servidor.

Formato: customEmojis/{customEmoji}

string

Solo salida. Es la clave única del recurso de emoji personalizado.

string

Opcional. Inmutable. Es el nombre que proporciona el usuario para el emoji personalizado, que es único dentro de la organización.

Es obligatorio cuando se crea el emoji personalizado; de lo contrario, solo se muestra la salida.

Los nombres de los emojis deben comenzar y terminar con dos puntos, deben escribirse en minúsculas y solo pueden incluir caracteres alfanuméricos, guiones y guiones bajos. Los guiones y guiones bajos deben usarse para separar palabras y no pueden usarse consecutivamente.

Ejemplo: :valid-emoji-name:

string

Solo salida. La URL de la imagen del emoji personalizado, válida durante al menos 10 minutos Ten en cuenta que no se propaga en la respuesta cuando se crea el emoji personalizado.

CustomEmojiPayload

Opcional. Solo entrada. Datos de carga útil Obligatorio cuando se crea el emoji personalizado.

bytes

Obligatorio. Solo entrada. Es la imagen que se usa para el emoji personalizado.

La carga útil debe ser inferior a 256 KB y la dimensión de la imagen debe ser de entre 64 y 500 píxeles. Las restricciones están sujetas a cambios.

string

Obligatorio. Solo entrada. Es el nombre del archivo de imagen.

Extensiones de archivo compatibles: .png, .jpg, .gif.

string

Obligatorio. Es el nombre del recurso del emoji personalizado que se borrará.

Formato: customEmojis/{customEmoji}

Puedes usar el nombre del emoji como alias para {customEmoji}. Por ejemplo, customEmojis/:example-emoji:, en la que :example-emoji: es el nombre del emoji personalizado.

string

Obligatorio. Es el nombre del recurso de la membresía que se borrará. Las apps de chat pueden borrar las membresías de los usuarios humanos o las propias. Las apps de chat no pueden borrar las membresías de otras apps.

Cuando se borra una membresía humana, se requiere el alcance chat.memberships y el formato spaces/{space}/members/{member}. Puedes usar el correo electrónico como alias para {member}. Por ejemplo, spaces/{space}/members/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.

Cuando se borra una membresía de la app, se requiere el alcance chat.memberships.app y el formato spaces/{space}/members/app.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app.

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.memberships.

No se admite la eliminación de membresías de apps en un espacio con acceso de administrador.

string

Obligatorio. Es el nombre del recurso del mensaje.

Formato: spaces/{space}/messages/{message}

Si estableciste un ID personalizado para tu mensaje, puedes usar el valor del campo clientAssignedMessageId para {message}. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.

bool

Opcional. Cuando true, borrar un mensaje también borra sus respuestas en el subproceso. Cuando false, si un mensaje tiene respuestas en una conversación, la eliminación falla.

Solo se aplica cuando se autentica como usuario. No tiene efecto cuando se autentica como una app de chat.

string

Obligatorio. Es el nombre de la reacción que se borrará.

Formato: spaces/{space}/messages/{message}/reactions/{reaction}

string

Obligatorio. Es el nombre del recurso del espacio que se borrará.

Formato: spaces/{space}

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.delete.

DeletionType

Indica quién borró el mensaje.

Card

Solo entrada. Es el cuerpo del diálogo, que se renderiza en un elemento modal. Las apps de Google Chat no admiten las siguientes entidades de tarjetas: DateTimePicker y OnChangeAction.

ActionStatus

Solo entrada. Es el estado de una solicitud para invocar o enviar un diálogo. Muestra un estado y un mensaje a los usuarios, si es necesario. Por ejemplo, en caso de error o éxito.

Dialog

Solo entrada. Diálogo para la solicitud.

string

El ID del archivo de Drive. Se usa con la API de Drive.

DriveDataRef

Un DriveDataRef que hace referencia a un archivo de Google Drive.

string

Es el tipo MIME del recurso de Google Drive vinculado.

string

Opcional. Un emoji básico representado por una cadena Unicode.

CustomEmoji

Solo salida. Un emoji personalizado

Emoji

Solo salida. Emoji asociado con las reacciones.

int32

Solo salida. Es la cantidad total de reacciones con el emoji asociado.

string

Obligatorio. Es el nombre del recurso del usuario con el que se busca el mensaje directo.

Formato: users/{user}, donde {user} es el id de la persona de la API de People o el id del usuario en la API de Directory. Por ejemplo, si el ID de perfil de la API de People es 123456789, puedes encontrar un mensaje directo con esa persona usando users/123456789 como name. Cuando te autentiques como usuario, podrás usar el correo electrónico como alias para {user}. Por ejemplo, users/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.

string

Obligatorio. Es el nombre del recurso del archivo adjunto, con el formato spaces/{space}/messages/{message}/attachments/{attachment}.

string

Obligatorio. Es el nombre del recurso del emoji personalizado.

Formato: customEmojis/{customEmoji}

Puedes usar el nombre del emoji como alias para {customEmoji}. Por ejemplo, customEmojis/:example-emoji:, en la que :example-emoji: es el nombre del emoji personalizado.

string

Obligatorio. Es el nombre del recurso de la membresía que se recuperará.

Para obtener la membresía de la app mediante la autenticación del usuario, puedes usar spaces/{space}/members/app de forma opcional.

Formato: spaces/{space}/members/{member} o spaces/{space}/members/app

Puedes usar el correo electrónico del usuario como alias para {member}. Por ejemplo, spaces/{space}/members/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere los permisos de OAuth 2.0 chat.admin.memberships o chat.admin.memberships.readonly.

No se admiten membresías de apps en un espacio cuando se usa el acceso de administrador.

string

Obligatorio. Es el nombre del recurso del mensaje.

Formato: spaces/{space}/messages/{message}

Si estableciste un ID personalizado para tu mensaje, puedes usar el valor del campo clientAssignedMessageId para {message}. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.

string

Obligatorio. Es el nombre del recurso del evento de espacio.

Formato: spaces/{space}/spaceEvents/{spaceEvent}

string

Obligatorio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting

• users/me/spaces/{space}/spaceNotificationSetting, O
• users/user@example.com/spaces/{space}/spaceNotificationSetting, O
• users/123456789/spaces/{space}/spaceNotificationSetting. Nota: Solo se permite el ID de usuario o el correo electrónico del llamador en la ruta.

string

Obligatorio. Es el nombre del recurso del estado de lectura del espacio que se recuperará.

Solo admite obtener el estado de lectura del usuario que realiza la llamada.

Para hacer referencia al usuario que llama, establece una de las siguientes opciones:

• El alias me. Por ejemplo, users/me/spaces/{space}/spaceReadState

• Su dirección de correo electrónico de Workspace Por ejemplo, users/user@example.com/spaces/{space}/spaceReadState.

• Su ID de usuario Por ejemplo, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState

string

Obligatorio. Es el nombre del recurso del espacio, con el formato spaces/{space}.

Formato: spaces/{space}

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere los permisos de OAuth 2.0 chat.admin.spaces o chat.admin.spaces.readonly.

string

Obligatorio. Es el nombre del recurso del estado de lectura del subproceso que se recuperará.

Solo admite obtener el estado de lectura del usuario que realiza la llamada.

Para hacer referencia al usuario que llama, establece una de las siguientes opciones:

• El alias me. Por ejemplo, users/me/spaces/{space}/threads/{thread}/threadReadState

• Su dirección de correo electrónico de Workspace Por ejemplo, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

• Su ID de usuario Por ejemplo, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState

string

Es el nombre de recurso de un Grupo de Google.

Representa un grupo en la API de Grupos de Cloud Identity.

Formato: groups/{group}

int32

Opcional. Es la cantidad máxima de emojis personalizados que se devuelven. El servicio puede mostrar menos emojis personalizados que este valor. Si no se especifica, el valor predeterminado es 25. El valor máximo es 200; los valores superiores a 200 se cambian a 200.

string

Opcional. (si se reanuda desde una consulta anterior).

Un token de página recibido de una llamada anterior a emojis personalizados de la lista. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.

string

Opcional. Un filtro de consulta

Admite el filtrado por creador.

Para filtrar por creador, debes especificar un valor válido. Actualmente, solo se aceptan creator("users/me") y NOT creator("users/me") para filtrar emojis personalizados según si el usuario que realiza la llamada los creó o no.

Por ejemplo, la siguiente consulta muestra el emoji personalizado que creó el llamador:

creator("users/me")

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

CustomEmoji

Lista sin ordenar. Es la lista de emojis personalizados en la página solicitada (o primera).

string

Es un token que puedes enviar como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

string

Obligatorio. Es el nombre del recurso del espacio para el que se recuperará una lista de membresías.

Formato: spaces/{space}

int32

Opcional. Es la cantidad máxima de membresías que se mostrarán. Es posible que el servicio devuelva menos de este valor.

Si no se especifica, se devuelven, como máximo, 100 membresías.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.

string

Opcional. Es un token de página, recibido desde una llamada anterior para enumerar membresías. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.

string

Opcional. Un filtro de consulta

Puedes filtrar las membresías por el rol (role) y el tipo (member.type) de un miembro.

Para filtrar por rol, establece role en ROLE_MEMBER o ROLE_MANAGER.

Para filtrar por tipo, establece member.type en HUMAN o BOT. También puedes filtrar member.type con el operador !=.

Para filtrar por rol y tipo, usa el operador AND. Para filtrar por rol o tipo, usa el operador OR.

Se requiere member.type = "HUMAN" o member.type != "BOT" cuando use_admin_access se establece como verdadero. Se rechazarán los demás filtros de tipo de miembro.

Por ejemplo, las siguientes consultas son válidas:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Las siguientes consultas no son válidas:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

bool

Opcional. Cuando es true, también muestra las membresías asociadas con un Google Group, además de otros tipos de membresías. Si se establece un filter, no se muestran las membresías de Google Group que no coinciden con los criterios del filtro.

bool

Opcional. Cuando es true, también muestra las membresías asociadas con los miembros invited, además de otros tipos de membresías. Si se establece un filtro, no se muestran las membresías de invited que no coinciden con los criterios del filtro.

Actualmente, requiere autenticación del usuario.

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el alcance de OAuth 2.0 chat.admin.memberships.readonly o chat.admin.memberships.

No se admiten las membresías de apps en un espacio cuando se usa el acceso de administrador.

Membership

Lista sin ordenar. Es la lista de membresías en la página solicitada (o primera).

string

Es un token que puedes enviar como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

string

Obligatorio. Es el nombre del recurso del espacio desde el que se mostrarán los mensajes.

Formato: spaces/{space}

int32

Opcional. Es la cantidad máxima de mensajes que se devuelven. Es posible que el servicio devuelva menos mensajes que este valor.

Si no se especifica, se mostrarán como máximo 25.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.

string

Opcional. Un token de página recibido de una llamada a listMessages anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.

string

Opcional. Un filtro de consulta

Puedes filtrar los mensajes por fecha (create_time) y conversación (thread.name).

Para filtrar mensajes por la fecha en que se crearon, especifica el create_time con una marca de tiempo en formato RFC-3339 y comillas dobles. Por ejemplo, "2023-04-21T11:30:00-04:00". Puedes usar el operador mayor que > para enumerar los mensajes que se crearon después de una marca de tiempo o el operador menor que < para enumerar los mensajes que se crearon antes de una marca de tiempo. Para filtrar mensajes dentro de un intervalo de tiempo, usa el operador AND entre dos marcas de tiempo.

Para filtrar por subproceso, especifica el thread.name con el formato spaces/{space}/threads/{thread}. Solo puedes especificar una thread.name por consulta.

Para filtrar por conversación y fecha, usa el operador AND en tu consulta.

Por ejemplo, las siguientes consultas son válidas:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

string

Opcional. Indica cómo se ordena la lista de mensajes. Especifica un valor para ordenar según una operación de ordenamiento. Los valores válidos de la operación de ordenamiento son los siguientes:

• ASC para ascendente.

• DESC para descendente.

El orden predeterminado es create_time ASC.

bool

Opcional. Indica si se deben incluir los mensajes borrados. Los mensajes borrados incluyen la hora de eliminación y metadatos sobre la eliminación, pero el contenido del mensaje no está disponible.

Message

Lista de mensajes.

string

Puedes enviar un token como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

string

Obligatorio. El mensaje al que reaccionaron los usuarios

Formato: spaces/{space}/messages/{message}

int32

Opcional. Es la cantidad máxima de reacciones que se devuelven. El servicio puede mostrar menos reacciones que este valor. Si no se especifica, el valor predeterminado es 25. El valor máximo es 200; los valores superiores a 200 se cambian a 200.

string

Opcional. (si se reanuda desde una consulta anterior).

Un token de página recibido de una llamada a list reactions anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.

string

Opcional. Un filtro de consulta

Puedes filtrar las reacciones por emoji (emoji.unicode o emoji.custom_emoji.uid) y usuario (user.name).

Para filtrar reacciones de varios emojis o usuarios, une campos similares con el operador OR, como emoji.unicode = "🙂" OR emoji.unicode = "👍" y user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Para filtrar reacciones por emoji y usuario, usa el operador AND, como emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Si tu consulta usa AND y OR, agrúpalos con paréntesis.

Por ejemplo, las siguientes consultas son válidas:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Las siguientes consultas no son válidas:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

Reaction

Es la lista de reacciones en la página solicitada (o primera).

string

Es un token de Continuation para recuperar la siguiente página de resultados. Está vacía para la última página de resultados.

string

Obligatorio. Es el nombre del recurso del espacio de Google Chat en el que ocurrieron los eventos.

Formato: spaces/{space}.

int32

Opcional. Es la cantidad máxima de eventos de espacio que se devuelven. Es posible que el servicio devuelva menos de este valor.

Los valores negativos muestran un error INVALID_ARGUMENT.

string

Opcional. Es un token de página, recibido desde una llamada a eventos de espacio de lista anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados a los eventos de lista de espacios deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.

string

Obligatorio. Un filtro de consulta

Debes especificar al menos un tipo de evento (event_type) con el operador tiene :. Para filtrar por varios tipos de eventos, usa el operador OR. Omite los tipos de eventos por lotes en tu filtro. La solicitud muestra automáticamente todos los eventos de lotes relacionados. Por ejemplo, si filtras por reacciones nuevas (google.workspace.chat.reaction.v1.created), el servidor también muestra eventos de reacciones nuevas por lotes (google.workspace.chat.reaction.v1.batchCreated). Para obtener una lista de los tipos de eventos admitidos, consulta la documentación de referencia de SpaceEvents.

De manera opcional, también puedes filtrar por hora de inicio (start_time) y hora de finalización (end_time):

• start_time: Es una marca de tiempo exclusiva desde la que se comienzan a enumerar los eventos espaciales. Puedes enumerar los eventos que ocurrieron hasta 28 días atrás. Si no se especifica, se enumeran los eventos de espacio de los últimos 28 días.
• end_time: Es la marca de tiempo inclusiva hasta la que se enumeran los eventos espaciales. Si no se especifica, se enumeran los eventos hasta el momento de la solicitud.

Para especificar una hora de inicio o finalización, usa el operador igual = y el formato RFC-3339. Para filtrar por start_time y end_time, usa el operador AND.

Por ejemplo, las siguientes consultas son válidas:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Las siguientes consultas no son válidas:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

SpaceEvent

Los resultados se muestran en orden cronológico (el evento más antiguo primero). Nota: El campo permissionSettings no se muestra en el objeto Space para las solicitudes de lista.

string

Es el token de Continuation que se usa para recuperar más eventos. Si se omite este campo, no habrá páginas siguientes.

int32

Opcional. Es la cantidad máxima de espacios que se mostrarán. Es posible que el servicio devuelva menos de este valor.

Si no se especifica, se mostrarán como máximo 100 espacios.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.

Los valores negativos muestran un error INVALID_ARGUMENT.

string

Opcional. Es un token de página, recibido desde una llamada a list spaces anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.

string

Opcional. Un filtro de consulta

Puedes filtrar los espacios por tipo de espacio (space_type).

Para filtrar por tipo de espacio, debes especificar un valor de enumeración válido, como SPACE o GROUP_CHAT (space_type no puede ser SPACE_TYPE_UNSPECIFIED). Para consultar varios tipos de espacio, usa el operador OR.

Por ejemplo, las siguientes consultas son válidas:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

Space

Es la lista de espacios de la página solicitada (o primera). Nota: El campo permissionSettings no se muestra en el objeto Space para las solicitudes de lista.

string

Puedes enviar un token como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

string

Solo salida. La URL que coincidió.

string

Identificador. Es el nombre del recurso de la membresía que asignó el servidor.

Formato: spaces/{space}/members/{member}

MembershipState

Solo salida. Estado de la membresía.

MembershipRole

Opcional. Es el rol del usuario dentro de un espacio de Chat, que determina las acciones permitidas en el espacio.

Este campo solo se puede usar como entrada en UpdateMembership.

Timestamp

Opcional. Inmutable. La hora de creación de la membresía, como el momento en que un miembro se unió a un espacio o se le invitó a hacerlo. Este campo solo se usa para generar resultados, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.

Timestamp

Opcional. Inmutable. La hora de eliminación de la membresía, por ejemplo, cuando un miembro abandonó un espacio o se quitó de él Este campo solo se usa para generar resultados, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.

User

Opcional. El usuario o la app de Google Chat a la que corresponde la membresía. Si tu app de Chat se autentica como un usuario, el resultado propaga los name y type del usuario.

Group

Opcional. El Grupo de Google al que corresponde la membresía.

Para leer o modificar las membresías de Grupos de Google, se requiere la autenticación del usuario.

MembershipCreatedEventData

Una lista de membresías nuevas.

MembershipDeletedEventData

Una lista de las membresías borradas.

MembershipUpdatedEventData

Es una lista de membresías actualizadas.

Membership

La membresía nueva.

Membership

La membresía borrada Solo se propagan los campos name y state.

Membership

La membresía actualizada.

string

Identificador. Es el nombre del recurso del mensaje.

Formato: spaces/{space}/messages/{message}

En el que {space} es el ID del espacio en el que se publicó el mensaje y {message} es un ID asignado por el sistema para el mensaje. Por ejemplo, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Si configuras un ID personalizado cuando creas un mensaje, puedes usar este ID para especificar el mensaje en una solicitud. Para ello, reemplaza {message} por el valor del campo clientAssignedMessageId. Por ejemplo, spaces/AAAAAAAAAAA/messages/client-custom-name. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.

User

Solo salida. El usuario que creó el mensaje. Si tu app de Chat se autentica como un usuario, el resultado propaga los name y type del usuario.

Timestamp

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

Timestamp

Solo salida. Es la hora en la que un usuario editó el mensaje por última vez. Si el mensaje nunca se editó, este campo estará vacío.

Timestamp

Solo salida. La hora a la que se borró el mensaje en Google Chat. Si el mensaje nunca se borra, este campo estará vacío.

string

Opcional. Es el cuerpo del mensaje en texto sin formato. El primer vínculo a una imagen, un video o una página web genera un chip de vista previa. También puedes mencionar a un usuario de Google Chat o a todos los miembros del espacio.

Para obtener información sobre cómo crear mensajes de texto, consulta Cómo enviar un mensaje.

string

Solo salida. Contiene el mensaje text con marcas agregadas para comunicar el formato. Es posible que este campo no capture todo el formato visible en la IU, pero incluye lo siguiente:

• Sintaxis de marcado para texto en negrita, itálico, tachado, monoespaciado, bloque monoespaciado y lista con viñetas.

• Menciones de usuarios con el formato <users/{user}>

• Hipervínculos personalizados con el formato <{url}|{rendered_text}>, en el que la primera cadena es la URL y la segunda es el texto renderizado, por ejemplo, <http://example.com|custom text>.

• Emoji personalizado con el formato :{emoji_name}:, por ejemplo, :smile:. Esto no se aplica a los emojis Unicode, como U+1F600 para un emoji de cara sonriente.

Para obtener más información, consulta Cómo ver el formato de texto enviado en un mensaje.

Card

Obsoleto: Usa cards_v2 en su lugar.

Son tarjetas interactivas, enriquecidas y con formato que puedes usar para mostrar elementos de la IU, como textos con formato, botones e imágenes en las que se puede hacer clic. Por lo general, las tarjetas se muestran debajo del cuerpo de texto sin formato del mensaje. cards y cards_v2 pueden tener un tamaño máximo de 32 KB.

CardWithId

Opcional. Un array de tarjetas.

Solo las apps de Chat pueden crear tarjetas. Si tu app de Chat se autentica como un usuario, los mensajes no pueden contener tarjetas.

Para aprender a crear un mensaje que contenga tarjetas, consulta Cómo enviar un mensaje.

Diseña y obtén vistas previas de las tarjetas con el Creador de tarjetas.

Annotation

Solo salida. Anotaciones asociadas con el text en este mensaje.

Thread

Es el subproceso al que pertenece el mensaje. Para ver un ejemplo de uso, consulta Cómo iniciar o responder una conversación de mensajes.

Space

Solo salida. Si tu app de Chat se autentica como un usuario, el resultado solo propaga el espacio name.

string

Opcional. Es una descripción en texto sin formato de las tarjetas del mensaje, que se usa cuando no se pueden mostrar las tarjetas reales (por ejemplo, notificaciones para dispositivos móviles).

ActionResponse

Solo entrada. Son parámetros que una app de chat puede usar para configurar cómo se publica su respuesta.

string

Solo salida. Cuerpo del mensaje en texto sin formato sin las menciones a la app de Chat

SlashCommand

Solo salida. Información del comando de barra, si corresponde

Attachment

Opcional. Archivo adjunto subido por el usuario.

MatchedUrl

Solo salida. Una URL en spaces.messages.text que coincida con un patrón de vista previa de vínculo. Para obtener más información, consulta Vínculos de vista previa.

bool

Solo salida. Cuando es true, el mensaje es una respuesta en una conversación de respuestas. Cuando es false, el mensaje se puede ver en la conversación de nivel superior del espacio como el primer mensaje de una conversación o como un mensaje sin respuestas intercaladas.

Si el espacio no admite respuestas en conversaciones, este campo siempre es false.

string

Opcional. Un ID personalizado para el mensaje. Puedes usar el campo para identificar un mensaje o para obtener, borrar o actualizar un mensaje. Para establecer un ID personalizado, especifica el campo messageId cuando crees el mensaje. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.

EmojiReactionSummary

Solo salida. La lista de resúmenes de reacciones con emojis en el mensaje

User

Opcional. Inmutable. Entrada para crear un mensaje; de lo contrario, solo salida. El usuario que puede ver el mensaje. Cuando se establece, el mensaje es privado y solo lo pueden ver el usuario especificado y la app de Chat. Para incluir este campo en tu solicitud, debes llamar a la API de Chat con la autenticación de apps y omitir lo siguiente:

• Archivos adjuntos
• Widgets de accesorios

Para obtener más información, consulta Cómo enviar un mensaje de forma privada.

DeletionMetadata

Solo salida. Información sobre un mensaje borrado. Un mensaje se borra cuando se configura delete_time.

QuotedMessageMetadata

Solo salida. Información sobre un mensaje que cita un usuario de Google Chat en un espacio. Los usuarios de Google Chat pueden citar un mensaje para responderlo.

AttachedGif

Solo salida. Imágenes GIF adjuntas al mensaje

AccessoryWidget

Opcional. Uno o más widgets interactivos que aparecen en la parte inferior de un mensaje. Puedes agregar widgets de accesorios a los mensajes que contienen texto, tarjetas o ambos. No es compatible con los mensajes que contienen diálogos. Para obtener más información, consulta Cómo agregar widgets interactivos en la parte inferior de un mensaje.

Para crear un mensaje con widgets de accesorios, se requiere la autenticación de la app.

MessageCreatedEventData

Una lista de mensajes nuevos.

MessageDeletedEventData

Una lista de los mensajes borrados.

MessageUpdatedEventData

Es una lista de mensajes actualizados.

Message

El mensaje nuevo.

Message

El mensaje borrado Solo se completan los campos name, createTime, deleteTime y deletionMetadata.

Message

El mensaje actualizado.

string

Solo salida. Es el nombre del recurso del mensaje citado.

Formato: spaces/{space}/messages/{message}

Timestamp

Solo salida. Es la marca de tiempo del momento en que se creó el mensaje citado o cuando se actualizó por última vez.

string

Identificador. Es el nombre del recurso de la reacción.

Formato: spaces/{space}/messages/{message}/reactions/{reaction}

User

Solo salida. El usuario que creó la reacción.

Emoji

Obligatorio. Es el emoji que se usó en la reacción.

ReactionCreatedEventData

Una lista de reacciones nuevas.

ReactionDeletedEventData

Una lista de las reacciones borradas.

Reaction

La reacción nueva

Reaction

La reacción borrada

string

El URI de este vínculo.

RichLinkType

El tipo de vínculo enriquecido.

DriveLinkData

Datos de un vínculo de Drive

ChatSpaceLinkData

Datos para un vínculo de espacio de Chat

bool

Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el alcance de OAuth 2.0 chat.admin.spaces.readonly o chat.admin.spaces.

Actualmente, este método solo admite acceso de administrador, por lo que solo se acepta true para este campo.

int32

Es la cantidad máxima de espacios que se mostrarán. El servicio puede mostrar menos que este valor.

Si no se especifica, se mostrarán como máximo 100 espacios.

El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambiará automáticamente a 1,000.

string

Es un token que se recibió de la llamada a espacios de búsqueda anterior. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar diferentes valores a los otros parámetros puede generar resultados inesperados.

string

Obligatorio. Una búsqueda.

Puedes usar los siguientes parámetros para realizar búsquedas:

• create_time
• customer
• display_name
• external_user_allowed
• last_active_time
• space_history_state
• space_type

create_time y last_active_time aceptan una marca de tiempo en formato RFC-3339, y los operadores de comparación admitidos son: =, <, >, <= y >=.

customer es obligatorio y se usa para indicar de qué cliente se deben recuperar los espacios. customers/my_customer es el único valor admitido.

display_name solo acepta el operador HAS (:). El texto que debe coincidir primero se divide en tokens, y cada token se compara con un prefijo de forma independiente y sin distinción de mayúsculas o minúsculas como una subcadena en cualquier lugar del display_name del espacio. Por ejemplo, Fun Eve coincide con Fun event o The evening was fun, pero no con notFun event o even.

external_user_allowed acepta true o false.

space_history_state solo acepta valores del campo historyState de un recurso space.

space_type es obligatorio y el único valor válido es SPACE.

En diferentes campos, solo se admiten operadores AND. Un ejemplo válido es space_type = "SPACE" AND display_name:"Hello" y un ejemplo no válido es space_type = "SPACE" OR display_name:"Hello".

En el mismo campo, space_type no admite los operadores AND ni OR. display_name, "space_history_state" y "external_user_allowed" solo admiten operadores OR. last_active_time y create_time admiten los operadores AND y OR. AND solo se puede usar para representar un intervalo, como last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Las siguientes consultas de ejemplo son válidas:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")

string

Opcional. Indica cómo se ordena la lista de espacios.

Los atributos compatibles para ordenar son los siguientes:

• membership_count.joined_direct_human_user_count: Indica la cantidad de usuarios humanos que se unieron directamente a un espacio.
• last_active_time: Indica el momento en que se agregó el último elemento apto a cualquier tema de este espacio.
• create_time: Indica la hora de creación del espacio.

Los valores válidos de la operación de ordenamiento son los siguientes:

• ASC para ascendente. Valor predeterminado

• DESC para descendente.

Las sintaxis admitidas son las siguientes:

• membership_count.joined_direct_human_user_count DESC
• membership_count.joined_direct_human_user_count ASC
• last_active_time DESC
• last_active_time ASC
• create_time DESC
• create_time ASC

Space

Una página de los espacios solicitados.

string

Es un token que se puede usar para recuperar la página siguiente. Si este campo está vacío, no hay páginas posteriores.

int32

Es la cantidad total de espacios que coinciden con la búsqueda en todas las páginas. Si el resultado es superior a 10,000 espacios, este valor es una estimación.

Space

Obligatorio. El campo Space.spaceType es obligatorio.

Para crear un espacio, configura Space.spaceType en SPACE y Space.displayName. Si recibes el mensaje de error ALREADY_EXISTS cuando configuras un espacio, prueba con un displayName diferente. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

Para crear un chat en grupo, establece Space.spaceType en GROUP_CHAT. No configures Space.displayName.

Para crear una conversación 1:1 entre humanos, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en false. No configures Space.displayName ni Space.spaceDetails.

Para crear una conversación 1:1 entre una persona y la app de Chat que realiza la llamada, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true. No configures Space.displayName ni Space.spaceDetails.

Si ya existe un espacio DIRECT_MESSAGE, se muestra ese espacio en lugar de crear uno nuevo.

string

Opcional. Es un identificador único para esta solicitud. Se recomienda usar un UUID aleatorio. Si especificas un ID de solicitud existente, se muestra el espacio creado con ese ID en lugar de crear uno nuevo. Si especificas un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se muestra un error.

Membership

Opcional. Los usuarios o grupos de Google Chat a los que quieres invitar para que se unan al espacio Omite al usuario que realiza la llamada, ya que se agrega automáticamente.

Actualmente, el conjunto permite hasta 20 membresías (además del llamador).

Para la membresía humana, el campo Membership.member debe contener un user con name propagado (formato: users/{user}) y type establecido en User.Type.HUMAN. Solo puedes agregar usuarios humanos cuando configuras un espacio (agregar apps de Chat solo es compatible con la configuración de mensajes directos con la app de llamadas). También puedes agregar miembros con el correo electrónico del usuario como alias para {user}. Por ejemplo, user.name puede ser users/example@gmail.com. Para invitar a usuarios de Gmail o de dominios externos de Google Workspace, se debe usar el correo electrónico del usuario para {user}.

Para la membresía de Grupos de Google, el campo Membership.group_member debe contener un group con name propagado (formato groups/{group}). Solo puedes agregar Grupos de Google cuando configuras Space.spaceType como SPACE.

Opcional cuando se establece Space.spaceType en SPACE.

Obligatorio cuando se establece Space.spaceType en GROUP_CHAT, junto con al menos dos membresías.

Obligatorio cuando se establece Space.spaceType en DIRECT_MESSAGE con un usuario humano, junto con exactamente una membresía.

Debe estar vacío cuando se crea una conversación 1:1 entre una persona y la app de Chat que realiza la llamada (cuando se establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true).

int64

Es el ID del comando de barra invocado.

User

La app de Chat cuyo comando se invocó

Type

Es el tipo de comando de barra.

string

Es el nombre del comando de barra invocado.

int64

El ID del comando de barra invocado.

bool

Indica si el comando de barra es para un diálogo.

string

Identificador. Es el nombre del recurso del espacio.

Formato: spaces/{space}

En el que {space} representa el ID asignado por el sistema para el espacio. Para obtener el ID del espacio, llama 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

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

SpaceType

Opcional. Es el tipo de espacio. Obligatorio cuando se crea un espacio o se actualiza el tipo de espacio. Solo salida para otro uso.

bool

Opcional. Si el espacio es un MD entre una app de chat y una sola persona.

bool

Solo salida. Obsoleto: Usa spaceThreadingState en su lugar. Si los mensajes se organizan en conversaciones en este espacio.

string

Opcional. Es el nombre visible del espacio. Obligatorio 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.

bool

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:

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

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

SpaceThreadingState

Solo salida. El estado de los subprocesos en el espacio de Chat

SpaceDetails

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

HistoryState

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

bool

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

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

Timestamp

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 spaceType es GROUP_CHAT o SPACE.

Timestamp

Solo salida. Marca de tiempo del último mensaje en el espacio.

bool

Solo salida. En el caso de los espacios de mensajes directos (DM) 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.

MembershipCount

Solo salida. Es el recuento de membresías unidas agrupadas por tipo de miembro. Se propaga cuando space_type es SPACE, DIRECT_MESSAGE o GROUP_CHAT.

AccessSettings

Opcional. Especifica la configuración de acceso del espacio. Solo se propaga cuando space_type es SPACE.

string

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

Timestamp

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

Cada espacio creado en el modo de importación debe salir de este modo antes de que venza el tiempo de spaces.completeImport.

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

string

Opcional. Inmutable. El ID de cliente del dominio del espacio. Solo es obligatorio cuando se crea un espacio con autenticación de apps y SpaceType es SPACE. De lo contrario, no se debe establecer.

En el formato customers/{customer}, donde customer es el id del [recurso de cliente 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 mensajes directos, este campo no se completa.

PredefinedPermissionSettings

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 PermissionSettings.

PermissionSettings

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.

AccessState

Solo salida. Indica el estado de acceso del espacio.

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. 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: audiences/{audience}

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

Leer el público objetivo permite lo siguiente:

• Autenticación de usuarios

• Autenticación de la app con aprobación del administrador con el alcance chat.app.spaces en

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

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

int32

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.

int32

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

bool

Opcional. Si los administradores de espacios tienen este permiso

bool

Opcional. Si los miembros que no son administradores tienen este permiso

PermissionSetting

Opcional. Configuración para administrar miembros y grupos en un espacio.

PermissionSetting

Opcional. Configuración para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio

PermissionSetting

Opcional. Configuración para activar o desactivar el historial del espacio.

PermissionSetting

Opcional. Configuración para usar @todos en un espacio

PermissionSetting

Opcional. Configuración para administrar apps en un espacio.

PermissionSetting

Opcional. Configuración para administrar webhooks en un espacio.

PermissionSetting

Solo salida. Configuración para publicar mensajes en un espacio.

PermissionSetting

Opcional. Configuración para responder mensajes en un espacio.

string

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.

string

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

Admite hasta 5,000 caracteres.

SpaceUpdatedEventData

Es una lista de espacios actualizados.

string

Es el nombre del recurso del evento de espacio.

Formato: spaces/{space}/spaceEvents/{spaceEvent}

Timestamp

Hora en la que ocurrió el evento.

string

Es el tipo de evento espacial. Cada tipo de evento tiene una versión por lotes, que representa varias instancias del tipo de evento que ocurren en un período breve. En el caso de las solicitudes spaceEvents.list(), omite los tipos de eventos por lotes en el filtro de consulta. De forma predeterminada, el servidor muestra el tipo de evento y su versión por lotes.

Tipos de eventos admitidos para mensajes:

• Mensaje nuevo: google.workspace.chat.message.v1.created
• Mensaje actualizado: google.workspace.chat.message.v1.updated
• Mensaje borrado: google.workspace.chat.message.v1.deleted
• Varios mensajes nuevos: google.workspace.chat.message.v1.batchCreated
• Varios mensajes actualizados: google.workspace.chat.message.v1.batchUpdated
• Varios mensajes borrados: google.workspace.chat.message.v1.batchDeleted

Tipos de eventos admitidos para las membresías:

• Nueva membresía: google.workspace.chat.membership.v1.created
• Membresía actualizada: google.workspace.chat.membership.v1.updated
• Membresía borrada: google.workspace.chat.membership.v1.deleted
• Varias membresías nuevas: google.workspace.chat.membership.v1.batchCreated
• Varias membresías actualizadas: google.workspace.chat.membership.v1.batchUpdated
• Varias membresías borradas: google.workspace.chat.membership.v1.batchDeleted

Tipos de eventos admitidos para las reacciones:

• Nueva reacción: google.workspace.chat.reaction.v1.created
• Se borró la reacción: google.workspace.chat.reaction.v1.deleted
• Varias reacciones nuevas: google.workspace.chat.reaction.v1.batchCreated
• Varias reacciones borradas: google.workspace.chat.reaction.v1.batchDeleted

Tipos de eventos admitidos sobre el espacio:

• Espacio actualizado: google.workspace.chat.space.v1.updated
• Varias actualizaciones de espacio: google.workspace.chat.space.v1.batchUpdated

MessageCreatedEventData

Carga útil del evento para un mensaje nuevo.

Tipo de evento: google.workspace.chat.message.v1.created

MessageUpdatedEventData

Carga útil del evento para un mensaje actualizado.

Tipo de evento: google.workspace.chat.message.v1.updated

MessageDeletedEventData

Carga útil del evento para un mensaje borrado.

Tipo de evento: google.workspace.chat.message.v1.deleted

MessageBatchCreatedEventData

Carga útil del evento para varios mensajes nuevos.

Tipo de evento: google.workspace.chat.message.v1.batchCreated

MessageBatchUpdatedEventData

Carga útil del evento para varios mensajes actualizados.

Tipo de evento: google.workspace.chat.message.v1.batchUpdated

MessageBatchDeletedEventData

Carga útil del evento para varios mensajes eliminados.

Tipo de evento: google.workspace.chat.message.v1.batchDeleted

SpaceUpdatedEventData

Carga útil del evento para una actualización de espacio.

Tipo de evento: google.workspace.chat.space.v1.updated

SpaceBatchUpdatedEventData

Carga útil del evento para varias actualizaciones de un espacio.

Tipo de evento: google.workspace.chat.space.v1.batchUpdated

MembershipCreatedEventData

Carga útil del evento para una membresía nueva.

Tipo de evento: google.workspace.chat.membership.v1.created

MembershipUpdatedEventData

Carga útil del evento para una membresía actualizada.

Tipo de evento: google.workspace.chat.membership.v1.updated

MembershipDeletedEventData

Carga útil del evento para una membresía borrada.

Tipo de evento: google.workspace.chat.membership.v1.deleted

MembershipBatchCreatedEventData

Carga útil del evento para varias membresías nuevas.

Tipo de evento: google.workspace.chat.membership.v1.batchCreated

MembershipBatchUpdatedEventData

Carga útil del evento para varias membresías actualizadas.

Tipo de evento: google.workspace.chat.membership.v1.batchUpdated

MembershipBatchDeletedEventData

Carga útil del evento para varias membresías borradas.

Tipo de evento: google.workspace.chat.membership.v1.batchDeleted

ReactionCreatedEventData

Carga útil del evento para una reacción nueva.

Tipo de evento: google.workspace.chat.reaction.v1.created

ReactionDeletedEventData

Carga útil del evento para una reacción borrada.

Tipo de evento: google.workspace.chat.reaction.v1.deleted

ReactionBatchCreatedEventData

Carga útil del evento para varias reacciones nuevas.

Tipo de evento: google.workspace.chat.reaction.v1.batchCreated

ReactionBatchDeletedEventData

Carga útil del evento para varias reacciones borradas.

Tipo de evento: google.workspace.chat.reaction.v1.batchDeleted

string

Identificador. Es el nombre del recurso de la configuración de notificaciones del espacio. Formato: users/{user}/spaces/{space}/spaceNotificationSetting.

NotificationSetting

Es la configuración de notificaciones.

MuteSetting

La configuración de silenciamiento de notificaciones del espacio

string

Es el nombre del recurso del estado de lectura del espacio.

Formato: users/{user}/spaces/{space}/spaceReadState

Timestamp

Opcional. Es la hora en la que se actualizó el estado de lectura del espacio del usuario. Por lo general, corresponde a la marca de tiempo del último mensaje leído o a una marca de tiempo que especifica el usuario para marcar la última posición de lectura en un espacio.

Space

El espacio actualizado.

string

Identificador. Es el nombre del recurso del subproceso.

Ejemplo: spaces/{space}/threads/{thread}

string

Opcional. Entrada para crear o actualizar una conversación. De lo contrario, solo se muestra la salida. Es el ID del subproceso. Admite hasta 4,000 caracteres.

Este ID es único para la app de Chat que lo establece. Por ejemplo, si varias apps de Chat crean un mensaje con la misma clave de conversación, los mensajes se publican en conversaciones diferentes. Para responder en una conversación creada por una persona o por otra app de Chat, especifica el campo name de la conversación.

string

Es el nombre del recurso del estado de lectura del subproceso.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Timestamp

Es la hora en la que se actualizó el estado de lectura del subproceso del usuario. Por lo general, corresponde a la marca de tiempo del último mensaje leído en una conversación.

Membership

Obligatorio. Es la membresía que se actualizará. Solo se actualizan los campos especificados por update_mask.

FieldMask

Obligatorio. Las rutas de campo que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de campo.

Rutas de campo admitidas actualmente:

• role

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.memberships.

Message

Obligatorio. Mensaje con campos actualizados.

FieldMask

Obligatorio. Las rutas de campo que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de campo.

Rutas de campo admitidas actualmente:

• text

• attachment

• cards (requiere autenticación de apps).

• cards_v2 (requiere autenticación de apps).

• accessory_widgets (requiere autenticación de apps).

bool

Opcional. Si no se encuentra true ni el mensaje, se crea uno nuevo y se ignora updateMask. El ID de mensaje especificado debe ser asignado por el cliente o la solicitud fallará.

SpaceNotificationSetting

Obligatorio. El nombre del recurso para la configuración de notificaciones del espacio debe propagarse en el formato users/{user}/spaces/{space}/spaceNotificationSetting. Solo se actualizan los campos especificados por update_mask.

FieldMask

Obligatorio. Rutas de campo compatibles: - notification_setting - mute_setting

SpaceReadState

Obligatorio. El estado de lectura del espacio y los campos que se deben actualizar

Solo admite la actualización del estado de lectura para el usuario que realiza la llamada.

Para hacer referencia al usuario que llama, establece una de las siguientes opciones:

• El alias me. Por ejemplo, users/me/spaces/{space}/spaceReadState

• Su dirección de correo electrónico de Workspace Por ejemplo, users/user@example.com/spaces/{space}/spaceReadState.

• Su ID de usuario Por ejemplo, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState

FieldMask

Obligatorio. Las rutas de campo que se actualizarán. Rutas de campo admitidas actualmente:

• last_read_time

Cuando el last_read_time es anterior a la hora de creación del mensaje más reciente, el espacio aparece como no leído en la IU.

Para marcar el espacio como leído, establece last_read_time en cualquier valor posterior (mayor) que la hora de creación del mensaje más reciente. El last_read_time se obliga a coincidir con la hora de creación del mensaje más reciente. Ten en cuenta que el estado de lectura del espacio solo afecta el estado de lectura de los mensajes que son visibles en la conversación de nivel superior del espacio. Las respuestas en las conversaciones no se ven afectadas por esta marca de tiempo, sino que dependen del estado de lectura de la conversación.

Space

Obligatorio. Espacio con campos que se actualizarán. Space.name se debe propagar en el formato spaces/{space}. Solo se actualizan los campos especificados por update_mask.

FieldMask

Obligatorio. Las rutas de acceso de los campos actualizadas, separadas por comas si hay varias.

Puedes actualizar los siguientes campos de un espacio:

space_details: Actualiza la descripción del espacio. Admite hasta 150 caracteres.

display_name: Solo admite la actualización del nombre visible para los espacios en los que el campo spaceType es SPACE. Si recibes el mensaje de error ALREADY_EXISTS, prueba con un valor diferente. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

space_type: Solo admite cambiar un tipo de espacio GROUP_CHAT a SPACE. Incluye display_name junto con space_type en la máscara de actualización y asegúrate de que el espacio especificado tenga un nombre visible no vacío y el tipo de espacio SPACE. Incluir la máscara space_type y el tipo SPACE en el espacio especificado cuando se actualiza el nombre visible es opcional si el espacio existente ya tiene el tipo SPACE. Si intentas actualizar el tipo de espacio de otras maneras, se mostrará un error de argumento no válido. space_type no es compatible con useAdminAccess.

space_history_state: Actualiza la configuración del historial del espacio activando o desactivando el historial del espacio. Solo se admite si la configuración del historial está habilitada para la organización de Google Workspace. Para actualizar el estado del historial de espacios, debes omitir todas las demás máscaras de campo en tu solicitud. space_history_state no es compatible con useAdminAccess.

access_settings.audience: Actualiza la configuración de acceso de quién puede descubrir el espacio, unirse a él y obtener una vista previa de los mensajes en el espacio con nombre en el que el campo spaceType es SPACE. Si el espacio existente tiene un público objetivo, puedes quitarlo y restringir el acceso al espacio omitiendo un valor para esta máscara de campo. Para actualizar la configuración de acceso de un espacio, el usuario que realiza la autenticación debe ser administrador del espacio y omitir todas las demás máscaras de campo en la solicitud. No puedes actualizar este campo si el espacio está en modo de importación. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para usuarios específicos. access_settings.audience no es compatible con useAdminAccess.

permission_settings: Admite cambiar la configuración de permisos de un espacio. Cuando actualizas la configuración de permisos, solo puedes especificar máscaras de campo permissionSettings. No puedes actualizar otras máscaras de campo al mismo tiempo. permissionSettings no es compatible con useAdminAccess. Entre las máscaras de campo admitidas, se incluyen las siguientes:

• permission_settings.manageMembersAndGroups
• permission_settings.modifySpaceDetails
• permission_settings.toggleHistory
• permission_settings.useAtMentionAll
• permission_settings.manageApps
• permission_settings.manageWebhooks
• permission_settings.replyMessages

bool

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que realiza la llamada debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.spaces.

Algunos valores de FieldMask no son compatibles con el acceso de administrador. Para obtener más información, consulta la descripción de update_mask.

string

Es el nombre de recurso de un user de Google Chat.

Formato: users/{user}. users/app se puede usar como alias para el usuario bot de la app que realiza la llamada.

Para human users, {user} es el mismo identificador de usuario que el siguiente:

• el id para Person en la API de People. Por ejemplo, users/123456789 en la API de Chat representa a la misma persona que el ID de perfil de la persona 123456789 en la API de People.

• el id de un usuario en la API de Directory del SDK de Admin.

• La dirección de correo electrónico del usuario se puede usar como alias para {user} en las solicitudes a la API. Por ejemplo, si el ID de perfil de persona de la API de People para user@example.com es 123456789, puedes usar users/user@example.com como alias para hacer referencia a users/123456789. La API solo mostrará el nombre del recurso canónico (por ejemplo, users/123456789).

string

Solo salida. El nombre visible del usuario.

string

Es el identificador único del dominio de Google Workspace del usuario.

Type

Tipo de usuario.

bool

Solo salida. Cuando true, el usuario se borra o su perfil no es visible.

User

El usuario mencionado.

Type

Es el tipo de mención de usuario.

Button

Una lista de botones. Buttons también es oneof data y solo se debe establecer uno de estos campos.

TextParagraph

Muestra un párrafo de texto en este widget.

Image

Muestra una imagen en este widget.

KeyValue

Muestra un elemento de valor clave en este widget.

TextButton

Un botón con texto y acción onclick.

ImageButton

Un botón con imagen y acción onclick.

string

El nombre del método se usa para identificar qué parte del formulario activó el envío. Esta información se vuelve a enviar a la app de Chat como parte del evento de clic en la tarjeta. Puedes usar el mismo nombre de método para varios elementos que activen un comportamiento común.

ActionParameter

Es la lista de parámetros de acción.

string

Es el nombre del parámetro de la secuencia de comandos de la acción.

string

El valor del parámetro.

string

Es la URL de la imagen.

OnClick

La acción onclick

double

Es la relación de aspecto de esta imagen (ancho y alto). Este campo te permite reservar la altura correcta para la imagen mientras esperas a que se cargue. No está diseñado para anular la relación de aspecto integrada de la imagen. Si no se establece, el servidor la completa a través de la precarga de la imagen.

OnClick

La acción onclick

string

Es el nombre de este image_button que se usa para la accesibilidad. Si no se especifica este nombre, se proporciona el valor predeterminado.