Cards v1

Tarjeta

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

Representación JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Campos
header

object (CardHeader)

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

sections[]

object (Section)

Las secciones están separadas por una línea divisoria.

cardActions[]

object (CardAction)

Son las acciones de esta tarjeta.

name

string

Nombre de la tarjeta.

CardHeader

Representación JSON 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Campos
title

string

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

subtitle

string

Es el subtítulo del encabezado de la tarjeta.

imageStyle

enum (ImageStyle)

Tipo de la imagen (por ejemplo, borde cuadrado o borde circular).

imageUrl

string

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

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Borde cuadrado.
AVATAR Borde circular.

Sección

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

Representación JSON 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Campos
header

string

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

widgets[]

object (WidgetMarkup)

Una sección debe contener al menos un widget.

WidgetMarkup

Un widget es un elemento de la IU que presenta texto e imágenes.

Representación JSON 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Campos
buttons[]

object (Button)

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

Un objeto WidgetMarkup solo puede tener uno de los siguientes elementos. Puedes usar varios campos WidgetMarkup para mostrar más elementos. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
textParagraph

object (TextParagraph)

Muestra un párrafo de texto en este widget.

image

object (Image)

Muestra una imagen en este widget.

keyValue

object (KeyValue)

Muestra un elemento de par clave-valor en este widget.

Es el final de los campos mutuamente excluyentes.

TextParagraph

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

Representación JSON 
{
  "text": string
}
Campos
text

string

Imagen

Imagen especificada por una URL que puede tener una acción de onclick.

Representación JSON 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Campos
imageUrl

string

Es la URL de la imagen.

onClick

object (OnClick)

La acción onclick.

aspectRatio

number

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

OnClick

Una acción de onclick (por ejemplo, abrir un vínculo)

Representación JSON 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Campos
A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
action

object (FormAction)

Si se especifica, esta acción de onclick activa una acción de formulario.

Es el final de los campos mutuamente excluyentes.

FormAction

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 (ActionParameter)
    }
  ]
}
Campos
actionMethodName

string

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

parameters[]

object (ActionParameter)

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

ActionParameter

Lista de parámetros de cadena que se deben proporcionar cuando se invoca el método de acción. Por ejemplo, considera tres botones de posponer: posponer ahora, posponer un día y posponer la próxima semana. Puedes usar action method = snooze() y pasar el tipo y la hora de posposición en la lista de parámetros de cadena.

Representación JSON 
{
  "key": string,
  "value": string
}
Campos
key

string

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

value

string

El valor del parámetro.

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 (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
Campos
topLabel

string

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

content

string

Es el texto del contenido. Se admite texto con formato y siempre es obligatorio. Para obtener más información sobre el formato de texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.

contentMultiline

boolean

Indica si el contenido debe ser de varias líneas.

bottomLabel

string

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

onClick

object (OnClick)

La acción onclick. Solo se puede hacer clic en la etiqueta superior, la etiqueta inferior y la región de contenido.

Se debe definir al menos uno de los íconos, top_label y bottom_label. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
icon

enum (Icon)

Es un valor de enumeración que la API de Chat reemplaza por la imagen del ícono correspondiente.

iconUrl

string

Ícono especificado por una URL.

Es el final de los campos mutuamente excluyentes.
Es un widget de control. Puedes configurar button o switch_widget, pero no ambos. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
button

object (Button)

Es un botón en el que se puede hacer clic para activar una acción.

Es el final de los campos mutuamente excluyentes.

Ícono

Es el conjunto de íconos admitidos.

Enums
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

Es un botón. Puede ser un botón de texto o un botón de imagen.

Representación JSON 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Campos
A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
textButton

object (TextButton)

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

imageButton

object (ImageButton)

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

Es el final de los campos mutuamente excluyentes.

TextButton

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

Representación JSON 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Campos
text

string

El texto del botón

onClick

object (OnClick)

La acción del botón onclick.

ImageButton

Un botón de imagen con una acción de onclick

Representación JSON 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
Campos
onClick

object (OnClick)

La acción onclick.

name

string

Nombre de este imageButton que se usa para la accesibilidad. Se proporciona un valor predeterminado si no se especifica este nombre.

El ícono se puede especificar con un Icon enum o una URL. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
icon

enum (Icon)

El ícono especificado por un enum que indexa a un ícono proporcionado por la API de Chat.

iconUrl

string

Ícono especificado por una URL.

Es el final de los campos mutuamente excluyentes.

CardAction

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

No es compatible con las apps de Google Chat.

Representación JSON 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Campos
actionLabel

string

Es la etiqueta que se mostraba en el elemento del menú de acciones.

onClick

object (OnClick)

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