Package google.chat.v1

Es el espacio del modo de importación.

ContextualAddOnMarkup

Este tipo no tiene campos.

Es el lenguaje de marcado que usan los desarrolladores para especificar el contenido de un complemento contextual.

Tarjeta

Una tarjeta es un elemento de la IU que puede contener widgets de la IU, como texto e imágenes.

Campos
`header`	`CardHeader` Es el encabezado de la tarjeta. Un encabezado suele contener un título y una imagen.
`sections[]`	`Section` Las secciones están separadas por una línea divisoria.
`card_actions[]`	`CardAction` Son las acciones de esta tarjeta.
`name`	`string` Es el nombre de la tarjeta.

CardAction

Una acción de tarjeta es la acción asociada con la tarjeta. En el caso de una tarjeta de factura, una acción típica sería borrar la factura, enviarla por correo electrónico o abrirla en el navegador.

No es compatible con las apps de Google Chat.

Campos

action_label

string

Es la etiqueta que se usaba para mostrarse en el elemento del menú de acciones.

on_click

OnClick

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

CardHeader

Campos
`title`	`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, este ocupa ambas líneas.
`subtitle`	`string` Es el subtítulo del encabezado de la tarjeta.
`image_style`	`ImageStyle` Es el tipo de imagen (por ejemplo, borde cuadrado o circular).
`image_url`	`string` Es la URL de la imagen en el encabezado de la tarjeta.

ImageStyle

Enums
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	Borde cuadrado.
`AVATAR`	Borde circular.

Sección

Una sección contiene una colección de widgets que se renderizan (verticalmente) en el orden en que se especifican. En todas las plataformas, las tarjetas tienen un ancho fijo estrecho, por lo que actualmente no se necesitan propiedades de diseño (por ejemplo, flotante).

Campos

header

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.

widgets[]

WidgetMarkup

Una sección debe contener al menos un widget.

CreateCustomEmojiRequest

Es una solicitud para crear un emoji personalizado.

Campos

custom_emoji

Obligatorio. Es el emoji personalizado que se creará.

CreateMembershipRequest

Mensaje de solicitud para crear una membresía.

Campos

parent

string

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

Formato: spaces/{space}

membership

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

El campo memberType debe contener un usuario con los campos user.name y user.type completados. 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 se autentica como usuario, se requiere el permiso de autorización chat.memberships.
Cuando se realiza la autenticación como app, se requiere el permiso de autorización chat.app.memberships.
Establece user.type como 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 People o el id del usuario en la API de Directory. Por ejemplo, si el ID del perfil de 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 usuario y usar el permiso chat.memberships.app, establecer user.type en BOT y establecer user.name en users/app.

use_admin_access

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 ajenos a la organización de Google Workspace del administrador con el acceso de administrador.

CreateMessageNotificationOptions

Son las opciones para el comportamiento de las notificaciones cuando se publica el mensaje.

Campos

notification_type

NotificationType

Es el tipo de notificación del mensaje.

NotificationType

Son las opciones de tipos de notificaciones para el mensaje.

Enums

NOTIFICATION_TYPE_NONE Es el comportamiento predeterminado. El comportamiento de las notificaciones es similar al que se produce cuando el usuario humano envía el mensaje con la IU de Chat: no se envía ninguna notificación al remitente humano.

NOTIFICATION_TYPE_FORCE_NOTIFY

Notifica a los destinatarios de forma forzada. Esto anula la configuración de notificaciones de los espacios de los usuarios y la configuración de No interrumpir de Chat. Esta opción no omite la configuración de No interrumpir a nivel del dispositivo.

Requiere autenticación de la app.

NOTIFICATION_TYPE_SILENT

No notifiques a los destinatarios ni marques el mensaje como no leído. Esto se comporta de manera similar a cuando el usuario silencia la conversación o habilita la opción No interrumpir en Chat.

Requiere autenticación de la app.

CreateMessagePinRequest

Mensaje de solicitud para crear un mensaje fijado.

Campos

parent

string

Obligatorio. Es el espacio superior en el que se creará el mensaje fijado. Formato: spaces/{space}

message_pin

MessagePin

Obligatorio. El MessagePin que se creará.

CreateMessageRequest

Crea un mensaje.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del espacio en el que se creará un mensaje. Formato: `spaces/{space}`
`message`	`Message` Obligatorio. Cuerpo del mensaje.
`thread_key (deprecated)`	`string` Este elemento es obsoleto. Opcional. Obsoleto: Usa `thread.thread_key` en su lugar. Es el ID de la conversación. Admite hasta 4,000 caracteres. Para iniciar una conversación o agregar un mensaje 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.
`request_id`	`string` Opcional. Es un ID único para esta solicitud. Se recomienda usar un UUID aleatorio. Especificar un ID de solicitud hace que la solicitud sea idempotente, lo que garantiza que varias solicitudes idénticas con el mismo ID de solicitud den como resultado la creación de un solo mensaje. Las solicitudes posteriores con el mismo ID de solicitud devuelven el mensaje existente y no lo actualizan, incluso si los detalles solicitados difieren del estado actual. Para usar este campo de forma eficaz, haz lo siguiente: Asegúrate de que las solicitudes posteriores sean idénticas y usen las mismas credenciales de autenticación que la solicitud original. Si ya se creó un mensaje con el ID de solicitud proporcionado, la solicitud devuelve ese mensaje. Ten en cuenta que es posible que el mensaje que se devuelva no esté completo. La API repite el mensaje de tu solicitud con los nombres de recursos asignados por el sistema. Para recuperar los metadatos más recientes del mensaje, llama a `GetMessage`. Si reutilizas un ID de solicitud existente con un usuario autenticado diferente, se producirá un error.
`message_reply_option`	`MessageReplyOption` Opcional. Especifica si un mensaje inicia una conversación o responde a una. Solo se admite en espacios con nombre. Cuando respondes a las interacciones de los usuarios, 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 creará como un hilo nuevo.
`message_id`	`string` Opcional. Es 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.
`create_message_notification_options`	`CreateMessageNotificationOptions` Opcional. Controla el comportamiento de las notificaciones cuando se publica el mensaje. Para obtener más información, consulta Cómo forzar notificaciones o enviar mensajes silenciosos.

MessageReplyOption

Especifica cómo responder un mensaje. Es posible que se agreguen más estados en el futuro.

Enums
`MESSAGE_REPLY_OPTION_UNSPECIFIED`	Predeterminado. Inicia un hilo nuevo. Si usas esta opción, se ignorarán los `thread ID` o `thread_key` que se incluyan.
`REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD`	Crea el mensaje como una respuesta al hilo especificado por `thread ID` o `thread_key`. Si falla, el mensaje iniciará un hilo nuevo.
`REPLY_MESSAGE_OR_FAIL`	Crea el mensaje como una respuesta al hilo especificado por `thread ID` o `thread_key`. Si se usa un `thread_key` nuevo, se crea un hilo nuevo. Si falla la creación del mensaje, se devuelve un error `NOT_FOUND`.

CreateReactionRequest

Crea una reacción a un mensaje.

Campos

parent

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

CreateSectionRequest

Es el mensaje de solicitud para crear una sección.

Campos

parent

string

Obligatorio. Es el nombre del recurso superior en el que se crea la sección.

Formato: users/{user}

section

Obligatorio. Es la sección que se creará.

CreateSpaceRequest

Es una solicitud para crear un espacio con nombre sin miembros.

Campos

space

Obligatorio. Se deben completar 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 un displayName diferente. 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.

request_id

string

Opcional. Es un ID único para esta solicitud. Se recomienda usar un UUID aleatorio. Especificar un ID de solicitud hace que la solicitud sea idempotente, lo que garantiza que varias solicitudes idénticas con el mismo ID de solicitud den como resultado la creación de un solo espacio. Las solicitudes posteriores con el mismo ID de solicitud devuelven el espacio existente y no lo actualizan, incluso si los detalles solicitados difieren del estado actual.

Para usar este campo de forma eficaz, haz lo siguiente:

Asegúrate de que las solicitudes posteriores sean idénticas y usen las mismas credenciales de autenticación que la solicitud original.
Si ya se creó un espacio con el ID de solicitud proporcionado, la solicitud devuelve ese espacio. Ten en cuenta que es posible que el espacio devuelto no esté completamente propagado. La API replica el espacio de tu solicitud con el nombre del recurso asignado por el sistema propagado. Para recuperar los metadatos más recientes del espacio, llama a GetSpace.
Si reutilizas un ID de solicitud existente con un usuario autenticado diferente, se producirá un error.

CustomEmoji

Representa un emoji personalizado.

Campos
`name`	`string` Es el identificador. Es el nombre del recurso del emoji personalizado, asignado por el servidor. Formato: `customEmojis/{customEmoji}`
`uid`	`string` Solo salida. Es la clave única para el recurso de emoji personalizado.
`emoji_name`	`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, es solo de salida. Los nombres de los emojis deben comenzar y terminar con dos puntos, deben estar en minúsculas y solo pueden contener 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:`
`temporary_image_uri`	`string` Solo salida. Es una URL de imagen temporal para el emoji personalizado, válida durante al menos 10 minutos. Ten en cuenta que este campo no se completa en la respuesta cuando se crea el emoji personalizado.
`payload`	`CustomEmojiPayload` Opcional. Solo entrada. Son los datos de carga útil. Es obligatorio cuando se crea el emoji personalizado.

CustomEmojiPayload

Son los datos de carga útil del emoji personalizado.

Campos

file_content

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 cuadrada y tener entre 64 y 500 píxeles. Las restricciones están sujetas a cambios.

filename

string

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

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

CustomEmojiMetadata

Son los metadatos de anotación para los emojis personalizados.

Campos

custom_emoji

El emoji personalizado.

CustomStatus

Representa el estado personalizado de un usuario en Google Chat. Esto incluye un mensaje de texto breve con un emoji opcional que un usuario configura para brindar más contexto sobre su disponibilidad.

Campos
`text`	`string` Obligatorio. Es el texto del estado personalizado. Esta será una cadena con una longitud máxima de 64.
`emoji`	`Emoji` Obligatorio. Es el emoji del estado personalizado. Solo se admiten emojis Unicode; no se admiten emojis personalizados.
Campo de unión `expiration`. Es la hora de vencimiento del estado personalizado. Se puede especificar como una marca de tiempo absoluta o una duración de tiempo de actividad. `expiration` puede ser solo uno de los parámetros siguientes:
`expire_time`	`Timestamp` Es la marca de tiempo en la que vence el estado personalizado.
`ttl`	`Duration` Solo entrada. Es la duración del tiempo de actividad después de la cual vence el estado personalizado.

DeleteCustomEmojiRequest

Solicitud para borrar un emoji personalizado.

Campos

name

string

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

Formato: customEmojis/{customEmoji}

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

DeleteMembershipRequest

Solicitud para borrar una membresía en un espacio.

Campos

name

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 suyas. Las apps de Chat no pueden borrar las membresías de otras apps.

Cuando se borra una membresía humana, se requiere el permiso chat.memberships con la autenticación de usuario o el permiso chat.memberships.app con la autenticación de app y el formato spaces/{space}/members/{member}. Puedes usar el correo electrónico como alias de {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 app, se requiere el permiso chat.memberships.app y el formato spaces/{space}/members/app.

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

use_admin_access

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 las conversaciones de Chat y los espacios.

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

No se admite borrar membresías de apps en un espacio con el acceso de administrador.

DeleteMessagePinRequest

Es el mensaje de solicitud para borrar un mensaje fijado.

Campos

name

string

Obligatorio. Es el nombre del recurso del mensaje fijado que se quitará. Formato: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

Solicitud para borrar un mensaje.

Campos

name

string

Obligatorio. Es el nombre del recurso del mensaje.

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

Si estableciste un Custom ID 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.

force

bool

Opcional. Cuando true, si borras un mensaje, también se borran sus respuestas en hilos. Cuando false, si un mensaje tiene respuestas en hilos, la eliminación falla.

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

DeleteReactionRequest

Borra una reacción a un mensaje.

Campos

name

string

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

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

DeleteSectionRequest

Es el mensaje de solicitud para borrar una sección.

Campos

name

string

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

Formato: users/{user}/sections/{section}

DeleteSpaceRequest

Solicitud para borrar un espacio.

Campos

name

string

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

Formato: spaces/{space}

use_admin_access

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.

DeletionMetadata

Información sobre un mensaje borrado. Se borra un mensaje cuando se establece delete_time.

Campos

deletion_type

DeletionType

Indica quién borró el mensaje.

DeletionType

Quién borró el mensaje y cómo lo hizo Es posible que se agreguen más valores en el futuro. Consulta Cómo editar o borrar un mensaje en Google Chat para obtener detalles sobre cuándo se pueden borrar los mensajes.

Enums
`DELETION_TYPE_UNSPECIFIED`	Este valor no se usa.
`CREATOR`	El usuario borró su propio mensaje.
`SPACE_OWNER`	Un propietario o administrador borró el mensaje.
`ADMIN`	Un administrador de Google Workspace borró el mensaje. Los administradores pueden borrar cualquier mensaje del espacio, incluidos los que envíen los miembros del espacio o las apps de Chat.
`APP_MESSAGE_EXPIRY`	Una app de Chat borró su propio mensaje cuando venció.
`CREATOR_VIA_APP`	Una app de Chat borró el mensaje en nombre del creador (con la autenticación del usuario).
`SPACE_OWNER_VIA_APP`	Una app de Chat borró el mensaje en nombre de un administrador del espacio (con la autenticación del usuario).
`SPACE_MEMBER`	Un miembro del espacio borró el mensaje. Los usuarios pueden borrar los mensajes que envían las apps.

Dialog

Es un wrapper alrededor del cuerpo de la tarjeta del diálogo.

Campos

body

Card

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

DialogAction

Contiene un diálogo y un código de estado de la solicitud.

Campos

action_status

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.

Campo de unión action. Es la acción que se debe realizar. action puede ser solo uno de los parámetros siguientes:

dialog

Dialog

Solo entrada. Diálogo para la solicitud.

DoNotDisturbMetadata

Son los metadatos asociados con el estado de disponibilidad DO_NOT_DISTURB, que especifican cuándo vence el estado.

Campos

expiration_time

Timestamp

Solo salida. Marca de tiempo hasta la que se debe marcar al usuario como DO_NOT_DISTURB. Puede ser de hasta 1 año en el futuro.

DriveDataRef

Es una referencia a los datos de un archivo adjunto de Drive.

Campos

drive_file_id

string

Es el ID del archivo de Drive. Se usa con la API de Drive.

DriveLinkData

Son los datos de los vínculos de Google Drive.

Campos

drive_data_ref

DriveDataRef

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

mime_type

string

Es el tipo de MIME del recurso de Google Drive vinculado.

Elementos

Los elementos son componentes adicionales que pueden o no estar asociados con el texto del mensaje proporcionado durante su creación.

Campos

cited_sources[]

CitedSource

Es una lista de fuentes que se mostrarán debajo del mensaje como vínculos de pie de página. No se hace referencia a ellas de forma intercalada. Para las referencias intercaladas, usa citations.

citations[]

Citation

Es una lista de citas intercaladas a las que se hace referencia en el texto del mensaje (a través de etiquetas <chat-citation>) que se renderizan como tarjetas emergentes interactivas.

ElementsImage

Es un objeto que encapsula diferentes formas de representar una imagen. Representaciones admitidas actualmente: - Una imagen recuperada de un URI. Es posible que se admitan representaciones adicionales en el futuro.

Campos

Campo de unión image. Obligatorio. Es una de las representaciones de imágenes admitidas. image puede ser solo uno de los parámetros siguientes:

image_uri

string

Obligatorio. Un URI de acceso público para una imagen.

Emoji

Es un emoji que se usa como reacción a un mensaje.

Campos

Campo de unión content. Obligatorio. Es el contenido del emoji. content puede ser solo uno de los parámetros siguientes:

unicode

string

Opcional. Es un emoji básico representado por una cadena Unicode.

custom_emoji

Un emoji personalizado.

EmojiReactionSummary

Es la cantidad de personas que reaccionaron a un mensaje con un emoji específico.

Campos

emoji

Emoji

Solo salida. Es el emoji asociado con las reacciones.

reaction_count

int32

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

FindDirectMessageRequest

Es una solicitud para obtener un espacio de mensajes directos según el recurso del usuario.

Campos

name

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 autenticas como usuario, puedes usar el correo electrónico como alias de {user}. Por ejemplo, users/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.

FindGroupChatsRequest

Es una solicitud para obtener espacios de chat en grupo según los recursos del usuario.

Campos
`users[]`	`string` Opcional. Son los nombres de los recursos de todos los usuarios humanos en el chat en grupo con el usuario que llama. No se pueden incluir apps de Chat en la solicitud. La cantidad máxima de usuarios que se pueden especificar en una sola solicitud es `49`. 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, para encontrar todos los chats en grupo con el usuario que llama y otros dos usuarios, con los IDs de perfil de la API de People `123456789` y `987654321`, puedes usar `users/123456789` y `users/987654321`. También puedes usar el correo electrónico como alias de `{user}`. Por ejemplo, `users/example@gmail.com`, donde `example@gmail.com` es el correo electrónico del usuario de Google Chat.
`page_size`	`int32` Opcional. Es la cantidad máxima de espacios que se devolverán. Es posible que el servicio devuelva una cantidad inferior a este valor. Si no se especifica, se devuelven, como máximo, 10 espacios. El valor máximo es 30. Si usas un valor superior a 30, se cambiará automáticamente a 30. Los valores negativos devuelven un error `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Es un token de página, recibido desde una llamada anterior para encontrar chats en grupo. 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 los de la llamada que proporcionó el token. Pasar valores diferentes puede generar resultados inesperados.
`space_view`	`SpaceView` Es el tipo de vista de espacio solicitado. Si no se configura, el valor predeterminado es `SPACE_VIEW_RESOURCE_NAME_ONLY`. Las solicitudes que especifican `SPACE_VIEW_EXPANDED` deben incluir permisos que permitan leer datos de espacios, por ejemplo, https://www.googleapis.com/auth/chat.spaces o https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

Es una respuesta que contiene espacios de chat en grupo con exactamente el usuario que llama y los usuarios solicitados.

Campos

spaces[]

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

next_page_token

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

ForwardedMetadata

Son los metadatos sobre el espacio de origen desde el que se reenvió un mensaje.

Campos

space

string

Solo salida. Es el nombre del recurso del espacio de origen. Formato: spaces/{space}

space_display_name

string

Solo salida. Es el nombre visible del espacio o MD de origen en el momento del reenvío. En el caso de SPACE, este es el nombre del espacio. En el caso de DIRECT_MESSAGE, este es el nombre del otro participante (p.ej., "Usuario A"). En el caso de GROUP_CHAT, se trata de un nombre generado a partir de los nombres de los miembros, con un límite de 5, incluido el creador (p.ej., "Usuario A, Usuario B").

GetAttachmentRequest

Es una solicitud para obtener un archivo adjunto.

Campos

name

string

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

GetAvailabilityRequest

Mensaje de la solicitud para el método GetAvailability.

Campos

name

string

Obligatorio. Es el nombre del recurso de la disponibilidad que se recuperará.

Formato: users/{user}/availability

{user} es el ID de la persona en la API de People o en la API de Directory del SDK de Admin. Por ejemplo, users/123456789

La dirección de correo electrónico del usuario o me también se pueden usar como alias para hacer referencia al emisor. Por ejemplo, users/user@example.com o users/me.

GetCustomEmojiRequest

Es una solicitud para devolver un solo emoji personalizado.

Campos

name

string

Obligatorio. Es el nombre del recurso del emoji personalizado.

Formato: customEmojis/{customEmoji}

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

GetMembershipRequest

Es la solicitud para obtener una membresía de un espacio.

Campos

name

string

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

Para obtener la membresía de la app con la autenticación de 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.

use_admin_access

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 admite obtener membresías de apps en un espacio cuando se usa el acceso de administrador.

GetMessageRequest

Es la solicitud para obtener un mensaje.

Campos

name

string

Obligatorio. Es el nombre del recurso del mensaje.

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

Si estableciste un Custom ID 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.

markup_syntax

MarkupSyntax

Opcional. Especifica la sintaxis de salida deseada para el campo formatted_text del mensaje de chat.

GetSpaceEventRequest

Es el mensaje de solicitud para obtener un evento de espacio.

Campos

name

string

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

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

GetSpaceNotificationSettingRequest

Es el mensaje de solicitud para obtener el parámetro de configuración de notificaciones del espacio. Solo admite obtener el parámetro de configuración de notificaciones para el usuario que llama.

Campos

name

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 emisor en la ruta de acceso.

GetSpaceReadStateRequest

Mensaje de solicitud para la API de GetSpaceReadState.

Campos

name

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 realiza la llamada, 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

GetSpaceRequest

Es una solicitud para devolver un solo espacio.

Campos

name

string

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

Formato: spaces/{space}

use_admin_access

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.

GetThreadReadStateRequest

Mensaje de solicitud para la API de GetThreadReadStateRequest.

Campos

name

string

Obligatorio. Es el nombre del recurso del estado de lectura de la conversación que se recuperará.

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

Para hacer referencia al usuario que realiza la llamada, 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

Grupo

Un Grupo de Google en Google Chat

Campos

name

string

Es el nombre del recurso de un Grupo de Google.

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

Formato: groups/{group}

HistoryState

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

Enums
`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 durante cuánto tiempo se conservan los mensajes y las conversaciones.

ListCustomEmojisRequest

Es una solicitud para mostrar una lista de emojis personalizados.

Campos

page_size

int32

Opcional. Es la cantidad máxima de emojis personalizados que se devuelven. El servicio puede devolver 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.

page_token

string

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

Es un token de página recibido de una llamada anterior para enumerar emojis personalizados. Proporciona esto para recuperar la página siguiente.

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

filter

string

Opcional. Es 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 los emojis personalizados según si los creó el usuario que realiza la llamada o no.

Por ejemplo, la siguiente consulta devuelve los emojis personalizados que creó el emisor:

creator("users/me")

Las consultas no válidas se rechazan con un error INVALID_ARGUMENT.

ListCustomEmojisResponse

Es una respuesta para enumerar los emojis personalizados.

Campos

custom_emojis[]

Lista sin ordenar. Es la lista de emojis personalizados.

next_page_token

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

ListMembershipsRequest

Es el mensaje de solicitud para enumerar membresías.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del espacio del que se recuperará una lista de membresías. Formato: spaces/{space}
`page_size`	`int32` Opcional. Es la cantidad máxima de membresías que se devolverán. Es posible que el servicio devuelva una cantidad inferior a 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 1000, se cambia automáticamente a 1000. Los valores negativos devuelven un error `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Es un token de página, recibido desde una llamada anterior para enumerar las 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 los de la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
`filter`	`string` Opcional. Es 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 por `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 otros filtros de tipo de membresía. 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`.
`show_groups`	`bool` Opcional. Cuando es `true`, también devuelve las membresías asociadas con un `Google Group`, además de otros tipos de membresías. Si se establece un `filter`, no se devuelven las membresías de `Google Group` que no coinciden con los criterios de filtro.
`show_invited`	`bool` Opcional. Cuando es `true`, también devuelve las membresías asociadas con los miembros `invited`, además de otros tipos de membresías. Si se establece un filtro, no se devuelven las membresías de `invited` que no coinciden con los criterios del filtro. Actualmente, requiere la autenticación del usuario.
`use_admin_access`	`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.readonly` o `chat.admin.memberships`. No se admite la creación de listas de membresías de apps en un espacio cuando se usa el acceso de administrador.

ListMembershipsResponse

Es la respuesta para enumerar las membresías del espacio.

Campos

memberships[]

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

next_page_token

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

ListMessagePinsRequest

Es el mensaje de solicitud para enumerar los mensajes fijados.

Campos

parent

string

Obligatorio. Es el espacio superior que posee la colección de elementos fijados. Formato: spaces/{space}

page_size

int32

Opcional. Es la cantidad máxima de mensajes fijados que se devuelven. Es posible que el servicio devuelva menos mensajes que este valor. El valor máximo es 100. Si usas un valor superior a 100, se cambiará automáticamente a 100. Si no se especifica, se devolverán, como máximo, 100 mensajes fijados. Los valores negativos devuelven un error INVALID_ARGUMENT.

page_token

string

Opcional. Es un token de página recibido de una llamada anterior para fijar mensajes de lista. 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 los de la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.

ListMessagePinsResponse

Mensaje de respuesta para enumerar los mensajes fijados.

Campos

message_pins[]

MessagePin

Los mensajes fijados del espacio especificado.

next_page_token

string

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

ListMessagesRequest

Muestra una lista de los mensajes del espacio especificado del que el usuario es miembro.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del espacio del que se enumerarán los mensajes. Formato: `spaces/{space}`
`page_size`	`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 devuelven, como máximo, 25. El valor máximo es 1,000. Si usas un valor superior a 1000, se cambia automáticamente a 1000. Los valores negativos devuelven un error `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Es un token de página recibido de una llamada anterior para mostrar mensajes. 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 los de la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
`filter`	`string` Opcional. Es un filtro de consulta. Puedes filtrar los mensajes por fecha (`create_time`) y conversación (`thread.name`). Para filtrar los 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 conversación, especifica el `thread.name`, con el formato `spaces/{space}/threads/{thread}`. Solo puedes especificar un `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`.
`order_by`	`string` Opcional. Cómo se ordena la lista de mensajes. Especifica un valor para ordenar por una operación de ordenamiento. Los valores válidos de la operación de orden son los siguientes: `ASC` para el orden ascendente `DESC` para orden descendente. El orden predeterminado es `create_time ASC`.
`show_deleted`	`bool` Opcional. Indica si se deben incluir los mensajes borrados. Los mensajes borrados incluyen la hora de eliminación y los metadatos sobre su eliminación, pero el contenido del mensaje no está disponible.
`markup_syntax`	`MarkupSyntax` Opcional. Especifica la sintaxis de salida deseada para el campo `formatted_text` del mensaje de chat.

ListMessagesResponse

Mensaje de respuesta para enumerar mensajes.

Campos

messages[]

Es la lista de mensajes.

next_page_token

string

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

ListReactionsRequest

Enumera las reacciones a un mensaje.

Campos
`parent`	`string` Obligatorio. Es el mensaje al que reaccionaron los usuarios. Formato: `spaces/{space}/messages/{message}`
`page_size`	`int32` Opcional. Es la cantidad máxima de reacciones que se devuelven. El servicio puede devolver 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.
`page_token`	`string` Opcional. (Si se reanuda desde una consulta anterior). Es un token de página recibido de una llamada anterior para enumerar reacciones. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, el valor del filtro debe coincidir con el de la llamada que proporcionó el token de la página. Pasar un valor diferente podría generar resultados inesperados.
`filter`	`string` Opcional. Es un filtro de consulta. Puedes filtrar las reacciones por emoji (`emoji.unicode` o `emoji.custom_emoji.uid`) y usuario (`user.name`). Para filtrar las 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 las 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}"` Las consultas no válidas se rechazan con un error `INVALID_ARGUMENT`.

ListReactionsResponse

Es la respuesta a una solicitud de lista de reacciones.

Campos

reactions[]

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

next_page_token

string

Es el token de continuación para recuperar la siguiente página de resultados. Está vacío para la última página de resultados.

ListSectionItemsRequest

Es el mensaje de solicitud para enumerar los elementos de la sección.

Campos
`parent`	`string` Obligatorio. Es el elemento superior, que es el nombre del recurso de la sección que posee esta colección de elementos de sección. Solo admite la enumeración de elementos de sección para el usuario que realiza la llamada. Cuando filtres por espacio, usa el comodín `-` para buscar en todas las secciones. Por ejemplo, `users/{user}/sections/-` Formato: `users/{user}/sections/{section}`
`page_size`	`int32` Opcional. Es la cantidad máxima de elementos de sección que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 10 elementos de sección. El valor máximo es 100. Si usas un valor superior a 100, se cambiará automáticamente a 100. Los valores negativos devuelven un error `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Es un token de página, recibido desde una llamada anterior a list section items. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con los de la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
`filter`	`string` Opcional. Es un filtro de consulta. Por el momento, solo se admite el filtrado por espacio. Por ejemplo, `space = spaces/{space}`. Las consultas no válidas se rechazan con un error `INVALID_ARGUMENT`.

ListSectionItemsResponse

Mensaje de respuesta para enumerar los elementos de la sección.

Campos

section_items[]

SectionItem

Son los elementos de la sección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListSectionsRequest

Es el mensaje de solicitud para enumerar secciones.

Campos

parent

string

Obligatorio. El elemento superior, que es el nombre del recurso de usuario que posee esta colección de secciones. Solo admite secciones de fichas para el usuario que realiza la llamada. Para hacer referencia al usuario que realiza la llamada, establece una de las siguientes opciones:

El alias me. Por ejemplo, users/me
Su dirección de correo electrónico de Workspace Por ejemplo, users/user@example.com.
Su ID de usuario Por ejemplo, users/123456789.

Formato: users/{user}

page_size

int32

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

Si no se especifica, se devolverán, como máximo, 10 secciones.

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

Los valores negativos devuelven un error INVALID_ARGUMENT.

page_token

string

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

ListSectionsResponse

Mensaje de respuesta para enumerar secciones.

Campos

sections[]

Son las secciones del usuario especificado.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListSpaceEventsRequest

Mensaje de solicitud para enumerar eventos de espacio.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del espacio de Google Chat en el que se produjeron los eventos. Formato: `spaces/{space}`.
`page_size`	`int32` Opcional. Es la cantidad máxima de eventos de espacio que se devuelven. Es posible que el servicio devuelva una cantidad inferior a este valor. Los valores negativos devuelven un error `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Es un token de página, recibido desde una llamada anterior para enumerar eventos de espacio. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados para enumerar los eventos de espacio deben coincidir con los de la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
`filter`	`string` Obligatorio. Es un filtro de consulta. Debes especificar al menos un tipo de evento (`event_type`) con el operador `:`. Para filtrar por varios tipos de eventos, usa el operador `OR`. Omite los tipos de eventos por lotes en tu filtro. La solicitud devuelve automáticamente cualquier evento de lote relacionado. Por ejemplo, si filtras por reacciones nuevas (`google.workspace.chat.reaction.v1.created`), el servidor también devuelve 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 la marca de tiempo exclusiva a partir de la cual se deben comenzar a enumerar los eventos de espacio. Puedes enumerar los eventos que ocurrieron hace hasta 28 días. 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 del espacio. 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 de igualdad `=` 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`.

ListSpaceEventsResponse

Es el mensaje de respuesta para enumerar los eventos de espacio.

Campos

space_events[]

SpaceEvent

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

next_page_token

string

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

ListSpacesRequest

Es una solicitud para enumerar los espacios de los que es miembro el emisor.

Campos

page_size

int32

Opcional. Es la cantidad máxima de espacios que se devolverán. Es posible que el servicio devuelva una cantidad inferior a este valor.

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

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

Los valores negativos devuelven un error INVALID_ARGUMENT.

page_token

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 el de la llamada que proporcionó el token de la página. Pasar un valor diferente puede generar resultados inesperados.

filter

string

Opcional. Es un filtro de consulta.

Puedes filtrar los espacios por tipo (space_type).

Para filtrar por tipo de espacio, debes especificar un valor de enum válido, como SPACE o GROUP_CHAT (el space_type no puede ser SPACE_TYPE_UNSPECIFIED). Para consultar varios tipos de espacios, 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.

ListSpacesResponse

Es la respuesta a una solicitud de lista de espacios.

Campos

spaces[]

MembershipCreatedEventData

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

next_page_token

string

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

MarkAsActiveRequest

Mensaje de la solicitud para el método MarkAsActive.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso de la disponibilidad que se marcará como activa. Formato: users/{user}/availability `{user}` es el ID de la persona en la API de People o en la API de Directory del SDK de Admin. Por ejemplo, `users/123456789` La dirección de correo electrónico del usuario o `me` también se pueden usar como alias para hacer referencia al emisor. Por ejemplo, `users/user@example.com` o `users/me`.
Campo de unión `expiration`. Es el vencimiento del estado de disponibilidad ACTIVE. El usuario se marcará como Ausente después del vencimiento. Si no se proporciona un vencimiento, el estado ACTIVE vencerá 30 minutos después de la hora actual. `expiration` puede ser solo uno de los parámetros siguientes:
`expire_time`	`Timestamp` Es la marca de tiempo absoluta en la que vence el estado ACTIVE.
`ttl`	`Duration` Es la duración desde la hora actual hasta que vence el estado ACTIVO. Usar un TTL corto puede restablecer de manera eficaz el estado del usuario para que se base en la actividad después de esta breve duración.

MarkAsAwayRequest

Mensaje de la solicitud para el método MarkAsAway.

Campos

name

string

Obligatorio. Es el nombre del recurso de la disponibilidad que se marcará como ausente. Formato: users/{user}/availability

{user} es el ID de la persona en la API de People o en la API de Directory del SDK de Admin. Por ejemplo, users/123456789

La dirección de correo electrónico del usuario o me también se pueden usar como alias para hacer referencia al emisor. Por ejemplo, users/user@example.com o users/me.

MarkAsDoNotDisturbRequest

Mensaje de la solicitud para el método MarkAsDoNotDisturb.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso de la disponibilidad que se marcará como No interrumpir. Formato: users/{user}/availability `{user}` es el ID de la persona en la API de People o en la API de Directory del SDK de Admin. Por ejemplo, `users/123456789` La dirección de correo electrónico del usuario o `me` también se pueden usar como alias para hacer referencia al emisor. Por ejemplo, `users/user@example.com` o `users/me`.
Campo de unión `expiration`. Obligatorio. Es el vencimiento del estado de disponibilidad de No interrumpir. El usuario se marcará como Ausente después del vencimiento. Este valor puede ser de 1 año como máximo a partir de la hora actual. `expiration` puede ser solo uno de los parámetros siguientes:
`expire_time`	`Timestamp` Es la marca de tiempo absoluta en la que vence el estado de No interrumpir.
`ttl`	`Duration` Es la duración desde la hora actual hasta que vence el estado de No interrumpir.

MarkupSyntax

Especifica la sintaxis de lenguaje de marcado que se usa para dar formato al texto del mensaje de Chat. Se aplica al campo text del recurso Message.

Enums
`MARKUP_SYNTAX_UNSPECIFIED`	Representa el valor no especificado.
`MARKUP_SYNTAX_CHAT`	Usa la sintaxis de lenguaje de marcado de Google Chat. Consulta https://developers.google.com/workspace/chat/format-messages#format-texts para obtener más información.
`MARKUP_SYNTAX_MARKDOWN`	Usa la sintaxis de Markdown. Esta sintaxis se basa en la especificación de CommonMark, con extensiones adicionales. Consulta https://developers.google.com/workspace/chat/format-messages#format-texts para obtener más información.

MatchedUrl

Una URL coincidente en un mensaje de Chat. Las apps de Chat pueden obtener una vista previa de las URLs que coinciden. Para obtener más información, consulta Obtén una vista previa de los vínculos.

Campos

url

string

Solo salida. Es la URL que coincidió.

MeetSpaceLinkData

Son los datos de los vínculos de los espacios de Meet.

Campos

meeting_code

string

Es el código de reunión del espacio de Meet vinculado.

type

Type

Indica el tipo de sala de reuniones.

huddle_status

HuddleStatus

Opcional. Solo salida. Si la reunión de Meet es una reunión rápida, indica el estado de la reunión rápida. De lo contrario, no se establece.

HuddleStatus

El estado de la reunión

Enums
`HUDDLE_STATUS_UNSPECIFIED`	Es el valor predeterminado de la enumeración. No usar.
`STARTED`	Comenzó el huddle.
`ENDED`	Finalizó el huddle. En este caso, el URI y los identificadores del espacio de Meet ya no serán válidos.
`MISSED`	Se perdió la llamada de huddle. En este caso, el URI y los identificadores del espacio de Meet ya no serán válidos.

Tipo

Es el tipo de espacio de Meet.

Enums
`TYPE_UNSPECIFIED`	Es el valor predeterminado de la enumeración. No usar.
`MEETING`	La sala de reuniones de Meet es una reunión.
`HUDDLE`	La sala de reuniones de Meet es un huddle.

Membresía

Representa una relación de membresía en Google Chat, como si un usuario o una app de Chat están invitados a un espacio, forman parte de él o están ausentes.

Campos
`name`	`string` Es el identificador. Es el nombre del recurso de la membresía, asignado por el servidor. Formato: `spaces/{space}/members/{member}`
`state`	`MembershipState` Solo salida. Es el estado de la membresía.
`role`	`MembershipRole` Opcional. Es el rol del usuario dentro de un espacio de Chat, que determina las acciones que puede realizar en él. Este campo solo se puede usar como entrada en `UpdateMembership`.
`create_time`	`Timestamp` Opcional. Inmutable. La hora de creación de la membresía, como cuando un miembro se unió a un espacio o recibió una invitación para unirse a él. Este campo es de solo salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.
`delete_time`	`Timestamp` Opcional. Inmutable. La hora de eliminación de la membresía, por ejemplo, cuando un miembro abandonó un espacio o se lo quitó de él. Este campo es de solo salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación.
`affiliation`	`Affiliation` Solo salida. Es la relación de un usuario con la organización de Workspace propietaria del espacio. En los espacios que pertenecen a cuentas personales, la afiliación de todos los miembros es `EXTERNAL`.
Campo de unión `memberType`. Es el miembro asociado a esta membresía. Es posible que se admitan otros tipos de miembros en el futuro. `memberType` puede ser solo uno de los parámetros siguientes:
`member`	`User` Opcional. Es el usuario o la app de Google Chat a los que corresponde la membresía. Si tu app de Chat se autentica como usuario, el resultado solo propaga los campos `name` y `type` de user para los usuarios internos y externos, a menos que sean miembros del espacio o tengan una afinidad previa, como una conversación por mensaje directo (MD), con el usuario que llama.
`group_member`	`Group` Opcional. Es el Grupo de Google al que corresponde la membresía. La lectura o mutación de membresías de Grupos de Google requiere la autenticación del usuario.

Afiliación

Representa la afiliación de un usuario a la organización de Google Workspace propietaria del espacio. Es posible que se agreguen más valores a este enum en el futuro.

Enums
`AFFILIATION_UNSPECIFIED`	Valor predeterminado Este valor no se usa.
`INTERNAL`	Una cuenta administrada por la misma organización de Google Workspace propietaria del espacio
`EXTERNAL`	Una cuenta externa a la organización de Google Workspace propietaria del espacio (p. ej., una cuenta personal o una cuenta administrada por otra organización de Workspace)
`MANAGED_EXTERNAL`	Es una cuenta que administra la organización de Workspace propietaria del espacio, pero que se aprovisiona para un usuario externo a la organización (p.ej., un usuario invitado). Para obtener más información sobre los invitados, consulta https://support.google.com/chat/answer/16997417.

MembershipRole

Representa las acciones permitidas de un usuario en un espacio de Chat. Es posible que se agreguen más valores de enumeración en el futuro.

Enums
`MEMBERSHIP_ROLE_UNSPECIFIED`	Valor predeterminado Para `users`: No es miembro del espacio, pero se le puede invitar. Para `Google Groups`: Siempre se les asigna este rol (es posible que se usen otros valores de enumeración en el futuro).
`ROLE_MEMBER`	Un miembro del espacio. En la IU de Chat, este rol se llama Miembro. El usuario tiene permisos básicos, como enviar mensajes al espacio. Los administradores y propietarios pueden otorgarles a los miembros permisos adicionales en un espacio, incluidos los siguientes: Agregar o quitar miembros Modificar detalles del espacio Activar o desactivar el historial Mencionar a todas las personas del espacio con `@all` Administrar las apps de Chat y los webhooks instalados en el espacio En los mensajes directos y las conversaciones grupales sin nombre, todos tienen este rol.
`ROLE_MANAGER`	Un propietario del espacio En la IU de Chat, este rol se llama Propietario. El usuario tiene el conjunto completo de permisos del espacio para administrarlo, incluidos los siguientes: Cambiar el rol de otros miembros del espacio a miembro, administrador o propietario Borrar el espacio. Solo se admite en `SpaceType.SPACE` (espacios con nombre). Para obtener más información, consulta Obtén información sobre tu rol como propietario o administrador de un espacio.
`ROLE_ASSISTANT_MANAGER`	Administrador del espacio En la IU de Chat, este rol se llama Administrador. El usuario tiene todos los permisos básicos de `ROLE_MEMBER`, y un propietario puede otorgarle un subconjunto de permisos administrativos. De forma predeterminada, los administradores tienen todos los permisos de un propietario, excepto la capacidad de realizar las siguientes acciones: Borrar el espacio Convertir a otro miembro del espacio en propietario Cambiar el rol de un propietario De forma predeterminada, los permisos de los administradores incluyen, entre otros, los siguientes: Convertir a otro miembro en administrador Borrar mensajes en el espacio Administrar permisos del espacio Recibir notificaciones de solicitudes para unirse al espacio si el administrador tiene el permiso "Administrar miembros" en la configuración del espacio Cómo hacer que un espacio sea detectable Solo se admite en `SpaceType.SPACE` (espacios con nombre). Para obtener más información, consulta Cómo administrar la configuración de un espacio.

MembershipState

Especifica la relación del miembro con un espacio. Es posible que se admitan otros estados de membresía en el futuro.

Enums
`MEMBERSHIP_STATE_UNSPECIFIED`	Valor predeterminado No usar.
`JOINED`	El usuario se agrega al espacio y puede participar en él.
`INVITED`	Se invita al usuario a unirse al espacio, pero aún no lo hace.
`NOT_A_MEMBER`	El usuario no pertenece al espacio y no tiene una invitación pendiente para unirse a él.

MembershipBatchCreatedEventData

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

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

Campos

memberships[]

Es una lista de membresías nuevas.

MembershipBatchDeletedEventData

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

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

Campos

memberships[]

MembershipDeletedEventData

Es una lista de las membresías borradas.

MembershipBatchUpdatedEventData

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

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

Campos

memberships[]

MembershipUpdatedEventData

Es una lista de membresías actualizadas.

MembershipCreatedEventData

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

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

Campos

membership

Es la membresía nueva.

MembershipDeletedEventData

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

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

Campos

membership

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

MembershipUpdatedEventData

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

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

Campos

membership

MessageCreatedEventData

Es la membresía actualizada.

Mensaje

Un mensaje en un espacio de Google Chat.

Campos
`name`	`string` Es el identificador. Es el nombre del recurso del mensaje. Formato: `spaces/{space}/messages/{message}` Donde `{space}` es el ID del espacio en el que se publica el mensaje y `{message}` es un ID asignado por el sistema para el mensaje. Por ejemplo, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. Si estableces un Custom ID cuando creas un mensaje, puedes usarlo para especificar el mensaje en una solicitud reemplazando `{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.
`sender`	`User` Solo salida. Es el usuario que creó el mensaje. Si tu app de Chat se autentica como usuario, el resultado solo propaga los campos `name` y `type` de user para los usuarios internos y externos, a menos que sean miembros del espacio o tengan una afinidad previa, como una conversación por mensaje directo (MD), con el usuario que llama.
`create_time`	`Timestamp` Opcional. Inmutable. En el caso de los espacios creados en Chat, es la hora en la que se creó el mensaje. Este campo es de solo salida, excepto cuando se usa en espacios en modo de importación. En el caso de los espacios en modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el mensaje en la fuente para conservar la hora de creación original.
`last_update_time`	`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.
`delete_time`	`Timestamp` Solo salida. Es la hora en que se borró el mensaje en Google Chat. Si el mensaje nunca se borra, este campo estará vacío.
`text`	`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 con@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.
`formatted_text`	`string` Solo salida. Contiene el mensaje `text` con lenguaje de marcado agregado para comunicar el formato. Es posible que este campo no capture todo el formato visible en la IU, pero incluye lo siguiente: Sintaxis de lenguaje de marcado para negrita, cursiva, tachado, monoespacio, bloque de monoespacio, lista con viñetas y cita en bloque. 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 de Unicode, como `U+1F600` para un emoji de cara sonriente. Elementos de lista con viñetas que usan asteriscos (``), por ejemplo, ` item`. Para obtener más información, consulta Cómo ver el formato de texto enviado en un mensaje.
`cards[] (deprecated)`	`Card` Este elemento es obsoleto. Obsoleto: Usa `cards_v2` en su lugar. Son tarjetas enriquecidas, con formato e interactivas 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.
`cards_v2[]`	`CardWithId` Opcional. Un array de tarjetas. Las apps de Chat pueden crear tarjetas con la autenticación de la app. Como parte del Programa de versión preliminar para desarrolladores, si tu app de Chat se autentica como usuario, puede crear mensajes de tarjeta. Si tu app de Chat no forma parte del Programa de versión preliminar para desarrolladores, no puede crear tarjetas con autenticación de usuarios. Para aprender a crear un mensaje que contenga tarjetas, consulta Envía un mensaje. Diseña tarjetas y obtén una vista previa de ellas con el Creador de tarjetas. Abre el Creador de tarjetas
`annotations[]`	`Annotation` Solo salida. Las anotaciones se pueden asociar con el cuerpo de texto sin formato del mensaje o con chips que se vinculan a recursos de Google Workspace, como Documentos de Google o Hojas de cálculo de Google, con `start_index` y `length` de 0.
`thread`	`Thread` Es la conversación a la que pertenece el mensaje. Para ver un ejemplo de uso, consulta Cómo iniciar o responder una conversación de mensajes.
`space`	`Space` Solo salida. Si tu app de Chat se autentica como usuario, el resultado solo propaga el espacio `name`.
`fallback_text`	`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, en las notificaciones móviles.
`action_response`	`ActionResponse` Solo entrada. Son los parámetros que puede usar una app de Chat para configurar cómo se publica su respuesta.
`argument_text`	`string` Solo salida. Es el cuerpo de texto sin formato del mensaje sin las menciones de la app de Chat.
`slash_command`	`SlashCommand` Solo salida. Información del comando de barra, si corresponde.
`attachment[]`	`Attachment` Opcional. Es un archivo adjunto subido por el usuario.
`matched_url`	`MatchedUrl` Solo salida. Una URL en el campo `text` del mensaje de Chat que coincida con un patrón de vista previa de vínculo Para obtener más información, consulta Vínculos de vista previa.
`thread_reply`	`bool` Solo salida. Cuando es `true`, el mensaje es una respuesta en un hilo de respuestas. Cuando es `false`, el mensaje es visible en la conversación de nivel superior del espacio como el primer mensaje de un hilo o un mensaje sin respuestas en hilos. Si el espacio no admite respuestas en conversaciones, este campo siempre es `false`.
`silent`	`bool` Solo salida. Indica si se trata de un mensaje silencioso. Los mensajes silenciosos son aquellos en los que Chat suprime las notificaciones push para los destinatarios.
`client_assigned_message_id`	`string` Opcional. Es un ID personalizado para el mensaje. Puedes usar el campo para identificar un mensaje, o bien para obtener, borrar o actualizar un mensaje. Para establecer un Custom ID, especifica el campo `messageId` cuando crees el mensaje. Para obtener más información, consulta Cómo asignar un nombre a un mensaje.
`emoji_reaction_summaries[]`	`EmojiReactionSummary` Solo salida. Es la lista de resúmenes de reacciones con emojis en el mensaje.
`private_message_viewer`	`User` Opcional. Inmutable. Entrada para crear un mensaje; de lo contrario, solo salida. Es 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 la app y omitir lo siguiente: Archivos adjuntos Para obtener más información, consulta Cómo enviar un mensaje privado.
`deletion_metadata`	`DeletionMetadata` Solo salida. Información sobre un mensaje borrado. Un mensaje se borra cuando se establece `delete_time`.
`quoted_message_metadata`	`QuotedMessageMetadata` Opcional. Información sobre un mensaje que cita otro mensaje. Cuando creas un mensaje, puedes citar mensajes dentro de la misma conversación o citar un mensaje raíz para crear uno nuevo. Sin embargo, no puedes citar una respuesta de un mensaje de otro hilo. Cuando actualizas un mensaje, no puedes agregar ni reemplazar el campo `quotedMessageMetadata`, pero puedes quitarlo. Para ver un ejemplo de uso, consulta Cómo citar otro mensaje.
`attached_gifs[]`	`AttachedGif` Solo salida. Imágenes GIF que se adjuntan al mensaje.
`accessory_widgets[]`	`AccessoryWidget` Opcional. Son 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 se admite para mensajes que contienen diálogos. Para obtener más información, consulta Agrega 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.
`elements`	`Elements` Opcional. Los elementos son componentes adicionales que se proporcionan durante la creación del mensaje y que pueden o no estar asociados con partes específicas del texto del mensaje. Estas difieren de las anotaciones, que son de solo salida y ofrecen información complementaria vinculada a fragmentos de mensajes o a todo el texto del mensaje. Versión preliminar para desarrolladores: Está disponible como parte del Programa de versión preliminar para desarrolladores de Google Workspace, que otorga acceso anticipado a ciertas funciones.
`markup_syntax`	`MarkupSyntax` Opcional. Especifica cómo interpreta el servidor el contenido del campo `text` del mensaje.

MessageBatchCreatedEventData

Carga útil del evento para varios mensajes nuevos.

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

Campos

messages[]

Una lista de mensajes nuevos.

MessageBatchDeletedEventData

Carga útil del evento para varios mensajes borrados.

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

Campos

messages[]

MessageDeletedEventData

Una lista de los mensajes borrados.

MessageBatchUpdatedEventData

Carga útil del evento para varios mensajes actualizados.

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

Campos

messages[]

MessageUpdatedEventData

Es una lista de mensajes actualizados.

MessageCreatedEventData

Carga útil del evento para un mensaje nuevo.

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

Campos

message

El mensaje nuevo.

MessageDeletedEventData

Carga útil del evento para un mensaje borrado.

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

Campos

message

Es el mensaje borrado. Solo se completan los campos name, createTime y deletionMetadata.

MessagePin

Un pin en un mensaje de Chat. Para obtener más información, consulta Cómo fijar un mensaje.

Campos

name

string

Es el identificador. Es el nombre del recurso del mensaje fijado. Formato: spaces/{space}/messagePins/{message_pin} El componente de ID del recurso coincide con el componente de ID del recurso del mensaje. Por ejemplo, un mensaje con spaces/AAA/messages/bbb.ccc corresponde al pin del mensaje con el nombre del recurso spaces/AAA/messagePins/bbb.ccc.

message

string

Obligatorio. Inmutable. Es el nombre del recurso del mensaje que se fijó. Formato: spaces/{space}/messages/{message}

MessageUpdatedEventData

Carga útil del evento para un mensaje actualizado.

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

Campos

message

Es el mensaje actualizado.

MoveSectionItemRequest

Es el mensaje de solicitud para mover un elemento de sección entre secciones.

Campos

name

string

Obligatorio. Es el nombre del recurso del elemento de la sección que se moverá.

Formato: users/{user}/sections/{section}/items/{item}

target_section

string

Obligatorio. Es el nombre del recurso de la sección a la que se moverá el elemento de la sección.

Formato: users/{user}/sections/{section}

MoveSectionItemResponse

Es el mensaje de respuesta para mover un elemento de sección.

Campos

section_item

SectionItem

Es el elemento de sección actualizado.

PositionSectionRequest

Es el mensaje de solicitud para posicionar una sección.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso de la sección que se posicionará. Formato: `users/{user}/sections/{section}`
Campo de unión `position`. Obligatorio. Es la nueva posición de la sección. `position` puede ser solo uno de los parámetros siguientes:
`sort_order`	`int32` Opcional. Es la posición absoluta de la sección en la lista de secciones. La posición debe ser mayor que 0. Si la posición es mayor que la cantidad de secciones, la sección se agregará al final de la lista. Esta operación inserta la sección en la posición indicada y desplaza la sección original en esa posición, y las que están debajo de ella, a la siguiente posición.
`relative_position`	`Position` Opcional. Es la posición relativa de la sección en la lista de secciones.

Posición

Es la posición de la sección.

Enums
`POSITION_UNSPECIFIED`	Posición sin especificar.
`START`	Es el inicio de la lista de secciones.
`END`	Fin de la lista de secciones.

PositionSectionResponse

Mensaje de respuesta para posicionar una sección.

Campos

section

ReactionCreatedEventData

La sección actualizada.

QuotedMessageMetadata

Información sobre un mensaje que cita otro mensaje.

Cuando actualizas un mensaje, no puedes agregar ni reemplazar el campo quotedMessageMetadata, pero puedes quitarlo.

Para ver un ejemplo de uso, consulta Cómo citar otro mensaje.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso del mensaje que se cita. Formato: `spaces/{space}/messages/{message}`
`last_update_time`	`Timestamp` Obligatorio. La marca de tiempo de cuando se creó el mensaje citado o de cuando se actualizó por última vez. Si se editó el mensaje, usa este campo, `last_update_time`. Si el mensaje nunca se editó, usa `create_time`. Si `last_update_time` no coincide con la versión más reciente del mensaje citado, la solicitud falla.
`quote_type`	`QuoteType` Opcional. Especifica el tipo de cita. Si no se establece, el valor predeterminado es REPLY en la ruta de acceso de lectura y escritura del mensaje para la retrocompatibilidad.
`quoted_message_snapshot`	`QuotedMessageSnapshot` Solo salida. Es una instantánea del contenido del mensaje citado.
`forwarded_metadata`	`ForwardedMetadata` Solo salida. Son los metadatos sobre el espacio de origen del mensaje citado. Solo se completa para el tipo de cotización FORWARD.

QuoteType

Es el tipo de cita del mensaje citado.

Enums

QUOTE_TYPE_UNSPECIFIED Reservados. Este valor no se usa.

REPLY

Cuando quote_type es REPLY, puedes hacer lo siguiente:

Si respondes en una conversación, puedes citar otro mensaje de esa conversación.
Si estás creando un mensaje raíz, puedes citar otro mensaje raíz en ese espacio.

FORWARD

Cuando quote_type es FORWARD, puedes citar lo siguiente:

Mensaje de un espacio diferente.
Respuesta de un mensaje de un hilo diferente en el mismo espacio.

QuotedMessageSnapshot

Proporciona una instantánea del contenido del mensaje citado en el momento de citarlo o reenviarlo.

Campos
`sender`	`string` Solo salida. El nombre del autor del mensaje citado. Se completa para los tipos de cita REPLY y FORWARD.
`text`	`string` Solo salida. Instantánea del contenido de texto del mensaje citado.
`formatted_text`	`string` Solo salida. Contiene el mensaje citado `text` con lenguaje de marcado agregado para admitir el formato enriquecido, como hipervínculos, emojis personalizados, lenguaje de marcado, etcétera. Solo se completa para el tipo de cita FORWARD.
`annotations[]`	`Annotation` Solo salida. Son las anotaciones analizadas a partir del cuerpo del texto del mensaje citado. Solo se completa para el tipo de cotización FORWARD.
`attachments[]`	`Attachment` Solo salida. Archivos adjuntos que formaban parte del mensaje citado Estas son copias de los metadatos de los archivos adjuntos del mensaje citado. Solo se completa para el tipo de cotización FORWARD.

Reacción

Es una reacción a un mensaje.

Campos

name

string

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

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

user

User

Solo salida. Es el usuario que creó la reacción.

emoji

Emoji

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

ReactionBatchCreatedEventData

Carga útil del evento para varias reacciones nuevas.

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

Campos

reactions[]

Una lista de reacciones nuevas

ReactionBatchDeletedEventData

Carga útil del evento para varias reacciones borradas.

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

Campos

reactions[]

ReactionDeletedEventData

Es una lista de las reacciones borradas.

ReactionCreatedEventData

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

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

Campos

reaction

La reacción nueva.

ReactionDeletedEventData

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

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

Campos

reaction

La reacción borrada.

ReplaceMessageCardsRequest

Es el mensaje de solicitud para el método de la API de ReplaceMessageCards.

Campos

name

string

Obligatorio. Es el nombre del recurso del mensaje.

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

cards_v2[]

CardWithId

Opcional. Es un array de tarjetas que se incluirán en el mensaje. Estas tarjetas reemplazarán las tarjetas existentes del mensaje. Si está vacío, se borrarán las tarjetas originales incluidas en el mensaje.

ReplaceMessageCardsResponse

Este tipo no tiene campos.

Es el mensaje de respuesta de la API de ReplaceMessageCards.

RichLinkMetadata

Es un vínculo enriquecido a un recurso. Los vínculos enriquecidos se pueden asociar con el cuerpo de texto sin formato del mensaje o representar chips que se vinculan a recursos de Google Workspace, como Documentos de Google o Hojas de cálculo de Google, con start_index y length de 0.

Campos
`uri`	`string` Es el URI de este vínculo.
`rich_link_type`	`RichLinkType` Es el tipo de vínculo enriquecido.
Campo de unión `data`. Son los datos del recurso vinculado. `data` puede ser solo uno de los parámetros siguientes:
`drive_link_data`	`DriveLinkData` Son los datos de un vínculo de Drive.
`chat_space_link_data`	`ChatSpaceLinkData` Son los datos de un vínculo a un espacio de Chat.
`meet_space_link_data`	`MeetSpaceLinkData` Son los datos de un vínculo de espacio de Meet.
`calendar_event_link_data`	`CalendarEventLinkData` Son los datos de un vínculo de evento de calendario.

RichLinkType

Es el tipo de vínculo enriquecido. Es posible que se agreguen más tipos en el futuro.

Enums
`RICH_LINK_TYPE_UNSPECIFIED`	Es el valor predeterminado de la enumeración. No usar.
`DRIVE_FILE`	Un tipo de vínculo enriquecido de Google Drive.
`CHAT_SPACE`	Es un tipo de vínculo enriquecido de un espacio de Chat. Por ejemplo, un chip inteligente de espacio.
`GMAIL_MESSAGE`	Un tipo de vínculo enriquecido de mensaje de Gmail. Específicamente, un chip de Gmail de Compartir en Chat. La API solo admite la lectura de mensajes con vínculos enriquecidos de GMAIL_MESSAGE.
`MEET_SPACE`	Es un tipo de vínculo enriquecido de mensajes de Meet. Por ejemplo, un chip de Meet.
`CALENDAR_EVENT`	Es un tipo de vínculo enriquecido de mensaje de calendario. Por ejemplo, un chip de Calendario.

SearchMessageResult

Un solo elemento de resultado de una búsqueda de mensajes.

Campos

message

Es el mensaje coincidente.

space_mute_setting

MuteSetting

Es el parámetro de configuración de silenciamiento del usuario que realiza la llamada para el espacio en el que se publica el mensaje. La app que llama puede usar esta información para decidir cómo procesar el mensaje según si el espacio está silenciado para el usuario o no.

Solo se muestra si la vista de la solicitud es SEARCH_MESSAGES_VIEW_FULL y las credenciales de llamada incluyen el siguiente permiso de autorización:

https://www.googleapis.com/auth/chat.users.spacesettings

read

bool

Indica si el usuario que llama lee el mensaje coincidente.

Solo se devuelve si la vista de la solicitud es SEARCH_MESSAGES_VIEW_FULL y las credenciales de llamada incluyen uno de los siguientes permisos de autorización:

https://www.googleapis.com/auth/chat.users.readstate.readonly
https://www.googleapis.com/auth/chat.users.readstate

SearchMessagesRequest

Es el mensaje de solicitud para buscar mensajes.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del espacio en el que se buscará. Para buscar en todos los espacios a los que tiene acceso el usuario, establece este campo en `spaces/-`. Si usas cualquier otro valor para `parent`, se producirá un error `INVALID_ARGUMENT`. Para limitar la búsqueda a uno o más espacios, usa `space.name` o `space.display_name` en `filter`.
`filter`	`string` Obligatorio. Una búsqueda La consulta puede especificar una o más palabras clave de búsqueda, que se usan para filtrar los resultados, También puedes filtrar los resultados con los siguientes campos de mensaje: `create_time`: Acepta una marca de tiempo en formato RFC-3339 y los operadores de comparación admitidos son: `<` y `>=`. `sender.name`: Es el nombre del recurso del remitente (`users/{user}`). Solo admite `=`. Puedes usar el correo electrónico como alias para `{user}`. Por ejemplo, `users/example@gmail.com`, en el que `example@gmail.com` es el correo electrónico del usuario de Google Chat. `space.name`: Es el nombre del recurso del espacio en el que se publica el mensaje. (`spaces/{space}`). Solo admite `=`. Si no se establece este filtro, la búsqueda se realiza en todos los mensajes directos y espacios a los que el usuario tiene acceso como miembro del espacio. `space.display_name`: Admite el operador `:` (tiene) y filtra los espacios según una coincidencia parcial de su nombre visible. Los resultados se limitan a las cinco coincidencias de espacios más relevantes. Por ejemplo, `space.display_name:Project` busca mensajes en los cinco espacios principales que contienen la palabra "Proyecto" en sus nombres visibles. `space.space_type`: Es el tipo de espacio. Solo admite `=`. Por ejemplo, `space.space_type="DIRECT_MESSAGE"` devuelve solo los mensajes de los mensajes directos. Los valores posibles son `DIRECT_MESSAGE`, `GROUP_CHAT` y `SPACE`. `attachment`: Admite el operador `:` (tiene alguno) para verificar la presencia de archivos adjuntos. Si se especifica `attachment:`, solo se devuelven los mensajes que tienen al menos un archivo adjunto. `annotations.user_mentions.user.name`: Es el nombre del recurso del usuario mencionado (`users/{user}`). Solo admite `:` (tiene). Por ejemplo, `annotations.user_mentions.user.name:"users/1234567890"` solo devuelve los mensajes que contienen una mención al usuario especificado. Como alternativa, se puede usar el alias `me` para filtrar los mensajes que mencionan al usuario que llama, por ejemplo: `annotations.user_mentions.user.name:users/me`. También puedes usar el correo electrónico como alias de `{user}`, por ejemplo, `users/example@gmail.com`. Para el filtrado avanzado, también están disponibles las siguientes funciones: `has_link()`: Muestra solo los mensajes que tienen al menos un hipervínculo en el texto del mensaje. `is_unread()`: Filtra los mensajes que leyó el usuario que realiza la llamada. Para usar los filtros `space.display_name` o `space.space_type`, se requiere que las credenciales de llamada incluyan uno de los siguientes permisos de autorización: `https://www.googleapis.com/auth/chat.spaces.readonly` `https://www.googleapis.com/auth/chat.spaces` Para usar el filtro `is_unread()`, las credenciales de llamada deben incluir uno de los siguientes permisos de autorización: `https://www.googleapis.com/auth/chat.users.readstate.readonly` `https://www.googleapis.com/auth/chat.users.readstate` En los diferentes campos, solo se admiten operadores `AND`. Un ejemplo válido es `sender.name = "users/1234567890" AND is_unread()`. La palabra `AND` es opcional y se da por sentada si se omite. Por ejemplo, `sender.name = "users/1234567890" is_unread()` es válido y equivale al ejemplo anterior. Un ejemplo no válido es `sender.name = "users/1234567890" OR is_unread()` porque no se admite `OR` entre campos diferentes. En el mismo campo: `create_time` solo admite `AND` y solo se puede usar para representar un intervalo, como `create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00"`. `sender.name` solo admite el operador `OR`, por ejemplo: `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`. `space.name` solo admite el operador `OR`, por ejemplo: `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`. `space.display_name` admite los operadores `AND` y `OR`, pero no una combinación de ambos. Por ejemplo: `space.display_name:Project AND space.display_name:Tasks` devuelve mensajes que están en espacios con nombres visibles que contienen `Project` y `Tasks`, mientras que `space.display_name:Project OR space.display_name:Tasks` devuelve mensajes que están en espacios con nombres visibles que contienen `Project` o `Tasks`, o ambos. `space.space_type` solo admite el operador `OR`, por ejemplo: `space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT"`. `annotations.user_mentions.user.name` admite los operadores `AND` y `OR`, pero no una combinación de ambos. Por ejemplo, `annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321"` solo devuelve los mensajes que mencionan a ambos usuarios, mientras que `annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321"` devuelve los mensajes que mencionan a uno de los usuarios o a ambos. Se requieren paréntesis para eliminar la ambigüedad de la prioridad de los operadores cuando se combinan los operadores `AND` y `OR` en la misma consulta. Por ejemplo: `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`. De lo contrario, los paréntesis son opcionales. Las siguientes consultas de ejemplo son válidas: `"Pending reports" AND create_time >= "2023-01-01T00:00:00Z" sender.name = "users/example@gmail.com" annotations.user_mentions.user.name:"users/0987654321" attachment:* AND space.name = "spaces/ABCDEFGH" tasks AND is_unread() AND sender.name = "users/1234567890" "things to do" "urgent" (sender.name = "users/1234567890") AND (create_time < "2023-05-01T00:00:00Z") tasks AND space.name = "spaces/ABCDEFGH" AND has_link() "project one" is_unread() space.display_name:Project tasks` La longitud máxima de la consulta es de 1,000 caracteres. El servidor rechaza las consultas no válidas con un error `INVALID_ARGUMENT`.
`page_size`	`int32` Opcional. La cantidad máxima de resultados que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se devuelven, como máximo, 25. El valor máximo es 100. Si usas un valor superior a 100, se cambiará automáticamente a 100.
`page_token`	`string` Opcional. Es un token que se recibe de la llamada anterior a search messages. 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 los de la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
`order_by`	`string` Opcional. Cómo se ordena la lista de resultados. Los atributos admitidos para ordenar son los siguientes: `create_time`: Ordena los resultados por la hora de creación del mensaje. Valor predeterminado `relevance`: Ordena los resultados por relevancia. (Versión preliminar para desarrolladores de ) El orden predeterminado es `create_time desc`. Solo se admite un orden por consulta (`create_time` o `relevance`). Solo se admite el orden descendente (`desc`), y se debe especificar después del atributo de orden.
`markup_syntax`	`MarkupSyntax` Opcional. Especifica la sintaxis de salida deseada para el campo `formatted_text` del mensaje de chat.
`view`	`SearchMessagesView` Opcional. Especifica qué tipo de vista de resultados de la búsqueda se debe mostrar. El valor predeterminado es `SEARCH_MESSAGES_VIEW_BASIC`.

SearchMessagesView

Son los tipos de vista que se admiten para los resultados de la búsqueda parcial.

Enums
`SEARCH_MESSAGES_VIEW_UNSPECIFIED`	Es el valor predeterminado o no establecido. La API usará la vista BASIC de forma predeterminada.
`SEARCH_MESSAGES_VIEW_BASIC`	Incluye solo los mensajes que coinciden en los resultados, pero no metadatos adicionales. Este es el valor predeterminado.
`SEARCH_MESSAGES_VIEW_FULL`	Incluye todo lo que se encuentra en los resultados: los mensajes que coinciden y los metadatos adicionales.

SearchMessagesResponse

Mensaje de respuesta para buscar mensajes.

Campos

results[]

SearchMessageResult

Es la lista de resultados de la búsqueda que coincidieron con la consulta.

next_page_token

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.

SearchSpacesRequest

Es una solicitud para buscar una lista de espacios según una consulta.

Campos
`use_admin_access`	`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 permiso de OAuth 2.0 `chat.admin.spaces.readonly` o `chat.admin.spaces`.
`page_size`	`int32` Es la cantidad máxima de espacios que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devuelven, como máximo, 100 espacios. El valor máximo es 1,000 cuando `useAdminAccess` se establece en `true`. De lo contrario, el valor máximo es 100. Si usas un valor superior al máximo, se cambiará automáticamente al valor máximo.
`page_token`	`string` Es un token que se recibe de la llamada anterior a searchSpaces. 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 los de la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
`query`	`string` Obligatorio. Una búsqueda Puedes realizar búsquedas con los siguientes parámetros cuando `useAdminAccess` se establece en `true`: `create_time` `customer` `display_name` `external_user_allowed` `last_active_time` `space_history_state` `space_type` Cuando `useAdminAccess` se establece en `false`, ocurre lo siguiente: `display_name` `external_user_allowed` `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 los siguientes: `=`, `<`, `>`, `<=` y `>=`. `customer` es obligatorio cuando `useAdminAccess` se establece en `true` 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` (`:`). Primero, el texto que se debe hacer coincidir se convierte en tokens, y cada token se hace coincidir con el prefijo sin distinguir mayúsculas de minúsculas y de forma independiente como una subcadena en cualquier parte del `display_name` del espacio. Por ejemplo, `Fun Eve` coincide con `Fun event` o `The evening was fun`, pero no con `notFun event` ni `even`. Cuando `useAdminAccess` se establece en `false`, se requiere `display_name` para recuperar resultados significativos. De lo contrario, el comportamiento predeterminado es devolver una respuesta vacía. `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 los 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 cuando `useAdminAccess` se establece en `true`: 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") Las siguientes consultas de ejemplo son válidas cuando `useAdminAccess` se establece en `false`: `display_name:"Hello World" AND space_type = "SPACE" (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE" (external_user_allowed = "true" AND space_type = "SPACE") // Returns an empty response. (external_user_allowed = "true" AND display_name:"Hello" AND space_type = "SPACE")` La longitud máxima de la consulta es de 1,000 caracteres. El servidor rechaza las consultas no válidas con un error `INVALID_ARGUMENT`.
`order_by`	`string` Opcional. Cómo se ordena la lista de espacios Los atributos admitidos 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 la hora en que se agregó el último elemento apto a cualquier tema de este espacio. `create_time`: Indica la hora de creación del espacio. Cuando `useAdminAccess` es `false`, solo se admiten `create_time` y `relevance` para ordenar. Solo se admite `DESC` para estos campos en las búsquedas que no son de administrador. Los valores válidos de la operación de orden son los siguientes: `ASC` para el orden ascendente Valor predeterminado `DESC` para orden descendente. La sintaxis admitida es cuando `useAdminAccess` se establece en `true`: `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` Cuando `useAdminAccess` se establece en `false`, ocurre lo siguiente: `create_time DESC` `relevance DESC` (Versión preliminar para desarrolladores de )

SearchSpacesResponse

Respuesta con una lista de espacios que corresponden a la solicitud de búsqueda de espacios.

Campos
`spaces[] (deprecated)`	`Space` Este elemento es obsoleto. Obsoleto: Usa el nuevo campo `results` en su lugar. Es una página de los espacios solicitados. Este campo solo se completará cuando `useAdminAccess` se establezca en `true` y se dará de baja en favor del nuevo campo `results`.
`next_page_token`	`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. Solo se completa cuando `useAdminAccess` se establece en `true`.
`total_size`	`int32` Es la cantidad total de espacios que coinciden con la consulta en todas las páginas. Si el resultado supera los 10,000 espacios, este valor es una estimación. Solo se completa cuando `useAdminAccess` se establece en `true`.
`results[]`	`SearchSpaceResult` Solo salida. Es la lista de resultados de la búsqueda que coincidieron con la consulta.

SearchSpaceResult

Es un solo elemento de resultado de una búsqueda de espacio.

Campos

space

Solo salida. Es el espacio coincidente.

Sección

Representa una sección en Google Chat. Las secciones ayudan a los usuarios a organizar sus espacios. Existen dos tipos de secciones:

Secciones del sistema: Son secciones predefinidas que administra Google Chat. Sus nombres de recursos son fijos y no se pueden crear ni borrar, ni se puede modificar su display_name. Los siguientes son algunos ejemplos:
- users/{user}/sections/default-direct-messages
- users/{user}/sections/default-spaces
- users/{user}/sections/default-apps
Secciones personalizadas: Son secciones que crea y administra el usuario. Para crear una sección personalizada con CreateSection, se requiere un display_name. Las secciones personalizadas se pueden actualizar con UpdateSection y borrar con DeleteSection.

Campos
`name`	`string` Es el identificador. Es el nombre del recurso de la sección. En el caso de las secciones del sistema, el ID de sección es una cadena constante: DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` DEFAULT_SPACES: `users/{user}/sections/default-spaces` DEFAULT_APPS: `users/{user}/sections/default-apps` Formato: `users/{user}/sections/{section}`
`display_name`	`string` Opcional. Es el nombre visible de la sección. Solo se propaga para las secciones de tipo `CUSTOM_SECTION`. Admite hasta 80 caracteres. Es obligatorio cuando se crea un `CUSTOM_SECTION`.
`sort_order`	`int32` Solo salida. Es el orden de la sección en relación con otras secciones. Las secciones con un valor de `sort_order` más bajo aparecen antes que las secciones con un valor más alto.
`type`	`SectionType` Obligatorio. Es el tipo de sección.

SectionType

Tipos de secciones.

Enums
`SECTION_TYPE_UNSPECIFIED`	Tipo de sección sin especificar.
`CUSTOM_SECTION`	Sección personalizada.
`DEFAULT_DIRECT_MESSAGES`	Es la sección predeterminada que contiene espacios de DIRECT_MESSAGE entre dos usuarios humanos o de GROUP_CHAT que no pertenecen a ninguna sección personalizada.
`DEFAULT_SPACES`	Son los espacios predeterminados que no pertenecen a ninguna sección personalizada.
`DEFAULT_APPS`	Es la sección predeterminada que contiene las apps instaladas de un usuario.

SectionItem

Es un elemento de sección definido por el usuario. Se usa para representar elementos de sección, como espacios, agrupados en una sección.

Campos

name

string

Es el identificador. Es el nombre del recurso del elemento de la sección.

Formato: users/{user}/sections/{section}/items/{item}

Campo de unión item. Obligatorio. Es el elemento de la sección. item puede ser solo uno de los parámetros siguientes:

space

string

Opcional. Es el nombre del recurso del espacio.

Formato: spaces/{space}

SetUpSpaceRequest

Solicita crear un espacio y agregar usuarios específicos a él.

Campos

space

Obligatorio. El campo Space.spaceType es obligatorio.

Para crear un espacio, establece Space.spaceType en SPACE y configura 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 establezcas 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 un humano y la app de Chat que llama, establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true. No configures Space.displayName ni Space.spaceDetails.

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

request_id

string

Para usar este campo de forma eficaz, haz lo siguiente:

Asegúrate de que las solicitudes posteriores sean idénticas y usen las mismas credenciales de autenticación que la solicitud original.
Si ya se creó un espacio con el ID de solicitud proporcionado, la solicitud devuelve ese espacio. Ten en cuenta que es posible que el espacio devuelto no esté completamente propagado. La API replica el espacio de tu solicitud con el nombre del recurso asignado por el sistema propagado. Para recuperar los metadatos más recientes del espacio, llama a GetSpace.
Si reutilizas un ID de solicitud existente con un usuario autenticado diferente, se producirá un error.

memberships[]

AccessPermissionSetting

Opcional. Son los usuarios o grupos de Google Chat a los que se invitará a unirse al espacio. Omite al usuario que llama, ya que se agrega automáticamente.

Actualmente, el conjunto permite hasta 49 membresías (además del emisor de la llamada).

En el caso de 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 (solo se admite agregar apps de Chat para configurar mensajes directos con la app de llamadas). También puedes agregar miembros con el correo electrónico del usuario como alias de {user}. Por ejemplo, el user.name puede ser users/example@gmail.com. Para invitar a usuarios de Gmail o a usuarios de dominio de Google Workspace externos, se debe usar el correo electrónico del usuario para {user}.

Para la membresía de un Grupo 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.

Es opcional cuando se establece Space.spaceType en SPACE.

Es obligatorio cuando se configura Space.spaceType como GROUP_CHAT, junto con al menos dos membresías.

Es obligatorio cuando se configura Space.spaceType como 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 un humano y la app de Chat que llama (cuando se establece Space.spaceType en DIRECT_MESSAGE y Space.singleUserBotDm en true).

SlashCommand

Metadatos sobre un comando de barra en Google Chat.

Campos

command_id

int64

Es el ID del comando de barra.

SlashCommandMetadata

Metadatos de anotación para los comandos de barra (/).

Campos
`bot`	`User` Es la app de Chat cuyo comando se invocó.
`type`	`Type` Es el tipo de comando de barra.
`command_name`	`string` Es el nombre del comando de barra que se invocó.
`command_id`	`int64` Es el ID del comando de barra que se invocó.
`triggers_dialog`	`bool` Indica si el comando de barra es para un diálogo.

Tipo

Enums
`TYPE_UNSPECIFIED`	Es el valor predeterminado de la enumeración. No usar.
`ADD`	Agrega la app de Chat al espacio.
`INVOKE`	Invocar un comando de barra en un espacio

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.

Campos
`name`	`string` Es el identificador. Es el nombre del recurso del espacio. Formato: `spaces/{space}` Donde `{space}` representa el ID asignado por el sistema para el espacio. Puedes obtener el ID del espacio llamando 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 (deprecated)`	`Type` Este elemento es obsoleto. Solo salida. Obsoleto: Usa `space_type` en su lugar. Es el tipo de espacio.
`space_type`	`SpaceType` Opcional. Es el tipo de espacio. Es obligatorio cuando se crea un espacio o se actualiza su tipo. Solo salida para otros usos.
`single_user_bot_dm`	`bool` Opcional. Indica si el espacio es un MD entre una app de Chat y un solo usuario.
`threaded (deprecated)`	`bool` Este elemento es obsoleto. Solo salida. Obsoleto: Usa `spaceThreadingState` en su lugar. Indica si los mensajes se agrupan en hilos en este espacio.
`display_name`	`string` Opcional. Es el nombre visible del espacio. Es 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 un `displayName` diferente. 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.
`external_user_allowed`	`bool` Opcional. Inmutable. Indica si este espacio permite que cualquier usuario de Google Chat sea miembro. Es la entrada que se usa 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 personal (cuenta de usuario no administrada). De forma predeterminada, un espacio creado por una cuenta personal permite a cualquier usuario de Google Chat. Para los espacios existentes, este campo es de solo salida.
`space_threading_state`	`SpaceThreadingState` Solo salida. Es el estado de las conversaciones en el espacio de Chat.
`space_details`	`SpaceDetails` Opcional. Detalles sobre el espacio, incluidos la descripción y las reglas.
`space_history_state`	`HistoryState` Opcional. Es el estado del historial de mensajes y conversaciones de este espacio.
`import_mode`	`bool` Opcional. Indica si este espacio se creó 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 complete la importación. Para crear un espacio en `Import Mode`, se requiere la autenticación del usuario.
`create_time`	`Timestamp` Opcional. Inmutable. En el caso de los espacios creados en Chat, la hora en que se creó el espacio. Este campo es de solo salida, excepto cuando se usa en espacios en modo de importación. En el caso de los espacios en modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el espacio en la fuente para conservar la hora de creación original. Solo se propaga en el resultado cuando `spaceType` es `GROUP_CHAT` o `SPACE`.
`last_active_time`	`Timestamp` Solo salida. Es la marca de tiempo del último mensaje del espacio.
`admin_installed`	`bool` Solo salida. En el caso de los espacios de mensajes directos (MD) con una app de Chat, si el espacio lo creó 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 de administrador, tu app de Chat debe incluir la mensajería directa.
`membership_count`	`MembershipCount` Solo salida. Es el recuento de membresías unidas agrupadas por tipo de miembro. Se propaga cuando el `space_type` es `SPACE`, `DIRECT_MESSAGE` o `GROUP_CHAT`.
`access_settings`	`AccessSettings` Opcional. Especifica el parámetro de configuración de acceso del espacio. Solo se completa cuando el `space_type` es `SPACE`.
`space_uri`	`string` Solo salida. Es el URI para que un usuario acceda al espacio.
`import_mode_expire_time`	`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 con `spaces.completeImport`. Este campo solo se completa para los espacios que se crearon con el modo de importación.
`customer`	`string` Opcional. Inmutable. Es el ID de cliente del dominio del espacio. Solo se requiere cuando se crea un espacio con autenticación de la app y `SpaceType` es `SPACE`; de lo contrario, no se debe establecer. En el formato `customers/{customer}`, en el que `customer` es el `id` del recurso de cliente del SDK de Admin. 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. Este campo no se completa para los mensajes directos (MD) ni cuando el espacio lo crean usuarios que no son de Google Workspace.
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 uno de los siguientes:
`predefined_permission_settings`	`PredefinedPermissionSettings` Opcional. Solo entrada. Configuración predefinida de permisos del espacio, que solo se ingresa cuando se crea un espacio. Si no se establece el campo, se crea un espacio de colaboración. Después de crear el espacio, los parámetros de configuración se propagan en el campo `PermissionSettings`. La configuración de permisos predefinidos admite lo siguiente: Autenticación de la app con la aprobación del administrador con los permisos `chat.app.spaces` o `chat.app.spaces.create`. Autenticación de usuarios
`permission_settings`	`PermissionSettings` Opcional. Configuración de permisos de los espacios existentes Entrada para actualizar la configuración exacta de los permisos de espacio, en la que se reemplaza la configuración de permisos existente. En el resultado, se muestra la configuración de permisos actual. La lectura y actualización de la configuración de permisos admite lo siguiente: Autenticación de la app con aprobación del administrador con el permiso `chat.app.spaces`. Solo se completa y se puede configurar cuando la app de Chat creó el espacio. Autenticación de usuarios

AccessPermissionSetting

Es un parámetro de configuración de permisos de acceso.

Campos

principals[]

Principal

Opcional. Lista sin ordenar. Son las principales permitidas para este permiso.

AccessPermissionSettings

Acceder a la configuración de permisos de un espacio

Campos

discover_space_setting

Opcional. Es el parámetro de configuración de permisos de acceso para descubrir el espacio.

join_space_setting

AccessPermissionSetting

Opcional. Es el parámetro de configuración de permisos de acceso para unirse al espacio.

view_space_membership_setting

AccessPermissionSetting

Opcional. Es el parámetro de configuración de permisos de acceso para ver la membresía del espacio. Se debe especificar junto con PermissionSettings.view_space_membership en la máscara de actualización y el cuerpo de la solicitud cuando se actualiza quién puede ver la membresía del espacio. Cuando otorgas acceso de lectura a un público objetivo, también debes otorgar PermissionSettings.view_space_membership a todos los miembros en la misma solicitud. Para quitar un público objetivo existente (por ejemplo, para restringir el acceso de lectura solo a los administradores o subadministradores del espacio), especifica un AccessPermissionSetting vacío (sin principals).

AccessSettings

Representa el parámetro de configuración de acceso del espacio.

Campos

access_state

AccessState

Solo salida. Indica el estado de acceso del espacio.

audience

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 que contiene. Si no se establece, solo podrán acceder al espacio los usuarios o Grupos de Google que se hayan invitado o agregado individualmente. 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 el valor en audiences/default.

Leer los apoyos para el público objetivo

Autenticación de usuarios
Autenticación de la app con aprobación del administrador con el permiso chat.app.spaces.

Este campo no se completa cuando se usa el permiso chat.bot con la autenticación de la app.

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

access_permission_settings

AccessPermissionSettings

Opcional. Acceder a la configuración de permisos del espacio

Para establecer el público objetivo cuando creas un espacio, especifica el campo accessSettings.audience en tu solicitud.

AccessState

Representa el estado de acceso del espacio.

Enums

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 otorgó acceso al espacio a un público objetivo. Los usuarios o Grupos de Google que se hayan agregado o invitado individualmente al espacio también podrán 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.

MembershipCount

Representa el recuento de membresías de un espacio, agrupadas en categorías.

Campos

joined_direct_human_user_count

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 una membresía en un grupo unido.

joined_group_count

int32

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

PermissionSetting

Representa un parámetro de configuración de permisos de un espacio.

Campos

managers_allowed

bool

Opcional. Indica si los propietarios del espacio (ROLE_MANAGER) tienen este permiso.

members_allowed

bool

Opcional. Indica si los miembros básicos del espacio (ROLE_MEMBER) tienen este permiso.

assistant_managers_allowed

bool

Opcional. Indica si los administradores del espacio (ROLE_ASSISTANT_MANAGER) tienen este permiso.

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.

Campos
`manage_members_and_groups`	`PermissionSetting` Opcional. Parámetro de configuración para administrar miembros y grupos en un espacio.
`modify_space_details`	`PermissionSetting` Opcional. Parámetro para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio.
`toggle_history`	`PermissionSetting` Opcional. Es el parámetro de configuración para activar y desactivar el historial del espacio.
`use_at_mention_all`	`PermissionSetting` Opcional. Parámetro de configuración para usar @todos en un espacio.
`manage_apps`	`PermissionSetting` Opcional. Parámetro de configuración para administrar apps en un espacio.
`manage_webhooks`	`PermissionSetting` Opcional. Parámetro para administrar webhooks en un espacio.
`post_messages`	`PermissionSetting` Solo salida. Es el parámetro de configuración para publicar mensajes en un espacio.
`reply_messages`	`PermissionSetting` Opcional. Es el parámetro de configuración para responder mensajes en un espacio.
`view_space_membership`	`PermissionSetting` Opcional. Es el parámetro de configuración para ver la membresía del espacio. Se debe especificar junto con `AccessPermissionSettings.view_space_membership_setting` en la máscara de actualización y el cuerpo de la solicitud cuando se actualiza quién puede ver la membresía del espacio. Cuando restrinjas el acceso de lectura a roles específicos (por ejemplo, solo administradores de espacios o administradores asistentes), especifica los permisos de rol deseados aquí y proporciona un `AccessPermissionSettings.view_space_membership_setting` vacío en la misma solicitud. Si se configura un público objetivo en `AccessPermissionSettings.view_space_membership_setting`, este parámetro de configuración se debe otorgar a todos los miembros.

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 con nombre, consulta Más información sobre los espacios.

Enums
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	Sin especificar. No usar.
`COLLABORATION_SPACE`	Parámetro de configuración para que el espacio sea un espacio de colaboración en el que todos los miembros puedan publicar mensajes.
`ANNOUNCEMENT_SPACE`	Parámetro de configuración para que el espacio sea de anuncios, en el que solo los administradores del espacio pueden publicar mensajes.

Principal

Es una principal que representa una entidad a la que se le otorgó acceso.

Campos

Campo de unión principal_type. Es el tipo de principal. principal_type puede ser solo uno de los parámetros siguientes:

audience

Audience

Un público

SpaceDetails

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

Campos

description

string

Opcional. Es una descripción del espacio. Por ejemplo, describe el tema de conversación, el propósito funcional o los participantes del espacio.

Admite hasta 4,096 caracteres.

guidelines

string

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

Admite hasta 5,000 caracteres.

SpaceThreadingState

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

Enums
`SPACE_THREADING_STATE_UNSPECIFIED`	Reservados.
`THREADED_MESSAGES`	Espacios que admiten hilos de mensajes Cuando los usuarios responden un mensaje, pueden hacerlo en un hilo, 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`	Espacios que no admiten conversaciones de mensajes Este estado de hilos de conversación del espacio solo se usa en casos especiales, como los siguientes: Chat continuo de la reunión en el que se desactivaron las conversaciones de forma intencional Conversaciones grupales heredadas que se crearon antes de 2022

SpaceType

Es el tipo de espacio. Es obligatorio cuando se crea o actualiza un espacio. Solo salida para otros usos.

Enums
`SPACE_TYPE_UNSPECIFIED`	Reservados.
`SPACE`	Es 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

Tipo

Obsoleto: Usa SpaceType en su lugar.

Enums
`TYPE_UNSPECIFIED`	Reservados.
`ROOM`	Conversaciones entre dos o más humanos
`DM`	Mensaje directo 1:1 entre un humano 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.

SpaceBatchUpdatedEventData

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

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

Campos

spaces[]

SpaceUpdatedEventData

Es una lista de los espacios actualizados.

SpaceEvent

Es un evento que representa un cambio o una actividad en un espacio de Google Chat. Para obtener más información, consulta Trabaja con eventos de Google Chat.

Campos
`name`	`string` Es el nombre del recurso del evento de espacio. Formato: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` Es la hora en que se produjo el evento.
`event_type`	`string` Es el tipo de evento de espacio. 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. Para las solicitudes `spaceEvents.list()`, omite los tipos de eventos por lotes en el filtro de consulta. De forma predeterminada, el servidor devuelve el tipo de evento y su versión por lotes. Tipos de eventos admitidos para los 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` Se borró la membresía: `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` Se borraron varias reacciones: `google.workspace.chat.reaction.v1.batchDeleted` Tipos de eventos admitidos sobre el espacio: Se actualizó el espacio: `google.workspace.chat.space.v1.updated` Varias actualizaciones del espacio: `google.workspace.chat.space.v1.batchUpdated`
Campo de unión `payload`. `payload` puede ser una de las siguientes opciones:
`message_created_event_data`	`MessageCreatedEventData` Carga útil del evento para un mensaje nuevo. Tipo de evento: `google.workspace.chat.message.v1.created`
`message_updated_event_data`	`MessageUpdatedEventData` Carga útil del evento para un mensaje actualizado. Tipo de evento: `google.workspace.chat.message.v1.updated`
`message_deleted_event_data`	`MessageDeletedEventData` Carga útil del evento para un mensaje borrado. Tipo de evento: `google.workspace.chat.message.v1.deleted`
`message_batch_created_event_data`	`MessageBatchCreatedEventData` Carga útil del evento para varios mensajes nuevos. Tipo de evento: `google.workspace.chat.message.v1.batchCreated`
`message_batch_updated_event_data`	`MessageBatchUpdatedEventData` Carga útil del evento para varios mensajes actualizados. Tipo de evento: `google.workspace.chat.message.v1.batchUpdated`
`message_batch_deleted_event_data`	`MessageBatchDeletedEventData` Carga útil del evento para varios mensajes borrados. Tipo de evento: `google.workspace.chat.message.v1.batchDeleted`
`space_updated_event_data`	`SpaceUpdatedEventData` Es la carga útil del evento para una actualización de espacio. Tipo de evento: `google.workspace.chat.space.v1.updated`
`space_batch_updated_event_data`	`SpaceBatchUpdatedEventData` Carga útil del evento para varias actualizaciones de un espacio. Tipo de evento: `google.workspace.chat.space.v1.batchUpdated`
`membership_created_event_data`	`MembershipCreatedEventData` Carga útil del evento para una membresía nueva. Tipo de evento: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` Carga útil del evento para una membresía actualizada. Tipo de evento: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` Carga útil del evento para una membresía borrada. Tipo de evento: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` Carga útil del evento para varias membresías nuevas. Tipo de evento: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` Carga útil del evento para varias membresías actualizadas. Tipo de evento: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` Carga útil del evento para varias membresías borradas. Tipo de evento: `google.workspace.chat.membership.v1.batchDeleted`
`reaction_created_event_data`	`ReactionCreatedEventData` Carga útil del evento para una reacción nueva. Tipo de evento: `google.workspace.chat.reaction.v1.created`
`reaction_deleted_event_data`	`ReactionDeletedEventData` Carga útil del evento para una reacción borrada. Tipo de evento: `google.workspace.chat.reaction.v1.deleted`
`reaction_batch_created_event_data`	`ReactionBatchCreatedEventData` Carga útil del evento para varias reacciones nuevas. Tipo de evento: `google.workspace.chat.reaction.v1.batchCreated`
`reaction_batch_deleted_event_data`	`ReactionBatchDeletedEventData` Carga útil del evento para varias reacciones borradas. Tipo de evento: `google.workspace.chat.reaction.v1.batchDeleted`

SpaceNotificationSetting

Es el parámetro de configuración de notificaciones de un usuario en un espacio.

Campos

name

string

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

notification_setting

NotificationSetting

Es el parámetro de configuración de notificaciones.

mute_setting

MuteSetting

Es el parámetro de configuración para silenciar las notificaciones del espacio.

MuteSetting

Son los tipos de configuración de silenciamiento de notificaciones del espacio.

Enums
`MUTE_SETTING_UNSPECIFIED`	Reservados.
`UNMUTED`	El usuario recibirá notificaciones del espacio según el parámetro de configuración de notificaciones.
`MUTED`	El usuario no recibirá ninguna notificación del espacio, independientemente de la configuración de notificaciones.

NotificationSetting

Son los tipos de configuración de notificaciones. Es posible que se admitan otros tipos en el futuro.

Enums
`NOTIFICATION_SETTING_UNSPECIFIED`	Reservados.
`ALL`	Las notificaciones se activan con las @menciones, los hilos seguidos y el primer mensaje de los hilos nuevos. Todos los hilos nuevos se siguen automáticamente, a menos que el usuario deje de seguirlos de forma manual.
`MAIN_CONVERSATIONS`	La notificación se activa con @menciones, conversaciones seguidas y el primer mensaje de conversaciones nuevas. No está disponible para los mensajes directos 1:1.
`FOR_YOU`	La notificación se activa con las @menciones y las conversaciones que sigues. No está disponible para los mensajes directos 1:1.
`OFF`	La notificación está desactivada.

SpaceReadState

Es el estado de lectura de un usuario dentro de un espacio, que se usa para identificar los mensajes leídos y no leídos.

Campos

name

string

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

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

last_read_time

Timestamp

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

SpaceUpdatedEventData

Carga útil del evento para un espacio actualizado.

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

Campos

space

Es el espacio actualizado.

SpaceView

Es una vista que especifica qué campos se deben propagar en el recurso Space. Para garantizar la compatibilidad con versiones futuras, te recomendamos que tu código tenga en cuenta los valores adicionales.

Enums
`SPACE_VIEW_UNSPECIFIED`	Es el valor predeterminado o no establecido.
`SPACE_VIEW_RESOURCE_NAME_ONLY`	Solo propaga el nombre del recurso Space.
`SPACE_VIEW_EXPANDED`	Propaga los campos de recursos de Space. Nota: No se completará el campo `permissionSettings`. Las solicitudes que especifican SPACE_VIEW_EXPANDED deben incluir permisos que permitan leer datos de espacios, por ejemplo, https://www.googleapis.com/auth/chat.spaces o https://www.googleapis.com/auth/chat.spaces.readonly.

Thread

Un hilo en un espacio de Google Chat. Para ver un ejemplo de uso, consulta Cómo iniciar o responder una conversación de mensajes.

Si especificas una conversación cuando creas un mensaje, puedes configurar el campo messageReplyOption para determinar qué sucede si no se encuentra ninguna conversación coincidente.

Campos

name

string

Es el identificador. Es el nombre del recurso del hilo.

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

thread_key

string

Opcional. Entrada para crear o actualizar una conversación. De lo contrario, solo salida. Es el ID del hilo. 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.

ThreadReadState

Es el estado de lectura de un usuario dentro de una conversación, que se usa para identificar los mensajes leídos y no leídos.

Campos

name

string

Es el nombre del recurso del estado de lectura de la conversación.

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

last_read_time

Timestamp

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

UpdateAvailabilityRequest

Mensaje de la solicitud para el método UpdateAvailability.

Campos

availability

Availability

Obligatorio. Es la disponibilidad que se actualizará.

update_mask

Obligatorio. La lista de campos que se deben actualizar. El único campo que se puede actualizar es custom_status.

UpdateMembershipRequest

Es el mensaje de solicitud para actualizar una membresía.

Campos

membership

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

update_mask

Obligatorio. Son las rutas de acceso de los campos que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de acceso de los campos.

Rutas de campo admitidas actualmente:

role

use_admin_access

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.

UpdateMessageRequest

Es la solicitud para actualizar un mensaje.

Campos

message

Obligatorio. Es el mensaje con los campos actualizados.

update_mask

Obligatorio. Son las rutas de acceso de los campos que se actualizarán. Separa varios valores con comas o usa * para actualizar todas las rutas de acceso de los campos.

Rutas de campo admitidas actualmente:

text
attachment
cards (requiere autenticación de la app)
cards_v2 (requiere autenticación de la app)
accessory_widgets (requiere autenticación de la app)
quoted_message_metadata (solo permite quitar el mensaje citado)

allow_missing

bool

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

UpdateSectionRequest

Es el mensaje de solicitud para actualizar una sección.

Campos

section

Obligatorio. Es la sección que se actualizará.

update_mask

SpaceNotificationSetting

Obligatorio. Es la máscara para especificar qué campos se deben actualizar.

Rutas de campo admitidas actualmente:

display_name

UpdateSpaceNotificationSettingRequest

Solicita actualizar la configuración de notificaciones del espacio. Solo admite la actualización de la configuración de notificaciones para el usuario que llama.

Campos

space_notification_setting

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

update_mask

Obligatorio. Rutas de campo admitidas:

notification_setting
mute_setting

UpdateSpaceReadStateRequest

Mensaje de solicitud para la API de UpdateSpaceReadState.

Campos

space_read_state

SpaceReadState

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

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

Para hacer referencia al usuario que realiza la llamada, 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

update_mask

Obligatorio. Son las rutas de acceso de los campos 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. La last_read_time se fuerza para que coincida 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 y, en su lugar, dependen del estado de lectura de la conversación.

UpdateSpaceRequest

Es una solicitud para actualizar un solo espacio.

Campos

space

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

update_mask