Tarjeta
Una tarjeta es un elemento de la IU que puede contener widgets de la IU, como imágenes y texto.
Representación JSON |
---|
{ "header": { object ( |
Campos | |
---|---|
header
|
El encabezado de la tarjeta Los encabezados suelen contener un título y una imagen. |
sections[]
|
Las secciones están separadas por un divisor de línea. |
cardActions[]
|
Las acciones de esta tarjeta. |
name
|
Es el nombre de la tarjeta. |
Encabezado de la tarjeta
Representación JSON |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
Campos | |
---|---|
title
|
Se debe especificar el título. El encabezado tiene una altura fija: si se especifican un título y un subtítulo, cada uno de ellos ocupa una línea. Si solo se especifica el título, ocupará ambas líneas. |
subtitle
|
Es el subtítulo del encabezado de la tarjeta. |
imageStyle
|
Es el tipo de imagen (por ejemplo, borde cuadrado o circular). |
imageUrl
|
Es la URL de la imagen que aparece en el encabezado de la tarjeta. |
Estilo de imagen
Enumeradores | |
---|---|
IMAGE_STYLE_UNSPECIFIED
|
|
IMAGE
|
Borde cuadrado |
AVATAR
|
Borde circular |
Sección
Una sección contiene un conjunto de widgets que se renderizan (verticalmente) en el orden en que se especifican. En todas las plataformas, las tarjetas tienen un ancho fijo limitado, por lo que actualmente no se necesitan propiedades de diseño (por ejemplo, flotante).
Representación JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
Campos | |
---|---|
header
|
Es el encabezado de la sección. Se admite texto con formato. Si deseas obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace. |
widgets[]
|
Una sección debe contener al menos un widget. |
WidgetMarkup
Un widget es un elemento de la IU que presenta imágenes y texto.
Representación JSON |
---|
{ "buttons": [ { object ( |
Campos | |
---|---|
buttons[]
|
Una lista de botones Buttons también es |
Campo de unión data . Un 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:
|
|
textParagraph
|
Muestra un párrafo de texto en este widget. |
image
|
Muestra una imagen en este widget. |
keyValue
|
Muestra un elemento clave-valor en este widget. |
TextParagraph.
Un párrafo de texto. Se admite texto con formato. Si deseas obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.
Representación JSON |
---|
{ "text": string } |
Campos | |
---|---|
text
|
|
Imagen
Es una imagen que se especifica mediante una URL y que puede tener una acción onclick
.
Representación JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
Campos | |
---|---|
imageUrl
|
Es la URL de la imagen. |
onClick
|
La acción |
aspectRatio
|
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á destinada a anular la relación de aspecto integrada de la imagen. Si no la estableces, el servidor la rellenará realizando una carga previa de la imagen. |
Al hacer clic
Una acción onclick
(por ejemplo, abrir un vínculo)
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
action
|
Si se especifica, esta acción |
openLink
|
Esta acción |
Acción de formulario
Una acción de formulario describe el comportamiento cuando se envía el formulario. Por ejemplo, puedes invocar Apps Script para controlar el formulario.
Representación JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
Campos | |
---|---|
actionMethodName
|
El nombre del método se usa para identificar qué parte del formulario activó el envío del formulario. Esta información se repite en la app de Chat como parte del evento de clic de la 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. |
ParámetroActionAction
Lista de los parámetros de string para proporcionar cuando se invoca el método de acción. Por ejemplo, considere tres opciones para posponer un mensaje: posponerlo durante un día o posponer la semana siguiente. Puedes usar action method = snooze()
y pasar el tipo y el tiempo de la alerta pospuesta en la lista de parámetros de string.
Representación JSON |
---|
{ "key": string, "value": string } |
Campos | |
---|---|
key
|
El nombre del parámetro de la secuencia de comandos de acción. |
value
|
El valor del parámetro. |
OpenLink
Un vínculo que abre una ventana nueva.
Representación JSON |
---|
{ "url": string } |
Campos | |
---|---|
url
|
La URL que se debe abrir. |
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
.
Representación JSON |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
Campos | |
---|---|
topLabel
|
El texto de la etiqueta superior Se admite texto con formato. Si deseas obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace. |
content
|
Es el texto del contenido. El texto con formato es compatible y siempre es obligatorio. Si deseas obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace. |
contentMultiline
|
Si el contenido debe ser multilínea |
bottomLabel
|
El texto de la etiqueta inferior Se admite texto con formato. Si deseas obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace. |
onClick
|
La acción |
Campo de unión icons . Se deben 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 |
iconUrl
|
El ícono que especifica 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. |
Ícono
Corresponde al conjunto de íconos admitidos.
Enumeradores | |
---|---|
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
|
Botón
Un botón Puede ser un botón de texto o de imagen.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
textButton
|
Un botón con texto y acción |
imageButton
|
Un botón con imagen y acción de |
BotónTexto
Un botón con texto y acción onclick
Representación JSON |
---|
{
"text": string,
"onClick": {
object (
|
Campos | |
---|---|
text
|
El texto del botón |
onClick
|
Es la acción |
BotóndeImagen
Un botón de imagen con una acción onclick
.
Representación JSON |
---|
{ "onClick": { object ( |
Campos | |
---|---|
onClick
|
La acción |
name
|
Es el nombre de este |
Campo de unión icons . El ícono se puede especificar mediante una Icon
enum o una URL.
icons puede ser solo una de las siguientes opciones:
|
|
icon
|
El ícono especificado por un |
iconUrl
|
El ícono que especifica una URL. |
Acción de la tarjeta
Una acción de tarjeta es la acción asociada con la tarjeta. Para una tarjeta de factura, una acción típica sería: borrar la factura, enviar la factura por correo electrónico o abrir la factura en el navegador.
No es compatible con las apps de Google Chat.
Representación JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
Campos | |
---|---|
actionLabel
|
La etiqueta que se solía mostrar en el elemento del menú de acciones. |
onClick
|
La acción onclick para este elemento de acción. |