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 un divisor de líneas.

cardActions[]

object (CardAction)

Las acciones de esta tarjeta.

name

string

Es el 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

El subtítulo del encabezado de la tarjeta.

imageStyle

enum (ImageStyle)

El tipo de imagen (por ejemplo, borde cuadrado o borde circular).

imageUrl

string

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 se necesitan propiedades de diseño (por ejemplo, flotante).

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

string

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 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 imágenes y texto.

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

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
Campos
buttons[]

object (Button)

Una lista de botones. Buttons también es oneof data y solo se debe configurar uno de estos campos.

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 solo puede ser uno de los siguientes:
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.

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

Es una imagen especificada mediante una URL y puede tener una acción 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 la llena mediante la carga previa de la imagen.

OnClick

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

Representación JSON 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
Campos

Campo de unión data.

data solo puede ser uno de los siguientes:

action

object (FormAction)

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

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 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[]

object (ActionParameter)

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

ActionParameter

Es una lista de parámetros de cadena que se deben 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.

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

string

Es el nombre del parámetro de 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)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
Campos
topLabel

string

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

content

string

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

contentMultiline

boolean

Si el contenido debe ser de varias líneas.

bottomLabel

string

El texto de la etiqueta inferior. Se admite el 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.

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.

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

enum (Icon)

Un valor de enumeración que se reemplaza por la API de Chat con la imagen del ícono correspondiente.

iconUrl

string

Es 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 solo puede ser uno de los siguientes:
button

object (Button)

Es 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 de imagen.

Representación JSON 
{

  // Union field type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
Campos

Campo de unión type.

type solo puede ser uno de los siguientes:

textButton

object (TextButton)

Un botón con texto y acción onclick

imageButton

object (ImageButton)

Un botón con imagen y acción onclick

TextButton

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

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

string

El texto del botón

onClick

object (OnClick)

La acción onclick del botón.

ImageButton

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

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
Campos
onClick

object (OnClick)

La acción onclick

name

string

Es el nombre de este imageButton que se usa para accesibilidad. Si no se especifica este nombre, se proporciona el valor predeterminado.

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

enum (Icon)

Es el ícono especificado por una enum que indexa un ícono proporcionado por la API de Chat.

iconUrl

string

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 la factura, enviarla por correo electrónico o abrirla en el navegador.

Las apps de Google Chat no son compatibles con esta opción.

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

string

La etiqueta que se solía mostrar en el elemento del menú de acciones.

onClick

object (OnClick)

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