Índice
ChatService
(interfaz)AccessoryWidget
(mensaje)ActionResponse
(mensaje)ActionResponse.ResponseType
(enumeración)ActionResponse.SelectionItems
(mensaje)ActionResponse.UpdatedWidget
(mensaje)ActionStatus
(mensaje)Annotation
(mensaje)AnnotationType
(enumeración)AttachedGif
(mensaje)Attachment
(mensaje)Attachment.Source
(enumeración)AttachmentDataRef
(mensaje)CardWithId
(mensaje)ChatSpaceLinkData
(mensaje)CompleteImportSpaceRequest
(mensaje)CompleteImportSpaceResponse
(mensaje)ContextualAddOnMarkup
(mensaje)ContextualAddOnMarkup.Card
(mensaje)ContextualAddOnMarkup.Card.CardAction
(mensaje)ContextualAddOnMarkup.Card.CardHeader
(mensaje)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enumeración)ContextualAddOnMarkup.Card.Section
(mensaje)CreateMembershipRequest
(mensaje)CreateMessageRequest
(mensaje)CreateMessageRequest.MessageReplyOption
(enumeración)CreateReactionRequest
(mensaje)CreateSpaceRequest
(mensaje)CustomEmoji
(mensaje)DeleteMembershipRequest
(mensaje)DeleteMessageRequest
(mensaje)DeleteReactionRequest
(mensaje)DeleteSpaceRequest
(mensaje)DeletionMetadata
(mensaje)DeletionMetadata.DeletionType
(enumeración)Dialog
(mensaje)DialogAction
(mensaje)DriveDataRef
(mensaje)DriveLinkData
(mensaje)Emoji
(mensaje)EmojiReactionSummary
(mensaje)FindDirectMessageRequest
(mensaje)GetAttachmentRequest
(mensaje)GetMembershipRequest
(mensaje)GetMessageRequest
(mensaje)GetSpaceEventRequest
(mensaje)GetSpaceReadStateRequest
(mensaje)GetSpaceRequest
(mensaje)GetThreadReadStateRequest
(mensaje)Group
(mensaje)HistoryState
(enumeración)ListMembershipsRequest
(mensaje)ListMembershipsResponse
(mensaje)ListMessagesRequest
(mensaje)ListMessagesResponse
(mensaje)ListReactionsRequest
(mensaje)ListReactionsResponse
(mensaje)ListSpaceEventsRequest
(mensaje)ListSpaceEventsResponse
(mensaje)ListSpacesRequest
(mensaje)ListSpacesResponse
(mensaje)MatchedUrl
(mensaje)Membership
(mensaje)Membership.MembershipRole
(enumeración)Membership.MembershipState
(enumeración)MembershipBatchCreatedEventData
(mensaje)MembershipBatchDeletedEventData
(mensaje)MembershipBatchUpdatedEventData
(mensaje)MembershipCreatedEventData
(mensaje)MembershipDeletedEventData
(mensaje)MembershipUpdatedEventData
(mensaje)Message
(mensaje)MessageBatchCreatedEventData
(mensaje)MessageBatchDeletedEventData
(mensaje)MessageBatchUpdatedEventData
(mensaje)MessageCreatedEventData
(mensaje)MessageDeletedEventData
(mensaje)MessageUpdatedEventData
(mensaje)QuotedMessageMetadata
(mensaje)Reaction
(mensaje)ReactionBatchCreatedEventData
(mensaje)ReactionBatchDeletedEventData
(mensaje)ReactionCreatedEventData
(mensaje)ReactionDeletedEventData
(mensaje)RichLinkMetadata
(mensaje)RichLinkMetadata.RichLinkType
(enumeración)SearchSpacesRequest
(mensaje)SearchSpacesResponse
(mensaje)SetUpSpaceRequest
(mensaje)SlashCommand
(mensaje)SlashCommandMetadata
(mensaje)SlashCommandMetadata.Type
(enumeración)Space
(mensaje)Space.AccessSettings
(mensaje)Space.AccessSettings.AccessState
(enumeración)Space.MembershipCount
(mensaje)Space.PermissionSetting
(mensaje)Space.PermissionSettings
(mensaje)Space.PredefinedPermissionSettings
(enumeración)Space.SpaceDetails
(mensaje)Space.SpaceThreadingState
(enumeración)Space.SpaceType
(enumeración)Space.Type
(enumeración)SpaceBatchUpdatedEventData
(mensaje)SpaceEvent
(mensaje)SpaceReadState
(mensaje)SpaceUpdatedEventData
(mensaje)Thread
(mensaje)ThreadReadState
(mensaje)UpdateMembershipRequest
(mensaje)UpdateMessageRequest
(mensaje)UpdateSpaceReadStateRequest
(mensaje)UpdateSpaceRequest
(mensaje)User
(mensaje)User.Type
(enumeración)UserMentionMetadata
(mensaje)UserMentionMetadata.Type
(enumeración)WidgetMarkup
(mensaje)WidgetMarkup.Button
(mensaje)WidgetMarkup.FormAction
(mensaje)WidgetMarkup.FormAction.ActionParameter
(mensaje)WidgetMarkup.Icon
(enumeración)WidgetMarkup.Image
(mensaje)WidgetMarkup.ImageButton
(mensaje)WidgetMarkup.KeyValue
(mensaje)WidgetMarkup.OnClick
(mensaje)WidgetMarkup.OpenLink
(mensaje)WidgetMarkup.TextButton
(mensaje)WidgetMarkup.TextParagraph
(mensaje)
ChatService
Permite que los desarrolladores compilen integraciones y apps de Chat en la plataforma de Google Chat.
CompleteImportSpace |
---|
Completa el proceso de importación para el espacio especificado y lo hace visible para los usuarios. Requiere la autenticación de la app y la delegación de todo el dominio. Si deseas obtener más información, consulta Autoriza apps de Google Chat para importar datos.
|
CreateMembership |
---|
Crea una membresía para la app de Chat que realiza la llamada, un usuario o un Grupo de Google. No se admite la creación de membresías para otras apps de Chat. Cuando creas una membresía, si el miembro especificado tiene desactivada su política de aceptación automática, se lo invitará y deberá aceptar la invitación al espacio antes de unirse. De lo contrario, si creas una membresía, se agregará al miembro directamente al espacio especificado. Se requiere la autenticación del usuario. Para ver ejemplos de uso, consulta lo siguiente:
|
CreateMessage |
---|
Crea un mensaje en un espacio de Google Chat. Para ver un ejemplo, consulta Envía un mensaje. El método En la siguiente imagen, se muestra cómo Chat atribuye un mensaje cuando usas la autenticación de apps. Chat muestra la app de Chat como el remitente del mensaje. El contenido del mensaje puede incluir texto ( En la siguiente imagen, se muestra cómo Chat atribuye un mensaje cuando usas la autenticación de usuario. Chat muestra al usuario como el remitente del mensaje y le atribuye la app de Chat mostrando su nombre. El contenido del mensaje solo puede incluir texto ( El tamaño máximo del mensaje, incluido su contenido, es de 32,000 bytes.
|
CreateReaction |
---|
Crea una reacción y la agrega a un mensaje. Solo se admiten emojis Unicode. Para ver un ejemplo, consulta Cómo agregar una reacción a un mensaje. Se requiere la autenticación del usuario.
|
CreateSpace |
---|
Crea un espacio sin miembros. Se puede usar para crear un espacio con nombre. No se admiten los espacios agrupados por tema. Para ver un ejemplo, consulta Crea un espacio. Si recibes el mensaje de error Si eres miembro del programa de Versión preliminar para desarrolladores, puedes crear un chat en grupo en modo de importación con Se requiere la autenticación del usuario.
|
DeleteMembership |
---|
Borra una membresía. Para ver un ejemplo, consulta Quita a un usuario o una app de Google Chat de un espacio. Se requiere la autenticación del usuario.
|
DeleteMessage |
---|
Borra un mensaje. Para ver un ejemplo, consulta Borra un mensaje. Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios. Cuando usas la autenticación de apps, las solicitudes solo pueden borrar los mensajes creados por la app de Chat que realiza la llamada.
|
DeleteReaction |
---|
Borra una reacción a un mensaje. Solo se admiten emojis Unicode. Para ver un ejemplo, consulta Cómo borrar una reacción. Se requiere la autenticación del usuario.
|
DeleteSpace |
---|
Borra un espacio con nombre. Siempre realiza una eliminación en cascada, lo que significa que también se borran los recursos secundarios del espacio, como los mensajes publicados en el espacio y las membresías en él. Para ver un ejemplo, consulta Borra un espacio. Se requiere la autenticación del usuario de un usuario que tenga permiso para borrar el espacio.
|
FindDirectMessage |
---|
Muestra el mensaje directo existente con el usuario especificado. Si no se encuentra un espacio para un mensaje directo, se muestra un error Con la autenticación de usuario, muestra el espacio de mensajes directos entre el usuario especificado y el usuario autenticado. Con la autenticación de apps, muestra el espacio de mensajes directos entre el usuario especificado y la app de Chat que realiza la llamada. Se requiere la autenticación del usuario o la autenticación de la aplicación.
|
GetAttachment |
---|
Obtiene los metadatos del archivo adjunto de un mensaje. Los datos del archivo adjunto se recuperan con la API de contenido multimedia. Para ver un ejemplo, consulta Obtener metadatos sobre el archivo adjunto de un mensaje. Se requiere la autenticación de la app.
|
GetMembership |
---|
Muestra detalles sobre una membresía. Para ver un ejemplo, consulta Obtén detalles sobre la membresía de un usuario o de una app de Google Chat. Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios.
|
GetMessage |
---|
Muestra detalles sobre un mensaje. Para ver un ejemplo, consulta Cómo obtener detalles sobre un mensaje. Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios. Nota: Es posible que muestre un mensaje de un miembro o espacio bloqueado.
|
GetSpace |
---|
Muestra detalles sobre un espacio. Para ver un ejemplo, consulta Obtén detalles sobre un espacio. Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios.
|
GetSpaceEvent |
---|
Muestra un evento de un espacio de Google Chat. La carga útil del evento contiene la versión más reciente del recurso que cambió. Por ejemplo, si solicitas un evento sobre un mensaje nuevo, pero el mensaje se actualizó más tarde, el servidor muestra el recurso Se requiere la autenticación del usuario. Para obtener un evento, el usuario autenticado debe ser miembro del espacio. Para ver un ejemplo, consulta Obtén detalles sobre un evento desde un espacio de Google Chat.
|
GetSpaceReadState |
---|
Muestra detalles sobre el estado de lectura de un usuario dentro de un espacio, que se usa para identificar mensajes leídos y no leídos. Para ver un ejemplo, consulta Obtén detalles sobre el estado de lectura del espacio de un usuario. Se requiere la autenticación del usuario.
|
GetThreadReadState |
---|
Muestra detalles sobre el estado de lectura del usuario dentro de una conversación, que se usa para identificar mensajes leídos y no leídos. Para ver un ejemplo, consulta Obtén detalles sobre el estado de lectura de subprocesos de un usuario. Se requiere la autenticación del usuario.
|
ListMemberships |
---|
Muestra una lista de las membresías de un espacio. Para ver un ejemplo, consulta Enumera los usuarios y las apps de Google Chat en un espacio. Ficha de membresías con autenticación de app indica las membresías en espacios a los que la app de Chat tiene acceso, pero excluye las membresías de la app de Chat, incluidas las propias. Enumerar membresías con Autenticación de usuarios indica las membresías en los espacios a los que tiene acceso el usuario autenticado. Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios.
|
ListMessages |
---|
Muestra una lista de los mensajes de un espacio del que pertenece el emisor, incluidos los mensajes de los miembros y espacios bloqueados. Si enumeras mensajes de un espacio sin mensajes, la respuesta es un objeto vacío. Cuando usas una interfaz REST/HTTP, la respuesta contiene un objeto JSON vacío,
|
ListReactions |
---|
Muestra una lista de las reacciones a un mensaje. Para ver un ejemplo, consulta Enumera las reacciones a un mensaje. Se requiere la autenticación del usuario.
|
ListSpaceEvents |
---|
Muestra una lista de eventos de un espacio de Google Chat. Para cada evento, la carga útil contiene la versión más reciente del recurso de Chat. Por ejemplo, si enumeras eventos sobre miembros nuevos de un espacio, el servidor muestra recursos Se requiere la autenticación del usuario. Para enumerar los eventos, el usuario autenticado debe ser miembro del espacio. Para ver un ejemplo, consulta Enumera eventos de un espacio de Google Chat.
|
ListSpaces |
---|
Enumera los espacios a los que pertenece el emisor. Los chats en grupo y los MD no aparecerán hasta que se envíe el primer mensaje. Para ver un ejemplo, consulta Crea una lista de espacios. Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios. Muestra una lista de los espacios visibles para el emisor o el usuario autenticado. Los chats en grupo y los MD no aparecerán hasta que se envíe el primer mensaje. Para enumerar todos los espacios con nombre de la organización de Google Workspace, usa el método
|
SearchSpaces |
---|
use_admin_access como true .
|
SetUpSpace |
---|
Crea un espacio y le agrega los usuarios especificados. El usuario que realiza la llamada se agrega automáticamente al espacio y no se debe especificar como una membresía en la solicitud. Para ver un ejemplo, consulta Configura un espacio con miembros iniciales. Para especificar los miembros humanos que se agregarán, agrega membresías con el Para especificar los Grupos de Google que se agregarán, agrega membresías con el En el caso de un espacio con nombre o un chat en grupo, si el emisor bloquea, algunos miembros lo bloquean o no tiene permiso para agregar a algunos miembros, esos miembros no se agregarán al espacio creado. Para crear un mensaje directo (DM) entre el usuario que llama y otro usuario humano, especifica exactamente una membresía que represente al usuario humano. Si un usuario bloquea al otro, la solicitud falla y no se crea el DM. Para crear un MD entre el usuario que realiza la llamada y la app que realiza la llamada, establece Si ya existe un DM entre dos usuarios, incluso cuando un usuario bloquea al otro en el momento en que se hace una solicitud, se devuelve el DM existente. No se admiten los espacios con respuestas en múltiples conversaciones. Si recibes el mensaje de error Se requiere la autenticación del usuario.
|
UpdateMembership |
---|
Actualiza una membresía. Para ver un ejemplo, consulta Actualiza la membresía de un usuario en un espacio. Se requiere la autenticación del usuario.
|
UpdateMessage |
---|
Actualiza un mensaje. Hay una diferencia entre los métodos Requiere autenticación. Admite la autenticación de apps y la autenticación de usuarios. Cuando usas la autenticación de apps, las solicitudes solo pueden actualizar los mensajes creados por la app de Chat que realiza la llamada.
|
UpdateSpace |
---|
Actualiza un espacio. Para ver un ejemplo, consulta Actualiza un espacio. Si actualizas el campo Se requiere la autenticación del usuario.
|
UpdateSpaceReadState |
---|
Actualiza el estado de lectura de un usuario en un espacio, que se usa para identificar los mensajes leídos y no leídos. Para ver un ejemplo, consulta Actualiza el estado de lectura del espacio de un usuario. Se requiere la autenticación del usuario.
|
AccessoryWidget
Uno o más widgets interactivos que aparecen en la parte inferior de un mensaje. Para obtener más información, consulta Cómo agregar widgets interactivos en la parte inferior de un mensaje.
Campos | |
---|---|
Campo de unión action . El tipo de acción. Las direcciones (action ) solo pueden ser una de las siguientes opciones: |
|
button_list |
Una lista de botones. |
ActionResponse
Parámetros que una app de Chat puede usar para configurar cómo se publica su respuesta.
Campos | |
---|---|
type |
Solo entrada. El tipo de respuesta de la app de Chat. |
url |
Solo entrada. URL para que los usuarios se autentiquen o configuren. (solo para tipos de respuesta |
dialog_action |
Solo entrada. Es una respuesta a un evento de interacción relacionado con un diálogo. Debe estar acompañado de |
updated_widget |
Solo entrada. La respuesta del widget actualizado. |
ResponseType
El tipo de respuesta de la app de Chat.
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Es el tipo predeterminado que se maneja como NEW_MESSAGE . |
NEW_MESSAGE |
Publicar como mensaje nuevo en el tema. |
UPDATE_MESSAGE |
Actualiza el mensaje de la app de Chat. Esto solo se permite en un evento CARD_CLICKED en el que el tipo de remitente del mensaje es BOT . |
UPDATE_USER_MESSAGE_CARDS |
Actualizar las tarjetas en el mensaje de un usuario Esto solo se permite como respuesta a un evento MESSAGE con una URL coincidente o a un evento CARD_CLICKED en el que el tipo de remitente del mensaje es HUMAN . Se ignora el texto. |
REQUEST_CONFIG |
Solicita en privado al usuario autenticación o configuración adicional. |
DIALOG |
Presenta un diálogo. |
UPDATE_WIDGET |
Consulta de opciones para autocompletar texto del widget. |
SelectionItems
Lista de resultados de autocompletado de widgets.
Campos | |
---|---|
items[] |
Un array de los objetos SelectionItem. |
UpdatedWidget
La respuesta del widget actualizado. Se usa para proporcionar opciones de autocompletado para un widget.
Campos | |
---|---|
widget |
El ID del widget actualizado. El ID debe coincidir con el del widget que activó la solicitud de actualización. |
Campo de unión updated_widget . El widget se actualizó en respuesta a una acción del usuario. Las direcciones (updated_widget ) solo pueden ser una de las siguientes opciones: |
|
suggestions |
Lista de resultados de autocompletado de widgets |
ActionStatus
Representa el estado de una solicitud para invocar o enviar un diálogo.
Campos | |
---|---|
status_code |
Es el código de estado. |
user_facing_message |
Es el mensaje que se debe enviar a los usuarios sobre el estado de su solicitud. Si no la estableces, se enviará un mensaje genérico basado en |
Anotación
Solo salida. Anotaciones asociadas con el cuerpo de texto sin formato del mensaje Para agregar formato básico a un mensaje de texto, consulta Cómo dar formato a los mensajes de texto.
Ejemplo de cuerpo de mensaje de texto sin formato:
Hello @FooBot how are you!"
Los metadatos de anotaciones correspondientes:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Campos | |
---|---|
type |
Es el tipo de esta anotación. |
length |
Es la longitud de la subcadena en el cuerpo del mensaje de texto sin formato al que corresponde esta anotación. |
start_index |
Índice de inicio (basado en 0, inclusive) en el cuerpo del mensaje de texto sin formato al que corresponde esta anotación. |
Campo de unión metadata . Metadatos adicionales sobre la anotación Las direcciones (metadata ) solo pueden ser una de las siguientes opciones: |
|
user_mention |
Los metadatos de la mención del usuario. |
slash_command |
Los metadatos de un comando de barra. |
rich_link_metadata |
Los metadatos de un vínculo enriquecido. |
AnnotationType
Es el tipo de anotación.
Enumeraciones | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Valor predeterminado de la enumeración. No usar. |
USER_MENTION |
Se menciona a un usuario. |
SLASH_COMMAND |
Se invoca un comando de barra. |
RICH_LINK |
Una anotación de vínculo enriquecido |
AttachedGif
Es una imagen GIF especificada mediante una URL.
Campos | |
---|---|
uri |
Solo salida. Es la URL que aloja la imagen GIF. |
Archivo adjunto
Un archivo adjunto en Google Chat.
Campos | |
---|---|
name |
Es el nombre del recurso del adjunto, con el formato |
content_name |
Solo salida. Es el nombre de archivo original del contenido, no la ruta de acceso completa. |
content_type |
Solo salida. El tipo de contenido (tipo MIME) del archivo. |
thumbnail_uri |
Solo salida. La URL de la miniatura que se debe usar para obtener una vista previa del archivo adjunto para un usuario humano. Las apps de chat no deben usar esta URL para descargar contenido de archivos adjuntos. |
download_uri |
Solo salida. La URL de descarga que se debe usar para permitir que un usuario humano descargue el archivo adjunto. Las apps de chat no deben usar esta URL para descargar el contenido de los archivos adjuntos. |
source |
Solo salida. Es la fuente del archivo adjunto. |
Campo de unión data_ref . La referencia de datos del adjunto. Las direcciones (data_ref ) solo pueden ser una de las siguientes opciones: |
|
attachment_data_ref |
Es una referencia a los datos del archivo adjunto. Este campo se utiliza con la API de medios para descargar los datos del archivo adjunto. |
drive_data_ref |
Solo salida. Una referencia al archivo adjunto de Google Drive. Este campo se usa con la API de Google Drive. |
Fuente
Es la fuente del archivo adjunto.
Enumeraciones | |
---|---|
SOURCE_UNSPECIFIED |
Reservado. |
DRIVE_FILE |
El archivo es un archivo de Google Drive. |
UPLOADED_CONTENT |
Se subirá el archivo a Chat. |
AttachmentDataRef
Es una referencia a los datos del archivo adjunto.
Campos | |
---|---|
resource_name |
El nombre del recurso de los datos del adjunto. Este campo se utiliza con la API de medios para descargar los datos del archivo adjunto. |
attachment_upload_token |
Token opaco que contiene una referencia a un archivo adjunto subido. Los clientes los tratan como una cadena opaca y se usa para crear o actualizar mensajes de Chat con archivos adjuntos. |
CardWithId
Una tarjeta en un mensaje de Google Chat
Solo las apps de Chat pueden crear tarjetas. Si tu app de Chat se autentica como usuario, el mensaje no puede contener tarjetas.
Diseña tarjetas y obtén una vista previa de ellas con Card Builder.
Abre el Creador de tarjetasCampos | |
---|---|
card_id |
Es obligatorio si el mensaje contiene varias tarjetas. Es un identificador único de una tarjeta en un mensaje. |
card |
Una tarjeta El tamaño máximo es de 32 KB. |
ChatSpaceLinkData
Datos de los vínculos del espacio de Chat.
Campos | |
---|---|
space |
El espacio del recurso vinculado del espacio de Chat. Formato: |
thread |
Es la conversación del recurso vinculado del espacio de Chat. Formato: |
message |
El mensaje del recurso del espacio de Chat vinculado. Formato: |
CompleteImportSpaceRequest
Mensaje de solicitud para completar el proceso de importación de un espacio.
Campos | |
---|---|
name |
Obligatorio. Nombre del recurso del espacio del modo de importación. Formato: |
CompleteImportSpaceResponse
Mensaje de respuesta para completar el proceso de importación de un espacio.
Campos | |
---|---|
space |
El espacio del modo de importación. |
ContextualAddOnMarkup
Este tipo no tiene campos.
Es el lenguaje de marcado para que los desarrolladores especifiquen los contenidos de un complemento contextual.
Tarjeta
Una tarjeta es un elemento de la IU que puede contener widgets de IU, como imágenes y texto.
Campos | |
---|---|
header |
El encabezado de la tarjeta. Un encabezado suele contener un título y una imagen. |
sections[] |
Las secciones están separadas por un divisor de líneas. |
card_actions[] |
Las acciones de esta tarjeta. |
name |
Es el nombre de la tarjeta. |
CardAction
Una acción con 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 una factura, enviarla por correo electrónico o abrir la factura en el navegador.
No es compatible con las apps de Google Chat.
Campos | |
---|---|
action_label |
La etiqueta que se solía mostrar en el elemento del menú de acciones. |
on_click |
La acción "onClick" de este elemento de acción. |
CardHeader
Campos | |
---|---|
title |
Se debe especificar el título. El encabezado tiene una altura fija: si se especifican tanto un título como un subtítulo, cada uno ocupará una línea. Si solo se especifica el título, ocupa ambas líneas. |
subtitle |
El subtítulo del encabezado de la tarjeta. |
image_style |
Es el tipo de imagen (por ejemplo, borde cuadrado o borde circular). |
image_url |
Es la URL de la imagen en el encabezado de la tarjeta. |
ImageStyle
Enumeraciones | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Borde cuadrado |
AVATAR |
Borde circular |
Sección
Una sección contiene una colección de widgets renderizados (verticalmente) en el orden en que se especifican. En todas las plataformas, las tarjetas tienen un ancho fijo estrecho, por lo que actualmente no es necesario utilizar propiedades de diseño (por ejemplo, un número de punto flotante).
Campos | |
---|---|
header |
Es el encabezado de la sección. Se admite texto con formato. Si quieres obtener más información para dar formato al texto, consulta Da formato al texto en apps de Google Chat y Da formato al texto en complementos de Google Workspace. |
widgets[] |
Una sección debe contener al menos un widget. |
CreateMembershipRequest
Mensaje de solicitud para crear una membresía.
Campos | |
---|---|
parent |
Obligatorio. El nombre del recurso del espacio para el que se creará la membresía. Formato: espacios/{space} |
membership |
Obligatorio. La relación de membresía que se creará. El campo |
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 No se pueden crear membresías de aplicaciones ni de usuarios ajenos a la organización de Google Workspace del administrador con el acceso de administrador. |
CreateMessageRequest
Crea un mensaje.
Campos | |
---|---|
parent |
Obligatorio. El nombre de recurso del espacio en el que se creará un mensaje. Formato: |
message |
Obligatorio. Cuerpo del mensaje. |
thread_key |
Opcional. Obsoleto: Usa |
request_id |
Opcional. Un ID de solicitud único para este mensaje. Si especificas un ID de solicitud existente, se muestra el mensaje creado con ese ID en lugar de crear un mensaje nuevo. |
message_reply_option |
Opcional. Especifica si un mensaje inicia una conversación o responde a una. Solo es compatible en los espacios con nombre. |
message_id |
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 El valor de este campo debe cumplir con los siguientes requisitos:
Para obtener más información, consulta Cómo asignar un nombre a un mensaje. |
MessageReplyOption
Especifica cómo responder un mensaje. Es posible que se agreguen más estados en el futuro.
Enumeraciones | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Predeterminado. Inicia una conversación nueva. Si usas esta opción, se ignorará cualquier thread ID o que se incluya. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Crea el mensaje como respuesta a la conversación especificada por thread ID o . Si falla, el mensaje inicia una nueva conversación. |
REPLY_MESSAGE_OR_FAIL |
Crea el mensaje como respuesta a la conversación especificada por thread ID o . Si se usa un thread_key nuevo, se crea un subproceso nuevo. Si la creación del mensaje falla, se muestra un error NOT_FOUND en su lugar. |
CreateReactionRequest
Crea una reacción a un mensaje.
Campos | |
---|---|
parent |
Obligatorio. Es el mensaje en el que se crea la reacción. Formato: |
reaction |
Obligatorio. La reacción que se creará. |
CreateSpaceRequest
Una solicitud para crear un espacio sin miembros.
Campos | |
---|---|
space |
Obligatorio. Se deben completar los campos Si recibes el mensaje de error Si eres miembro del programa de Versión preliminar para desarrolladores, puedes usar El espacio |
request_id |
Opcional. Es un identificador único para esta solicitud. Se recomienda usar un UUID aleatorio. Si especificas un ID de solicitud existente, se muestra el espacio creado con ese ID en lugar de crear un espacio nuevo. Si especificas un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se mostrará un error. |
CustomEmoji
Representa un emoji personalizado.
Campos | |
---|---|
uid |
Solo salida. Clave única para el recurso de emoji personalizado. |
DeleteMembershipRequest
Solicitud para borrar una membresía de un espacio.
Campos | |
---|---|
name |
Obligatorio. Nombre del recurso de la membresía que se borrará. Las apps de Chat pueden borrar las contraseñas o sus propias membresías. Las apps de chat no pueden borrar los datos de otras apps membresías. Cuando se borra una membresía humana, se requiere el permiso Cuando se borra una membresía de app, se requiere el permiso Formato: |
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 No se pueden borrar membresías de apps de un espacio con el acceso de administrador. |
DeleteMessageRequest
Solicitud para borrar un mensaje.
Campos | |
---|---|
name |
Obligatorio. Es el nombre del recurso del mensaje. Formato: Si estableciste un ID personalizado para tu mensaje, puedes usar el valor del campo |
force |
Si es Solo se aplica cuando se autentica como usuario. No tiene ningún efecto cuando se autentica como una app de Chat. |
DeleteReactionRequest
Borra una reacción a un mensaje.
Campos | |
---|---|
name |
Obligatorio. Nombre de la reacción que se borrará. Formato: |
DeleteSpaceRequest
Solicitud para borrar un espacio.
Campos | |
---|---|
name |
Obligatorio. Nombre de recurso del espacio que se borrará. Formato: |
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 |
DeletionMetadata
Información sobre un mensaje borrado. Se borra un mensaje cuando se configura delete_time
.
Campos | |
---|---|
deletion_type |
Indica quién borró el mensaje. |
DeletionType
Quién borró el mensaje y cómo se borró
Enumeraciones | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Este valor no se usa. |
CREATOR |
El usuario borró su propio mensaje. |
SPACE_OWNER |
El propietario del espacio borró el mensaje. |
ADMIN |
Un administrador de Google Workspace borró el mensaje. |
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 usuario. |
SPACE_OWNER_VIA_APP |
Una app de Chat borró el mensaje en nombre del propietario del espacio. |
Diálogo
Unión alrededor del cuerpo de la tarjeta del diálogo.
Campos | |
---|---|
body |
Solo entrada. Cuerpo del diálogo, que se renderiza en una ventana modal. Las apps de Google Chat no admiten las siguientes entidades de tarjeta: |
DialogAction
Contiene un diálogo y el código de estado de la solicitud.
Campos | |
---|---|
action_status |
Solo entrada. 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 . Acción para realizar. Las direcciones (action ) solo pueden ser una de las siguientes opciones: |
|
dialog |
Solo entrada. Dialog para la solicitud. |
DriveDataRef
Es una referencia a los datos de un adjunto de unidad.
Campos | |
---|---|
drive_file_id |
El ID del archivo de Drive. Úsalo con la API de Drive. |
DriveLinkData
Datos de vínculos de Google Drive.
Campos | |
---|---|
drive_data_ref |
Una DriveDataRef que hace referencia a un archivo de Google Drive |
mime_type |
El tipo MIME del recurso de Google Drive vinculado. |
Emoji
Un emoji que se usa como reacción a un mensaje.
Campos | |
---|---|
Campo de unión content . El contenido del emoji. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
unicode |
Un emoji básico representado por una cadena Unicode. |
custom_emoji |
Solo salida. Un emoji personalizado |
EmojiReactionSummary
Indica la cantidad de personas que reaccionaron a un mensaje con un emoji específico.
Campos | |
---|---|
emoji |
Emoji asociado con las reacciones. |
reaction_count |
La cantidad total de reacciones que usaron el emoji asociado. |
FindDirectMessageRequest
Una solicitud para obtener espacio de mensaje directo según el recurso del usuario.
Campos | |
---|---|
name |
Obligatorio. Nombre del recurso del usuario con el que se va a encontrar el mensaje directo. Formato: |
GetAttachmentRequest
Solicitud para obtener un archivo adjunto.
Campos | |
---|---|
name |
Obligatorio. Es el nombre del recurso del adjunto, con el formato |
GetMembershipRequest
Es una solicitud para obtener una membresía de un espacio.
Campos | |
---|---|
name |
Obligatorio. Nombre del recurso de la membresía que se recuperará. Para obtener la membresía de la app mediante la autenticación de usuario, puedes usar Formato: Cuando se autentica como usuario, puedes usar el correo electrónico del usuario como un alias para |
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere los permisos de OAuth 2.0 No se pueden obtener membresías de apps en un espacio cuando se usa el acceso de administrador. |
GetMessageRequest
Solicitud para recibir un mensaje.
Campos | |
---|---|
name |
Obligatorio. Es el nombre del recurso del mensaje. Formato: Si estableciste un ID personalizado para tu mensaje, puedes usar el valor del campo |
GetSpaceEventRequest
Mensaje de solicitud para obtener un evento espacial.
Campos | |
---|---|
name |
Obligatorio. El nombre del recurso del evento de espacio. Formato: |
GetSpaceReadStateRequest
Mensaje de solicitud para la API de GetSpaceReadState.
Campos | |
---|---|
name |
Obligatorio. Es el nombre del recurso del estado de lectura del espacio que se recuperará. Solo admite la obtención del estado de lectura del usuario que realiza la llamada. Para hacer referencia al usuario que realiza la llamada, configura una de las siguientes opciones:
Formato: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Es una solicitud para mostrar un solo espacio.
Campos | |
---|---|
name |
Obligatorio. Nombre de recurso del espacio, con el formato Formato: |
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere los permisos de OAuth 2.0 |
GetThreadReadStateRequest
Mensaje de solicitud para la API de GetThreadReadStateRequest.
Campos | |
---|---|
name |
Obligatorio. Nombre del recurso del estado de lectura del subproceso que se recuperará. Solo admite la obtención del estado de lectura del usuario que realiza la llamada. Para hacer referencia al usuario que realiza la llamada, configura una de las siguientes opciones:
Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Grupo
Un Grupo de Google en Google Chat
Campos | |
---|---|
name |
Nombre de recurso para un Grupo de Google. Representa un grupo en la API de Groups de Cloud Identity. Formato: groups/{group} |
HistoryState
Es el estado del historial de mensajes y espacios. Especifica cuánto tiempo se conservan los mensajes y las conversaciones después de su creación.
Enumeraciones | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Valor predeterminado No lo utilices. |
HISTORY_OFF |
Historial desactivado. Los mensajes y las conversaciones se conservan por 24 horas. |
HISTORY_ON |
Historial activado. Las reglas de retención de Vault de la organización especifican por cuánto tiempo se conservan los mensajes y las conversaciones. |
ListMembershipsRequest
Mensaje de solicitud para las membresías de la ficha.
Campos | |
---|---|
parent |
Obligatorio. El nombre del recurso del espacio para el que se recuperará una lista de membresías. Formato: espacios/{space} |
page_size |
Opcional. La cantidad máxima de membresías que se mostrarán. Es posible que el servicio muestre menos valores que este. Si no se especifica, se muestran 100 membresías como máximo. El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambia automáticamente a 1,000. Los valores negativos muestran un error |
page_token |
Opcional. Un token de página, recibido de una llamada anterior para enumerar membresías. Proporciona este parámetro para recuperar la página siguiente. Durante la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados. |
filter |
Opcional. Un filtro de consulta Puedes filtrar las membresías por el rol ( Para filtrar por función, establece Para filtrar por tipo, establece Para filtrar por función y tipo, usa el operador Se requiere Por ejemplo, las siguientes consultas son válidas:
Las siguientes consultas no son válidas:
El servidor rechaza las consultas no válidas con un error |
show_groups |
Opcional. Cuando es |
show_invited |
Opcional. Cuando Actualmente requiere la autenticación de usuarios. |
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 No se admite enumerar las membresías de apps en un espacio cuando se usa el acceso de administrador. |
ListMembershipsResponse
Es una respuesta para enumerar las membresías del espacio.
Campos | |
---|---|
memberships[] |
Lista sin ordenar. Lista de membresías en la página solicitada (o la primera). |
next_page_token |
Un token que puedes enviar como |
ListMessagesRequest
Muestra una lista de los mensajes del espacio especificado a los que pertenece el usuario.
Campos | |
---|---|
parent |
Obligatorio. El nombre del recurso del espacio del que se enumeran los mensajes. Formato: |
page_size |
La cantidad máxima de mensajes que se muestran. Es posible que el servicio muestre menos mensajes que este valor. Si no se especifica, se muestran 25 como máximo. El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambia automáticamente a 1,000. Los valores negativos muestran un error |
page_token |
Opcional si se reanuda desde una consulta anterior. Un token de página recibido de una llamada anterior de mensajes de lista. Proporciona este parámetro para recuperar la página siguiente. Durante la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados. |
filter |
Un filtro de consulta Puedes filtrar los mensajes por fecha ( Para filtrar los mensajes por la fecha en que se crearon, especifica Para filtrar por subproceso, especifica el Para filtrar por subproceso y fecha, usa el operador Por ejemplo, las siguientes consultas son válidas:
El servidor rechaza las consultas no válidas con un error |
order_by |
Opcional si se reanuda desde una consulta anterior. Cómo se ordena la lista de mensajes. Especifica un valor para ordenar según una operación de ordenamiento. Los valores válidos de una operación de ordenamiento son los siguientes:
El orden predeterminado es |
show_deleted |
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 de los mensajes no está disponible. |
ListMessagesResponse
Mensaje de respuesta para enumerar los mensajes.
Campos | |
---|---|
messages[] |
Lista de mensajes. |
next_page_token |
Puedes enviar un token como |
ListReactionsRequest
Muestra una lista de las reacciones a un mensaje.
Campos | |
---|---|
parent |
Obligatorio. El mensaje al que reaccionaron los usuarios Formato: |
page_size |
Opcional. La cantidad máxima de reacciones que se muestran. El servicio puede mostrar menos reacciones que este valor. Si no se especifica, el valor predeterminado es 25. El valor máximo es 200. los valores superiores a 200 se cambian a 200. |
page_token |
Opcional. (si se reanuda desde una consulta anterior). Un token de página recibido de una llamada de reacciones de lista anterior. Proporciona esto para recuperar la página siguiente. Durante la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de la página. Pasar un valor diferente puede generar resultados inesperados. |
filter |
Opcional. Un filtro de consulta Puedes filtrar las reacciones por emoji ( Para filtrar reacciones de varios emojis o usuarios, une campos similares con el operador Para filtrar reacciones por emoji y usuario, usa el operador Si tu consulta usa Por ejemplo, las siguientes consultas son válidas:
Las siguientes consultas no son válidas:
El servidor rechaza las consultas no válidas con un error |
ListReactionsResponse
Respuesta a una solicitud de reacciones de lista.
Campos | |
---|---|
reactions[] |
Lista de reacciones en la página solicitada (o la primera). |
next_page_token |
Token de continuación para recuperar la siguiente página de resultados. Está vacía en la última página de resultados. |
ListSpaceEventsRequest
Mensaje de solicitud para enumerar los eventos del espacio.
Campos | |
---|---|
parent |
Obligatorio. Nombre del recurso del espacio de Google Chat en el que ocurrieron los eventos. Formato: |
page_size |
Opcional. La cantidad máxima de eventos de espacio que se muestran. Es posible que el servicio muestre menos valores que este. Los valores negativos muestran un error |
page_token |
Un token de página, recibido de una llamada anterior de eventos de espacio de lista. Proporciona esto para recuperar la página siguiente. Durante la paginación, todos los demás parámetros proporcionados para enumerar los eventos de espacio deben coincidir con la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados. |
filter |
Obligatorio. Un filtro de consulta Debes especificar, al menos, un tipo de evento ( De manera opcional, también puedes filtrar por hora de inicio (
Para especificar una hora de inicio o finalización, usa el operador signo igual Por ejemplo, las siguientes consultas son válidas:
Las siguientes consultas no son válidas:
El servidor rechaza las consultas no válidas con un error |
ListSpaceEventsResponse
Mensaje de respuesta para enumerar los eventos del espacio.
Campos | |
---|---|
space_events[] |
Los resultados se muestran en orden cronológico (el evento más antiguo primero). |
next_page_token |
Token de continuación usado para recuperar más eventos. Si se omite este campo, no habrá páginas siguientes. |
ListSpacesRequest
Una solicitud para enumerar los espacios de los que pertenece el emisor.
Campos | |
---|---|
page_size |
Opcional. La cantidad máxima de espacios que se mostrarán. Es posible que el servicio muestre menos valores que este. Si no se especifica, se muestran 100 espacios como máximo. El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambia automáticamente a 1,000. Los valores negativos muestran un error |
page_token |
Opcional. Un token de página, recibido de una llamada anterior a la lista de espacios. Proporciona este parámetro para recuperar la página siguiente. Durante la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de la página. Pasar un valor diferente puede generar resultados inesperados. |
filter |
Opcional. Un filtro de consulta Puedes filtrar los espacios por tipo de espacio ( Para filtrar por tipo de espacio, debes especificar un valor de enumeración válido, como Por ejemplo, las siguientes consultas son válidas:
El servidor rechaza las consultas no válidas con un error |
ListSpacesResponse
Respuesta para una solicitud de lista de espacios.
Campos | |
---|---|
spaces[] |
Lista de espacios en la página solicitada (o la primera). |
next_page_token |
Puedes enviar un token como |
MatchedUrl
Una URL coincidente en un mensaje de Chat. Las apps de chat pueden obtener una vista previa de las URLs coincidentes. Si deseas obtener más información, consulta el artículo Vista previa de vínculos.
Campos | |
---|---|
url |
Solo salida. La URL que coincidió. |
Membresía
Representa una relación de membresía en Google Chat, por ejemplo, si se invita a un usuario o una app de Chat a un espacio, si forma parte de él o si está ausente.
Campos | |
---|---|
name |
Nombre del recurso de la membresía que asigna el servidor. Formato: |
state |
Solo salida. Estado de la membresía. |
role |
Opcional. El rol del usuario dentro de un espacio de Chat, que determina las acciones permitidas en el espacio Este campo solo se puede usar como entrada en |
create_time |
Opcional. Inmutable. La hora de creación de la membresía, como la fecha en que un miembro se unió a un espacio o recibió una invitación para hacerlo. Este campo es solo de salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación. |
delete_time |
Opcional. Inmutable. La hora de eliminación de la membresía, como cuando un miembro abandonó el espacio o se lo quitó. Este campo es solo de salida, excepto cuando se usa para importar membresías históricas en espacios en modo de importación. |
Campo de unión memberType . Miembro asociado con esta membresía Es posible que se admitan otros tipos de miembros en el futuro. Las direcciones (memberType ) solo pueden ser una de las siguientes opciones: |
|
member |
El usuario o la app de Google Chat al que corresponde la membresía. Si tu app de Chat se autentica como usuario, el resultado propaga los datos del usuario |
group_member |
El Grupo de Google al que corresponde la membresía. |
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.
Enumeraciones | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Valor predeterminado En el caso de users , no es miembro del espacio, pero se puede invitar. Para Google Groups : siempre se le asigna este rol (es posible que se usen otros valores de enumeración en el futuro). |
ROLE_MEMBER |
Un miembro del espacio. El usuario tiene permisos básicos, como enviar mensajes al espacio. En conversaciones grupales 1:1 y sin nombre, todos tienen este rol. |
ROLE_MANAGER |
Un administrador del espacio. El usuario tiene todos los permisos básicos y los permisos administrativos con los que puede administrar el espacio, como agregar o quitar miembros. Solo se admite en SpaceType.SPACE . |
MembershipState
Especifica la relación del miembro con un espacio. Es posible que se admitan otros estados de membresía en el futuro.
Enumeraciones | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Valor predeterminado No usar. |
JOINED |
Se agregará el usuario al espacio y podrá participar en él. |
INVITED |
Se invitó al usuario a unirse al espacio, pero este no se unió a él. |
NOT_A_MEMBER |
El usuario no pertenece al espacio y no tiene una invitación pendiente para unirse a él. |
MembershipBatchCreatedEventData
Carga útil de eventos para varias membresías nuevas.
Tipo de evento: google.workspace.chat.membership.v1.batchCreated
Campos | |
---|---|
memberships[] |
Una lista de las membresías nuevas. |
MembershipBatchDeletedEventData
Carga útil de eventos para varias membresías borradas.
Tipo de evento: google.workspace.chat.membership.v1.batchDeleted
Campos | |
---|---|
memberships[] |
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[] |
Una lista de las membresías actualizadas. |
MembershipCreatedEventData
Carga útil del evento para una membresía nueva.
Tipo de evento: google.workspace.chat.membership.v1.created
.
Campos | |
---|---|
membership |
La nueva membresía. |
MembershipDeletedEventData
Carga útil de evento para una membresía borrada.
Tipo de evento: google.workspace.chat.membership.v1.deleted
Campos | |
---|---|
membership |
La membresía que se borró. Solo se propagan los campos |
MembershipUpdatedEventData
Carga útil del evento para una membresía actualizada.
Tipo de evento: google.workspace.chat.membership.v1.updated
Campos | |
---|---|
membership |
La membresía actualizada. |
Mensaje
Un mensaje en un espacio de Google Chat
Campos | |
---|---|
name |
Es el nombre del recurso del mensaje. Formato: Donde Si estableces un ID personalizado cuando creas un mensaje, puedes usar este ID para especificar el mensaje en una solicitud. Para ello, reemplaza |
sender |
Solo salida. El usuario que creó el mensaje Si tu app de Chat se autentica como usuario, el resultado propaga los datos del usuario |
create_time |
Opcional. Inmutable. En el caso de los espacios creados en Chat, es la hora a la que se creó el mensaje. Este campo es solo de salida, excepto cuando se usa en espacios en modo de importación. Para los espacios en modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el mensaje en la fuente para conservar la hora de creación original. |
last_update_time |
Solo salida. Indica la hora en que el usuario editó el mensaje por última vez. Si el mensaje nunca se editó, este campo estará vacío. |
delete_time |
Solo salida. La hora a la que se borró el mensaje en Google Chat. Si nunca se borra el mensaje, este campo estará vacío. |
text |
Cuerpo de texto sin formato del mensaje. El primer vínculo a una imagen, un video o una página web genera un chip de vista previa. También puedes @mencionar a un usuario de Google Chat o a todos los miembros del espacio. Para obtener información sobre cómo crear mensajes de texto, consulta Cómo enviar un mensaje. |
formatted_text |
Solo salida. Contiene el mensaje
Para obtener más información, consulta Cómo ver el formato de texto enviado en un mensaje. |
cards[] |
Obsoleto: Usa Tarjetas interactivas, con formato y con formato que se pueden usar para mostrar elementos de la IU, como textos con formato, imágenes en las que se puede hacer clic y botones. Por lo general, las tarjetas se muestran debajo del cuerpo de texto sin formato del mensaje. |
cards_v2[] |
Un array de tarjetas. Solo las apps de Chat pueden crear tarjetas. Si tu app de Chat se autentica como usuario, los mensajes no pueden contener tarjetas. Para obtener información sobre cómo crear un mensaje que contenga tarjetas, consulta Cómo enviar un mensaje. Diseña tarjetas y obtén una vista previa de ellas con Card Builder. Abre el Creador de tarjetas |
annotations[] |
Solo salida. Anotaciones asociadas con el |
thread |
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 |
Si tu app de Chat se autentica como usuario, el resultado propaga el espacio |
fallback_text |
Es una descripción en texto sin formato de las tarjetas del mensaje, que se usa cuando no se pueden mostrar las tarjetas reales; por ejemplo, notificaciones móviles. |
action_response |
Solo entrada. Parámetros que una app de Chat puede usar para configurar cómo se publica su respuesta. |
argument_text |
Solo salida. Cuerpo de texto sin formato del mensaje sin todas las menciones de la app de Chat |
slash_command |
Solo salida. Información del comando de barra, si corresponde. |
attachment[] |
Archivo adjunto subido por el usuario. |
matched_url |
Solo salida. Una URL en |
thread_reply |
Solo salida. Cuando es Si el espacio no admite respuestas en conversaciones, este campo siempre será |
client_assigned_message_id |
Opcional. Un ID personalizado para el mensaje. Puedes usar el campo para identificar un mensaje, o bien obtener, borrar o actualizar un mensaje. Para establecer un ID personalizado, especifica el campo |
emoji_reaction_summaries[] |
Solo salida. Es la lista de resúmenes de reacciones con emojis del mensaje. |
private_message_viewer |
Inmutable. Entrada para crear un mensaje; de lo contrario, solo salida. El usuario que puede ver el mensaje. Cuando se configura, 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: Para obtener más información, consulta Cómo enviar un mensaje privado. |
deletion_metadata |
Solo salida. Información sobre un mensaje borrado. Se borra un mensaje cuando se configura |
quoted_message_metadata |
Solo salida. Información sobre un mensaje citado por un usuario de Google Chat en un espacio. Los usuarios de Google Chat pueden citar un mensaje para responderlo. |
attached_gifs[] |
Solo salida. Imágenes GIF adjuntas al mensaje |
accessory_widgets[] |
Uno o más widgets interactivos que aparecen en la parte inferior de un mensaje. Puedes agregar widgets de accesorios a los mensajes que contengan texto, tarjetas o tanto texto como tarjetas. No es compatible con mensajes que contienen diálogos. Para obtener más detalles, consulta Agrega widgets interactivos al final de un mensaje. La creación de un mensaje con widgets complementarios requiere la autenticación de la app. |
MessageBatchCreatedEventData
Carga útil de eventos para varios mensajes nuevos.
Tipo de evento: google.workspace.chat.message.v1.batchCreated
Campos | |
---|---|
messages[] |
Una lista de mensajes nuevos. |
MessageBatchDeletedEventData
Carga útil de eventos para varios mensajes borrados.
Tipo de evento: google.workspace.chat.message.v1.batchDeleted
Campos | |
---|---|
messages[] |
Una lista de los mensajes borrados. |
MessageBatchUpdatedEventData
Carga útil de eventos para varios mensajes actualizados.
Tipo de evento: google.workspace.chat.message.v1.batchUpdated
Campos | |
---|---|
messages[] |
Una lista de los mensajes actualizados. |
MessageCreatedEventData
Carga útil de evento para un mensaje nuevo.
Tipo de evento: google.workspace.chat.message.v1.created
Campos | |
---|---|
message |
El mensaje nuevo. |
MessageDeletedEventData
Carga útil de evento para un mensaje borrado.
Tipo de evento: google.workspace.chat.message.v1.deleted
Campos | |
---|---|
message |
El mensaje borrado. Solo se propagan los campos |
MessageUpdatedEventData
Carga útil de evento para un mensaje actualizado.
Tipo de evento: google.workspace.chat.message.v1.updated
Campos | |
---|---|
message |
El mensaje actualizado. |
QuotedMessageMetadata
Información sobre un mensaje citado.
Campos | |
---|---|
name |
Solo salida. Nombre del recurso del mensaje citado. Formato: |
last_update_time |
Solo salida. La marca de tiempo de cuando se creó el mensaje citado o de cuando se actualizó por última vez. |
Reacciones
Una reacción a un mensaje.
Campos | |
---|---|
name |
El nombre del recurso de la reacción. Formato: |
user |
Solo salida. El usuario que creó la reacción |
emoji |
El emoji que se usa en la reacción. |
ReactionBatchCreatedEventData
Carga útil de eventos 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[] |
Una lista de reacciones borradas. |
ReactionCreatedEventData
Carga útil de evento para una reacción nueva.
Tipo de evento: google.workspace.chat.reaction.v1.created
Campos | |
---|---|
reaction |
La nueva reacción. |
ReactionDeletedEventData
Carga útil de evento para una reacción borrada.
Tipo: google.workspace.chat.reaction.v1.deleted
Campos | |
---|---|
reaction |
La reacción que se borró. |
RichLinkMetadata
Es un vínculo enriquecido a un recurso.
Campos | |
---|---|
uri |
Es el URI de este vínculo. |
rich_link_type |
El tipo de vínculo enriquecido. |
Campo de unión data . Datos del recurso vinculado. Las direcciones (data ) solo pueden ser una de las siguientes opciones: |
|
drive_link_data |
Datos para un vínculo de Drive. |
chat_space_link_data |
Datos de un vínculo de un espacio de Chat. |
RichLinkType
El tipo de vínculo enriquecido. Es posible que se agreguen más tipos en el futuro.
Enumeraciones | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Valor predeterminado de la enumeración. No usar. |
DRIVE_FILE |
Un tipo de vínculo enriquecido de Google Drive. |
CHAT_SPACE |
Un tipo de vínculo enriquecido a un espacio de Chat. Por ejemplo, un chip inteligente espacial. |
SearchSpacesRequest
Solicitud para buscar una lista de espacios en función de una consulta.
Campos | |
---|---|
use_admin_access |
Cuando es El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 Actualmente, este método solo admite acceso de administrador, por lo que solo se acepta |
page_size |
La cantidad máxima de espacios que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se muestran 100 espacios como máximo. El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambia automáticamente a 1,000. |
page_token |
Un token, recibido de la llamada a los espacios de búsqueda anterior. Proporciona este parámetro para recuperar la página siguiente. Durante la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados. |
query |
Obligatorio. Una búsqueda. Puedes buscar con los siguientes parámetros:
En diferentes campos, solo se admiten los operadores Entre el mismo campo, Las siguientes consultas de ejemplo son válidas:
|
order_by |
Opcional. Cómo se ordena la lista de espacios. Los atributos admitidos para ordenar son los siguientes:
Los valores válidos de la operación de ordenamiento son los siguientes:
Las sintaxis admitidas son las siguientes:
|
SearchSpacesResponse
Respuesta con una lista de los espacios correspondientes a la solicitud de espacios de búsqueda.
Campos | |
---|---|
spaces[] |
Una página de los espacios solicitados. |
next_page_token |
Un token que se puede usar para recuperar la página siguiente. Si este campo está vacío, no hay páginas posteriores. |
total_size |
Es la cantidad total de espacios que coinciden con la búsqueda en todas las páginas. Si el resultado supera los 10,000 espacios, este valor es una estimación. |
SetUpSpaceRequest
Solicita crear un espacio y agregarle usuarios específicos.
Campos | |
---|---|
space |
Obligatorio. El campo Para crear un espacio, establece Para crear un chat en grupo, establece Para crear una conversación 1:1 entre personas, establece Para crear una conversación 1:1 entre una persona y la app de Chat que realiza la llamada, establece Si ya existe un espacio |
request_id |
Opcional. Es un identificador único para esta solicitud. Se recomienda usar un UUID aleatorio. Si especificas un ID de solicitud existente, se muestra el espacio creado con ese ID en lugar de crear un espacio nuevo. Si especificas un ID de solicitud existente de la misma app de Chat con un usuario autenticado diferente, se mostrará un error. |
memberships[] |
Opcional. 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 20 membresías (además del llamador). Para la membresía humana, el campo Para la membresía a un Grupo de Google, el campo Es opcional cuando se establece Es obligatorio cuando se configura Es obligatorio cuando se configura Debe estar vacío cuando se crea una conversación 1:1 entre una persona y la app de Chat que realiza la llamada (cuando configuras |
SlashCommand
Un comando de barra en Google Chat
Campos | |
---|---|
command_id |
El ID del comando de barra invocado |
SlashCommandMetadata
Metadatos de anotación para comandos de barra (/).
Campos | |
---|---|
bot |
La app de Chat cuyo comando se invocó. |
type |
Es el tipo de comando de barra. |
command_name |
El nombre del comando de barra invocado. |
command_id |
El ID del comando de barra invocado |
triggers_dialog |
Indica si el comando de barra es para un diálogo. |
Tipo
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Valor predeterminado de la enumeración. No usar. |
ADD |
Agregar la app de Chat al espacio |
INVOKE |
Invoca el comando de barra en el 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 |
Nombre de recurso del espacio. Formato: Donde |
type |
Solo salida. Obsoleto: Usa |
space_type |
Indica el tipo de espacio. Es obligatorio cuando se crea un espacio o se actualiza su tipo. Salida solo para otros usos. |
single_user_bot_dm |
Opcional. Si el espacio es un MD entre una app de Chat y una sola persona |
threaded |
Solo salida. Obsoleto: Usa |
display_name |
El nombre visible del espacio. Es obligatorio cuando creas un espacio con una Para los mensajes directos, este campo puede estar vacío. Admite hasta 128 caracteres. |
external_user_allowed |
Inmutable. Si este espacio permite que cualquier usuario de Google Chat sea miembro. Entrada cuando se crea un espacio en una organización de Google Workspace. Omite este campo cuando crees espacios en las siguientes condiciones:
Para los espacios existentes, este campo es de solo salida. |
space_threading_state |
Solo salida. El estado de la conversación en el espacio de Chat |
space_details |
Detalles sobre el espacio, incluida la descripción y las reglas |
space_history_state |
Es el estado del historial de mensajes de los mensajes y las conversaciones de este espacio. |
import_mode |
Opcional. Si este espacio se crea en |
create_time |
Opcional. Inmutable. En el caso de los espacios creados en Chat, la hora en que se creó el espacio. Este campo es solo de salida, excepto cuando se usa en espacios en modo de importación. Para los espacios en modo de importación, establece este campo en la marca de tiempo histórica en la que se creó el espacio en la fuente para conservar la hora de creación original. Solo se propaga en el resultado cuando |
last_active_time |
Solo salida. Marca de tiempo del último mensaje en el espacio. |
admin_installed |
Solo salida. En el caso de los espacios de mensajes directos (MD) con una app de Chat, indica si el espacio fue creado por un administrador de Google Workspace. Los administradores pueden instalar y configurar un mensaje directo con una app de Chat en nombre de los usuarios de su organización. Para admitir la instalación por parte de administradores, tu app de Chat debe incluir mensajes directos. |
membership_count |
Solo salida. La cantidad de membresías unidas agrupadas por tipo de miembro. Se propaga cuando |
access_settings |
Opcional. Especifica la configuración de acceso del espacio. Solo se completa cuando |
space_uri |
Solo salida. Es el URI para que un usuario acceda al espacio. |
Campo de unión space_permission_settings . Representa la configuración de permisos de un espacio. Solo se completa cuando space_type es SPACE . space_permission_settings puede ser solo una de las siguientes opciones: |
|
predefined_permission_settings |
Opcional. Solo entrada. Configuración de permisos de espacios. Entrada para crear un espacio. Si no estableces este campo, se creará un espacio de colaboración. Una vez que crees el espacio, la configuración se completará en el campo |
permission_settings |
Opcional. La configuración de permisos exacta, que se puede establecer para actualizar el espacio Entrada para actualizar un espacio. De lo contrario, solo muestra el resultado. Para crear espacios, usa |
AccessSettings
Representa la configuración de acceso del espacio.
Campos | |
---|---|
access_state |
Solo salida. Indica el estado de acceso del espacio. |
audience |
Opcional. Es el nombre de recurso del público objetivo que puede descubrir el espacio, unirse a él y obtener una vista previa de los mensajes que contiene. Si no la estableces, solo podrán acceder a él los usuarios o Grupos de Google que se hayan invitado o agregado de forma individual al espacio. Para conocer más detalles, consulta Haz que un espacio sea detectable para el público objetivo. Formato: Para usar el usuario objetivo predeterminado de la organización de Google Workspace, establécelo en |
AccessState
Representa el estado de acceso del espacio.
Enumeraciones | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Se desconoce el estado del acceso o no se admite en esta API. |
PRIVATE |
Solo los usuarios o Grupos de Google que otros usuarios o administradores de Google Workspace hayan agregado o invitado de forma individual pueden descubrir el espacio y acceder a él. |
DISCOVERABLE |
Un administrador del espacio otorgó acceso al espacio a usuarios objetivo. Los usuarios o Grupos de Google que se hayan agregado o invitado de forma individual al espacio también podrán descubrirlo y acceder a él. Para obtener más información, consulta Haz que un espacio sea visible para usuarios específicos. |
MembershipCount
Campos | |
---|---|
joined_direct_human_user_count |
Recuento de usuarios humanos que se unieron directamente al espacio, sin contar los usuarios que se unieron a un grupo. |
joined_group_count |
Recuento de todos los grupos que se unieron directamente al espacio. |
PermissionSetting
Representa un parámetro de configuración de permiso de espacio.
Campos | |
---|---|
managers_allowed |
Si los administradores de espacios tienen este permiso |
members_allowed |
Indica si las personas que no son administradores tienen este permiso. |
PermissionSettings
Configuración de permisos para un espacio con nombre Para establecer la configuración de permisos cuando creas un espacio, especifica el campo PredefinedPermissionSettings
en la solicitud.
Campos | |
---|---|
manage_members_and_groups |
Parámetro de configuración para administrar los miembros y grupos de un espacio. |
modify_space_details |
Parámetro de configuración para actualizar el nombre, el avatar, la descripción y los lineamientos del espacio. |
toggle_history |
Parámetro de configuración para activar y desactivar el historial de espacio. |
use_at_mention_all |
Parámetro de configuración para usar @todos en un espacio. |
manage_apps |
Parámetro de configuración para administrar apps en un espacio. |
manage_webhooks |
Parámetro de configuración para administrar webhooks en un espacio. |
post_messages |
Solo salida. Parámetro de configuración para publicar mensajes en un espacio. |
reply_messages |
Parámetro de configuración para responder mensajes en un espacio. |
PredefinedPermissionSettings
La configuración de permisos de espacio que puedes especificar cuando creas un espacio con nombre. Es posible que se agreguen más parámetros de configuración en el futuro. Para obtener detalles sobre la configuración de permisos de los espacios nombrados, consulta Obtén información sobre los espacios.
Enumeraciones | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Sin especificar. No usar. |
COLLABORATION_SPACE |
Es la configuración para hacer que el espacio sea de colaboración, en el que todos los miembros puedan publicar mensajes. |
ANNOUNCEMENT_SPACE |
Parámetro de configuración para convertir este espacio en un espacio de anuncios en el que solo los administradores del espacio puedan publicar mensajes. |
SpaceDetails
Detalles sobre el espacio, incluida la descripción y las reglas
Campos | |
---|---|
description |
Opcional. Es una descripción del espacio. Por ejemplo, describe el tema de debate del espacio, el propósito funcional o los participantes. Admite hasta 150 caracteres. |
guidelines |
Opcional. Las reglas, las expectativas y el protocolo del espacio. Admite hasta 5,000 caracteres. |
SpaceThreadingState
Especifica el tipo de estado de subprocesos en el espacio de Chat.
Enumeraciones | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Reservado. |
THREADED_MESSAGES |
Espacios con nombre que admiten conversaciones de mensajes Cuando los usuarios responden un mensaje, pueden hacerlo dentro de la conversación, lo que mantiene su respuesta en el contexto del mensaje original. |
GROUPED_MESSAGES |
Son espacios con nombre en los que la conversación se organiza por tema. Los temas y sus respuestas se agrupan. |
UNTHREADED_MESSAGES |
Mensajes directos (MD) entre dos personas y conversaciones grupales entre 3 o más personas. |
SpaceType
Indica el tipo de espacio. Es obligatorio cuando se crea o actualiza un espacio. Salida solo para otros usos.
Enumeraciones | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Reservado. |
SPACE |
Un lugar donde las personas envían mensajes, comparten archivos y colaboran. Un SPACE puede incluir apps de Chat. |
GROUP_CHAT |
Conversaciones grupales entre 3 o más personas Un GROUP_CHAT puede incluir apps de Chat. |
DIRECT_MESSAGE |
Mensajes 1:1 entre dos personas o entre una persona y una app de Chat. |
Tipo
Obsoleto: Usa SpaceType
en su lugar.
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Reservado. |
ROOM |
Conversaciones entre dos o más personas. |
DM |
Mensaje directo 1:1 entre una persona y una app de Chat, en la que todos los mensajes son planos. Ten en cuenta que esto no incluye los mensajes directos entre dos personas. |
SpaceBatchUpdatedEventData
Carga útil de eventos para varias actualizaciones de un espacio.
Tipo de evento: google.workspace.chat.space.v1.batchUpdated
Campos | |
---|---|
spaces[] |
Una lista de los espacios actualizados. |
SpaceEvent
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 desde Google Chat.
Campos | |
---|---|
name |
Es el nombre del recurso del evento de espacio. Formato: |
event_time |
Hora en la que ocurrió el evento. |
event_type |
Tipo de evento espacial. Cada tipo de evento tiene una versión por lotes, que representa varias instancias del tipo de evento que ocurren en un período corto. Para las solicitudes Tipos de eventos compatibles con mensajes:
Tipos de eventos admitidos para las membresías:
Tipos de eventos admitidos para las reacciones:
Tipos de eventos admitidos sobre el espacio:
|
Campo de unión
|
|
message_created_event_data |
Carga útil de evento para un mensaje nuevo. Tipo de evento: |
message_updated_event_data |
Carga útil de evento para un mensaje actualizado. Tipo de evento: |
message_deleted_event_data |
Carga útil de evento para un mensaje borrado. Tipo de evento: |
message_batch_created_event_data |
Carga útil de eventos para varios mensajes nuevos. Tipo de evento: |
message_batch_updated_event_data |
Carga útil de eventos para varios mensajes actualizados. Tipo de evento: |
message_batch_deleted_event_data |
Carga útil de eventos para varios mensajes borrados. Tipo de evento: |
space_updated_event_data |
Carga útil de evento para una actualización del espacio. Tipo de evento: |
space_batch_updated_event_data |
Carga útil de eventos para varias actualizaciones de un espacio. Tipo de evento: |
membership_created_event_data |
Carga útil de evento para una membresía nueva. Tipo de evento: |
membership_updated_event_data |
Carga útil de evento para una membresía actualizada. Tipo de evento: |
membership_deleted_event_data |
Carga útil de evento para una membresía borrada. Tipo de evento: |
membership_batch_created_event_data |
Carga útil de eventos para varias membresías nuevas. Tipo de evento: |
membership_batch_updated_event_data |
Carga útil de eventos para varias membresías actualizadas. Tipo de evento: |
membership_batch_deleted_event_data |
Carga útil de eventos para varias membresías borradas. Tipo de evento: |
reaction_created_event_data |
Carga útil de evento para una reacción nueva. Tipo de evento: |
reaction_deleted_event_data |
Carga útil de evento para una reacción borrada. Tipo de evento: |
reaction_batch_created_event_data |
Carga útil de eventos para varias reacciones nuevas. Tipo de evento: |
reaction_batch_deleted_event_data |
Carga útil de eventos para varias reacciones borradas. Tipo de evento: |
SpaceReadState
El estado de lectura de un usuario dentro de un espacio, que se usa para identificar mensajes leídos y no leídos.
Campos | |
---|---|
name |
Nombre de recurso del estado de lectura del espacio. Formato: |
last_read_time |
Opcional. La hora en la que se actualizó el estado de lectura del espacio del usuario. Por lo general, se corresponde con la marca de tiempo del último mensaje leído o con una marca de tiempo especificada por el usuario para marcar la última posición de lectura en un espacio. |
SpaceUpdatedEventData
Carga útil de evento para un espacio actualizado.
Tipo de evento: google.workspace.chat.space.v1.updated
Campos | |
---|---|
space |
El espacio actualizado. |
Conversación
Una conversación 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 una conversación que coincida.
Campos | |
---|---|
name |
Nombre del recurso del subproceso. Ejemplo: |
thread_key |
Opcional. Entrada para crear o actualizar un subproceso. De lo contrario, solo muestra el resultado. Es el ID del subproceso. Admite hasta 4,000 caracteres. Este ID es exclusivo de la app de Chat que lo establece. Por ejemplo, si varias apps de Chat crean un mensaje con la misma clave de conversación, estos se publicarán en diferentes conversaciones. Para responder en una conversación creada por una persona o por otra app de Chat, especifica el campo de la conversación |
ThreadReadState
El estado de lectura de un usuario dentro de una conversación, que se usa para identificar mensajes leídos y no leídos.
Campos | |
---|---|
name |
Nombre del recurso del estado de lectura del subproceso. Formato: |
last_read_time |
Indica el momento en que se actualizó el estado de lectura del subproceso del usuario. Por lo general, se corresponde con la marca de tiempo del último mensaje leído de una conversación. |
UpdateMembershipRequest
Mensaje de solicitud para actualizar una membresía.
Campos | |
---|---|
membership |
Obligatorio. La membresía que se actualizará. Solo se actualizan los campos especificados por |
update_mask |
Obligatorio. Las rutas de campo que se actualizarán. Separa varios valores con comas o usa Rutas de campo admitidas actualmente:
|
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 |
UpdateMessageRequest
Solicitud para actualizar un mensaje.
Campos | |
---|---|
message |
Obligatorio. Se actualizó el mensaje con los campos. |
update_mask |
Obligatorio. Las rutas de campo que se actualizarán. Separa varios valores con comas o usa Rutas de campo admitidas actualmente:
|
allow_missing |
Opcional. Si |
UpdateSpaceReadStateRequest
Mensaje de solicitud para la API de UpdateSpaceReadState.
Campos | |
---|---|
space_read_state |
Obligatorio. El estado de lectura del espacio y los campos que se actualizarán. Solo es compatible con la actualización del estado de lectura del usuario que realiza la llamada. Para hacer referencia al usuario que realiza la llamada, configura una de las siguientes opciones:
Formato: users/{user}/spaces/{space}/spaceReadState |
update_mask |
Obligatorio. Las rutas de campo que se actualizarán. Rutas de campo admitidas actualmente:
Cuando Para marcar el espacio como leído, establece |
UpdateSpaceRequest
Una solicitud para actualizar un solo espacio.
Campos | |
---|---|
space |
Obligatorio. Espacio con campos que se actualizarán. |
update_mask |
Obligatorio. Las rutas de campo actualizadas, separadas por comas si son varias. Puedes actualizar los siguientes campos de un espacio:
|
use_admin_access |
true , el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.El usuario que realiza la llamada debe ser administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios. Requiere el permiso de OAuth 2.0 Algunos valores de |
Usuario
Un usuario en Google Chat Cuando se muestra como resultado de una solicitud, si tu app de Chat se autentica como usuario, el resultado de un recurso User
solo propaga los datos de name
y type
del usuario.
Campos | |
---|---|
name |
Nombre de recurso de Formato: Para
|
display_name |
Solo salida. El nombre visible del usuario. |
domain_id |
Es el identificador único del dominio de Google Workspace del usuario. |
type |
Tipo de usuario. |
is_anonymous |
Solo salida. Cuando sea |
Tipo
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Valor predeterminado de la enumeración. NO USAR. |
HUMAN |
Usuario humano. |
BOT |
Usuario de la app de Chat |
UserMentionMetadata
Metadatos de anotaciones de las menciones de los usuarios (@)
Campos | |
---|---|
user |
El usuario mencionó. |
type |
Es el tipo de mención del usuario. |
Tipo
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Valor predeterminado de la enumeración. No usar. |
ADD |
Agregar usuario al espacio. |
MENTION |
Menciona al usuario en el espacio. |
WidgetMarkup
Un widget es un elemento de la IU que presenta imágenes y texto.
Campos | |
---|---|
buttons[] |
Una lista de botones. Los botones también son |
Campo de unión data . Una WidgetMarkup solo puede tener uno de los siguientes elementos. Puedes usar varios campos WidgetMarkup para mostrar más elementos. data puede ser solo una de las siguientes opciones: |
|
text_paragraph |
Muestra un párrafo de texto en este widget. |
image |
Muestra una imagen en este widget. |
key_value |
Muestra un elemento de par clave-valor en este widget. |
Botón
Un botón. Puede ser un botón de texto o un botón de imagen.
Campos | |
---|---|
Campo de unión
|
|
text_button |
Un botón con texto y acción |
image_button |
Un botón con imagen y acción |
FormAction
Una acción de formulario describe el comportamiento cuando se envía el formulario. Por ejemplo, puedes invocar Apps Script para manejar el formulario.
Campos | |
---|---|
action_method_name |
El nombre del método se usa para identificar qué parte del formulario activó el envío. Esta información se repite en la app de Chat como parte del evento de clic de tarjeta. Puedes usar el mismo nombre de método para varios elementos que activan un comportamiento común. |
parameters[] |
Lista de parámetros de acción. |
ActionParameter
Lista de parámetros de cadena para proporcionar cuando se invoca el método de acción. Por ejemplo, piensa en tres botones para posponer: Posponer ahora, Posponer un día, Posponer la próxima semana. Puedes usar action method = snooze()
y pasar el tipo de posposición y el tiempo de posposición en la lista de parámetros de cadena.
Campos | |
---|---|
key |
Es el nombre del parámetro para la secuencia de comandos de acción. |
value |
El valor del parámetro. |
Ícono
Es el conjunto de íconos admitidos.
Enumeraciones | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
Imagen
Una imagen especificada mediante una URL y puede tener una acción onclick
.
Campos | |
---|---|
image_url |
Es la URL de la imagen. |
on_click |
La acción |
aspect_ratio |
La relación de aspecto de esta imagen (ancho y alto). Este campo te permite reservar la altura correcta para la imagen mientras esperas a que se cargue. No está diseñada para anular la relación de aspecto integrada de la imagen. Si no se establece, el servidor la completa a través de la precarga de la imagen. |
ImageButton
Un botón de imagen con una acción onclick
.
Campos | |
---|---|
on_click |
La acción |
name |
Es el nombre de este |
Campo de unión icons . El ícono se puede especificar mediante un Icon enum o una URL. icons puede ser solo una de las siguientes opciones: |
|
icon |
Es el ícono especificado por un |
icon_url |
Es el ícono especificado por una URL. |
KeyValue
Un elemento de la IU contiene una clave (etiqueta) y un valor (contenido). Este elemento también puede contener algunas acciones, como el botón onclick
.
Campos | |
---|---|
top_label |
El texto de la etiqueta superior. Se admite texto con formato. Si quieres obtener más información para dar formato al texto, consulta Da formato al texto en apps de Google Chat y Da formato al texto en complementos de Google Workspace. |
content |
Es el texto del contenido. Se admite texto con formato y es siempre obligatorio. Si quieres obtener más información para dar formato al texto, consulta Da formato al texto en apps de Google Chat y Da formato al texto en complementos de Google Workspace. |
content_multiline |
Si el contenido debe ser de varias líneas. |
bottom_label |
El texto de la etiqueta inferior. Se admite texto con formato. Si quieres obtener más información para dar formato al texto, consulta Da formato al texto en apps de Google Chat y Da formato al texto en complementos de Google Workspace. |
on_click |
La acción |
Campo de unión icons . Se debe definir al menos uno de los íconos, top_label y bottom_label . icons puede ser solo una de las siguientes opciones: |
|
icon |
Un valor de enumeración que se reemplaza por la API de Chat con la imagen del ícono correspondiente. |
icon_url |
El ícono especificado por una URL. |
Campo de unión control . Un widget de control Puedes configurar button o switch_widget , pero no ambos. control puede ser solo una de las siguientes opciones: |
|
button |
Un botón en el que se puede hacer clic para activar una acción. |
OnClick
Una acción onclick
(por ejemplo, abrir un vínculo)
Campos | |
---|---|
Campo de unión
|
|
action |
Si se especifica, esta acción |
open_link |
Si se especifica, esta acción |
OpenLink
Un vínculo que abre una ventana nueva.
Campos | |
---|---|
url |
La URL que se abrirá. |
TextButton
Un botón con texto y acción onclick
.
Campos | |
---|---|
text |
El texto del botón |
on_click |
La acción |
TextParagraph
Un párrafo de texto. Se admite texto con formato. Si quieres obtener más información para dar formato al texto, consulta Da formato al texto en apps de Google Chat y Da formato al texto en complementos de Google Workspace.
Campos | |
---|---|
text |
|