Tarjeta
Una tarjeta es un elemento de la IU que puede contener widgets de IU, como imágenes y texto.
Representación JSON |
---|
{ "header": { object ( |
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. |
cardActions[]
|
Las acciones de esta tarjeta. |
name
|
Es el nombre de la tarjeta. |
CardHeader
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 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. |
imageStyle
|
El tipo de imagen (por ejemplo, borde cuadrado o borde circular). |
imageUrl
|
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).
Representación JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
Campos | |
---|---|
header
|
Es el encabezado de la sección. Se admite texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en las apps de Google Chat y Dar formato al texto en 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. Los botones también
|
Campo de unión
data R
WidgetMarkup
solo puede tener uno de los siguientes elementos. Puedes usar varios
WidgetMarkup
para mostrar más elementos.
data
solo puede ser 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 de par clave-valor en este widget. |
TextParagraph
Un párrafo de texto. Se admite texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en las apps de Google Chat y Dar formato al texto en complementos de Google Workspace.
Representación JSON |
---|
{ "text": string } |
Campos | |
---|---|
text
|
|
Imagen
Una imagen especificada por una URL y puede tener una
onclick
acción.
Representación JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
Campos | |
---|---|
imageUrl
|
Es la URL de la imagen. |
onClick
|
El
|
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á diseñada para anular la relación de aspecto integrada de la imagen. Si no se configura, el servidor la llena mediante la carga previa de la imagen. |
OnClick
Los
onclick
acción (por ejemplo, abrir un vínculo).
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
action
|
Se activa una acción del formulario a partir de
|
openLink
|
Esta
|
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.
Representación JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
Campos | |
---|---|
actionMethodName
|
El nombre del método se utiliza 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. Podrías usar
action method = snooze()
, pasando el tipo de posponer y el tiempo de posposición en la lista de parámetros de cadena.
Representación JSON |
---|
{ "key": string, "value": string } |
Campos | |
---|---|
key
|
Es el nombre del parámetro para 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 abrirá. |
KeyValue
Un elemento de la IU contiene una clave (etiqueta) y un valor (contenido). Este elemento también puede contener algunas acciones, como
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. Para obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en las apps de Google Chat y Dar formato al texto en complementos de Google Workspace. |
content
|
Es el texto del contenido. Se admite texto con formato y es siempre obligatorio. Para obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en las apps de Google Chat y Dar formato al texto en complementos de Google Workspace. |
contentMultiline
|
Si el contenido debe ser de varias líneas. |
bottomLabel
|
El texto de la etiqueta inferior. Se admite texto con formato. Para obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en las apps de Google Chat y Dar formato al texto en complementos de Google Workspace. |
onClick
|
El
|
Campo de unión
icons Al menos uno de los íconos,
top_label
y
bottom_label
se deben definir las reglas de firewall.
icons
solo puede ser 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 especificado por una URL. |
Campo de unión
control Un widget de control Puedes establecer
button
o
switch_widget , pero no ambos.
control
solo puede ser una de las siguientes opciones:
|
|
button
|
Un botón en el que se puede hacer clic para activar una acción. |
Í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
|
Botón
Un botón. Puede ser un botón de texto o un botón de imagen.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
textButton
|
Un botón con texto y
|
imageButton
|
Un botón con imagen y
|
TextButton
Un botón con texto y
onclick
acción.
Representación JSON |
---|
{
"text": string,
"onClick": {
object (
|
Campos | |
---|---|
text
|
El texto del botón |
onClick
|
El
|
ImageButton
Un botón de imagen con un
onclick
acción.
Representación JSON |
---|
{ "onClick": { object ( |
Campos | |
---|---|
onClick
|
El
|
name
|
El nombre de este
|
Campo de unión
icons El icono se puede especificar con un
Icon
enum
o una URL.
icons
solo puede ser una de las siguientes opciones:
|
|
icon
|
Ícono especificado por un
|
iconUrl
|
El ícono especificado por una URL. |
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.
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" de este elemento de acción. |