Package google.apps.card.v1

Índice

Acción

Una acción que describe el comportamiento cuando se envía el formulario. Por ejemplo, puedes invocar una secuencia de comandos de Apps Script para manejar el formulario. Si se activa la acción, los valores del formulario se envían al servidor.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
function

string

Una función personalizada que se invocará cuando se haga clic en el elemento contenedor o se active de alguna otra manera.

Para ver ejemplos de uso, consulta Lee datos del formulario.
parameters[]

ActionParameter

Lista de parámetros de acción.
loadIndicator

LoadIndicator

Especifica el indicador de carga que muestra la acción mientras se hace la llamada a la acción.
persistValues

bool

Indica si los valores del formulario persisten después de la acción. El valor predeterminado es false.

Si es true, los valores del formulario permanecen después de que se activa la acción. Para permitir que el usuario realice cambios mientras se procesa la acción, establece LoadIndicator en NONE. En el caso de los mensajes de tarjetas en las apps de Chat, también debes establecer la ResponseType de la acción en UPDATE_MESSAGE y usar el mismo card_id de la tarjeta que contenía la acción.

Si es false, los valores del formulario se borran cuando se activa la acción. Para evitar que el usuario realice cambios mientras se procesa la acción, establece LoadIndicator en SPINNER.
interaction

Interaction

Opcional. Obligatorio cuando se abre un diálogo.

Qué hacer en respuesta a una interacción con un usuario, por ejemplo, cuando hace clic en un botón de un mensaje de tarjeta.

Si no se especifica, la app responde ejecutando un action, como abrir un vínculo o ejecutar una función, de manera normal.

Cuando se especifica un interaction, la app puede responder de formas interactivas especiales. Por ejemplo, si estableces interaction en OPEN_DIALOG, la app podrá abrir un diálogo. Cuando se especifica, no se muestra un indicador de carga. Si se especifica para un complemento, se quita toda la tarjeta y no se muestra nada en el cliente.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.
requiredWidgets[]

string

Opcional. Completa esta lista con los nombres de los widgets que necesita esta acción para un envío válido.

Si los widgets enumerados aquí no tienen un valor cuando se invoca esta acción, se anula el envío del formulario.

Disponible para apps de Google Chat y complementos de Google Workspace.
allWidgetsAreRequired

bool

Opcional. Si esto es verdadero, entonces todos los widgets se consideran necesarios para esta acción.

Disponible para apps de Google Chat y complementos de Google Workspace.

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

Para obtener más información, consulta CommonEventObject.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
key

string

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

string

El valor del parámetro.

Interacción

Opcional. Obligatorio cuando se abre un diálogo.

Qué hacer en respuesta a una interacción con un usuario, por ejemplo, cuando hace clic en un botón de un mensaje de tarjeta.

Si no se especifica, la app responde ejecutando un action, como abrir un vínculo o ejecutar una función, de manera normal.

Cuando se especifica un interaction, la app puede responder de formas interactivas especiales. Por ejemplo, si estableces interaction en OPEN_DIALOG, la app podrá abrir un diálogo.

Cuando se especifica, no se muestra un indicador de carga. Si se especifica para un complemento, se quita toda la tarjeta y no se muestra nada en el cliente.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Enumeraciones
INTERACTION_UNSPECIFIED Valor predeterminado action se ejecuta normalmente.
OPEN_DIALOG

Abre un diálogo, una interfaz con ventanas y basada en tarjetas que las apps de Chat usan para interactuar con los usuarios.

Solo es compatible con las apps de Chat en respuesta a clics en botones en mensajes de tarjetas. Si se especifica para un complemento, se quita toda la tarjeta y no se muestra nada en el cliente.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

LoadIndicator

Especifica el indicador de carga que muestra la acción mientras se hace la llamada a la acción.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
SPINNER Muestra un ícono giratorio que indica que se está cargando el contenido.
NONE No se muestra nada.

BorderStyle

Las opciones de estilo para el borde de una tarjeta o un widget, incluidos el tipo y el color del borde.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
type

BorderType

Es el tipo de borde.
strokeColor

Color

Los colores que se usarán cuando el tipo es BORDER_TYPE_STROKE.

Para establecer el color del trazo, especifica un valor para los campos red, green y blue. El valor debe ser un número flotante entre 0 y 1 en función del valor de color RGB, donde 0 (0/255) representa la ausencia de color y 1 (255/255) representa la intensidad máxima del color.

En el siguiente ejemplo, se establece el color en rojo en su intensidad máxima:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

El campo alpha no está disponible para el color de trazo. Si se especifica, este campo se ignora.
cornerRadius

int32

El radio de la esquina del borde.

BorderType

Representa los tipos de bordes aplicados a los widgets.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
BORDER_TYPE_UNSPECIFIED No usar. Sin especificar.
NO_BORDER Valor predeterminado Sin borde.
STROKE Esquema.

Botón

Un texto, ícono o botón de texto y de ícono en el que los usuarios pueden hacer clic. Para ver un ejemplo en las apps de Google Chat, consulta Agrega un botón.

Para que una imagen sea un botón en el que se pueda hacer clic, especifica un Image (no un ImageComponent) y configura una acción onClick.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
text

string

El texto que se muestra dentro del botón.
icon

Icon

Un ícono que se muestra dentro del botón. Si estableces icon y text, el ícono aparecerá antes del texto.
color

Color

Opcional. El color del botón. Si se establece, el botón type se establece en FILLED, y el color de los campos text y icon se establece en un color contrastante para facilitar la lectura. Por ejemplo, si el color del botón se establece en azul, el texto o los íconos del botón se establecerán en blanco.

Para establecer el color del botón, especifica un valor para los campos red, green y blue. El valor debe ser un número flotante entre 0 y 1 en función del valor de color RGB, donde 0 (0/255) representa la ausencia de color y 1 (255/255) representa la intensidad máxima del color.

En el siguiente ejemplo, se establece el color en rojo en su intensidad máxima:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

El campo alpha no está disponible para el color del botón. Si se especifica, este campo se ignora.
onClick

OnClick

Obligatorio. La acción que se debe realizar cuando un usuario hace clic en el botón, como abrir un hipervínculo o ejecutar una función personalizada.
disabled

bool

Si es true, el botón se muestra en estado inactivo y no responde a las acciones del usuario.
altText

string

El texto alternativo que se usa para la accesibilidad.

Establece un texto descriptivo que permita a los usuarios saber lo que hace el botón. Por ejemplo, si un botón abre un hipervínculo, podrías escribir: “Se abre una nueva pestaña del navegador y se navega a la documentación para desarrolladores de Google Chat en https://developers.google.com/workspace/chat".
type

Type

Opcional. Indica el tipo de botón. Si no se establece, el tipo de botón predeterminado es OUTLINED. Si se configura el campo color, el tipo de botón se fuerza a FILLED y se ignora cualquier valor configurado para este campo.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Tipo

Opcional. Indica el tipo de botón. Si se configura el campo color, type se fuerza a FILLED.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Enumeraciones
TYPE_UNSPECIFIED No usar. Sin especificar.
OUTLINED Los botones con contorno son botones de énfasis medio. Suelen contener acciones importantes, pero no son la acción principal en una app de Chat o un complemento.
FILLED Un botón con relleno tiene un contenedor de un color sólido. Tiene el mayor impacto visual y se recomienda para la acción importante y principal en una app de Chat o un complemento.
FILLED_TONAL Un botón tonal relleno es un término medio alternativo entre los botones rellenos y con contorno. Son útiles en contextos en los que un botón de menor prioridad requiere un poco más de énfasis que un botón de contorno.
BORDERLESS Un botón no tiene un contenedor invisible en su estado predeterminado. A menudo, se usa para las acciones de menor prioridad, especialmente cuando se presentan varias opciones.

ButtonList

Una lista de botones dispuestos horizontalmente. Para ver un ejemplo en las apps de Google Chat, consulta Agrega un botón.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
buttons[]

Button

Una matriz de botones.

Tarjeta

Una interfaz de tarjeta que se muestra en un mensaje de Google Chat o en un complemento de Google Workspace.

Las tarjetas admiten un diseño definido, elementos de interfaz de usuario interactivos, como botones, y rich media, como imágenes. Usa las tarjetas para presentar información detallada, recopilar información de los usuarios y guiarlos a dar el siguiente paso.

Diseña tarjetas y obtén una vista previa de ellas con Card Builder.

Abre el Creador de tarjetas

Para aprender a compilar tarjetas, consulta la siguiente documentación:

Ejemplo: Mensaje de tarjeta para una app de Google Chat

Ejemplo de tarjeta de contacto

Para crear el mensaje de tarjeta de muestra en Google Chat, usa el siguiente JSON:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Campos
header

CardHeader

El encabezado de la tarjeta. Un encabezado generalmente contiene una imagen inicial y un título. Los encabezados siempre aparecen en la parte superior de las tarjetas.
sections[]

Section

Contiene una colección de widgets. Cada sección tiene su propio encabezado opcional. Las secciones están separadas visualmente por un divisor de líneas. Para ver un ejemplo en las apps de Google Chat, consulta Define la sección de una tarjeta.
sectionDividerStyle

DividerStyle

el estilo de divisor entre las secciones.
cardActions[]

CardAction

Las acciones de la tarjeta. Las acciones se agregan al menú de la barra de herramientas de la tarjeta.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

Por ejemplo, el siguiente JSON construye un menú de acciones de tarjeta con las opciones Settings y Send Feedback:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

Es el nombre de la tarjeta. Se usa como identificador de tarjeta en la navegación de tarjetas.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.
fixedFooter

CardFixedFooter

El pie de página fijo que se muestra en la parte inferior de esta tarjeta.

Si se configura fixedFooter sin especificar primaryButton o secondaryButton, se produce un error. En el caso de las apps de Chat, puedes usar pies de página fijos en los diálogos, pero no los mensajes de tarjetas.

Disponible para apps de Google Chat y complementos de Google Workspace.
displayStyle

DisplayStyle

En complementos de Google Workspace, establece las propiedades de visualización de peekCardHeader.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.
peekCardHeader

CardHeader

Al mostrar contenido contextual, el encabezado de la tarjeta de vista previa actúa como un marcador de posición para que el usuario pueda navegar entre las tarjetas de la página principal y las tarjetas contextuales.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

CardAction

Una acción con tarjeta es la acción asociada con la tarjeta. Por ejemplo, una tarjeta de factura puede incluir acciones como borrar factura, enviar una factura por correo electrónico o abrir la factura en un navegador.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

Campos
actionLabel

string

La etiqueta que se muestra como el elemento del menú de acciones.
onClick

OnClick

La acción onClick para este elemento de acción.

CardFixedFooter

Es un pie de página persistente (fijo) que aparece en la parte inferior de la tarjeta.

Si se configura fixedFooter sin especificar primaryButton o secondaryButton, se produce un error.

En el caso de las apps de Chat, puedes usar pies de página fijos en los diálogos, pero no los mensajes de tarjetas. Para ver un ejemplo en las apps de Google Chat, consulta Agrega un pie de página persistente.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
primaryButton

Button

El botón principal del pie de página fijo El botón debe ser de texto con texto y colores establecidos.
secondaryButton

Button

El botón secundario del pie de página fijo El botón debe ser de texto con texto y colores establecidos. Si se establece secondaryButton, también debes configurar primaryButton.

CardHeader

Representa el encabezado de una tarjeta. Para ver un ejemplo en las apps de Google Chat, consulta Agrega un encabezado.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
title

string

Obligatorio. El título del encabezado de la tarjeta 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

string

El subtítulo del encabezado de la tarjeta. Si se especifica, aparece en su propia línea debajo de title.
imageType

ImageType

La forma que se usa para recortar la imagen.

Disponible para apps de Google Chat y complementos de Google Workspace.
imageUrl

string

Es la URL HTTPS de la imagen que se encuentra en el encabezado de la tarjeta.
imageAltText

string

Texto alternativo de esta imagen que se usa con fines de accesibilidad.

DisplayStyle

En complementos de Google Workspace, determina cómo se muestra una tarjeta.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

Enumeraciones
DISPLAY_STYLE_UNSPECIFIED No usar. Sin especificar.
PEEK El encabezado de la tarjeta aparece en la parte inferior de la barra lateral y cubre parcialmente la tarjeta actual superior de la pila. Cuando haces clic en el encabezado, se muestra la tarjeta en la pila de tarjetas. Si la tarjeta no tiene un encabezado, se usará un encabezado generado.
REPLACE Valor predeterminado La tarjeta se muestra reemplazando la vista de la parte superior de la pila de tarjetas.

DividerStyle

Estilo divisor de una tarjeta. Actualmente, solo se usa para divisores entre las secciones de la tarjeta.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
DIVIDER_STYLE_UNSPECIFIED No usar. Sin especificar.
SOLID_DIVIDER Opción predeterminada. Renderiza un divisor sólido.
NO_DIVIDER Si se establece, no se renderiza ningún divisor. Este estilo quita por completo el divisor del diseño. El resultado es equivalente a no agregar ningún divisor.

Sección

Una sección contiene una colección de widgets que se renderizan verticalmente en el orden en que se especifican.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
header

string

Texto que aparece en la parte superior de una sección. Admite texto simple con formato HTML. 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[]

Widget

Todos los widgets de la sección. Debe contener al menos un widget.
collapsible

bool

Indica si esta sección es contraíble.

Las secciones que se pueden contraer ocultan algunos widgets o todos, pero los usuarios pueden hacer clic en Mostrar más para expandir la sección y ver los widgets ocultos. Los usuarios pueden volver a ocultar los widgets haciendo clic en Mostrar menos.

Para determinar qué widgets están ocultos, especifica uncollapsibleWidgetsCount.
uncollapsibleWidgetsCount

int32

La cantidad de widgets no contraíbles que permanecen visibles incluso cuando se contrae una sección.

Por ejemplo, cuando una sección contiene cinco widgets y la uncollapsibleWidgetsCount se establece en 2, siempre se muestran los dos primeros widgets y los últimos tres se contraen de forma predeterminada. uncollapsibleWidgetsCount solo se tiene en cuenta cuando collapsible es true.
collapseControl

CollapseControl

Opcional. Define los botones para expandir y contraer la sección. Este botón solo se mostrará si la sección se puede contraer. Si no se configura este campo, se usa el botón predeterminado. Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Chip

Un chip de texto, ícono o ícono y texto en el que los usuarios pueden hacer clic.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
icon

Icon

La imagen del ícono. Si estableces icon y text, el ícono aparecerá antes del texto.
label

string

Es el texto que se muestra dentro del chip.
onClick

OnClick

Opcional. La acción que se debe realizar cuando un usuario hace clic en el chip, como abrir un hipervínculo o ejecutar una función personalizada.
enabled
(deprecated)

bool

Indica si el chip está en estado activo y responde a las acciones del usuario. La configuración predeterminada es true. Obsoleta. Usa disabled en su lugar.
disabled

bool

Si el chip está en estado inactivo y omite las acciones del usuario. La configuración predeterminada es false.
altText

string

El texto alternativo que se usa para la accesibilidad.

Establece un texto descriptivo que informe a los usuarios qué hace el chip. Por ejemplo, si un chip abre un hipervínculo, escribe: “Abre una nueva pestaña del navegador y navega a la documentación para desarrolladores de Google Chat en https://developers.google.com/workspace/chat&quot;.

ChipList

Una lista de chips dispuestos en posición horizontal, que se pueden desplazar de forma horizontal o pasar a la siguiente línea.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
layout

Layout

Diseño de lista de chips especificado.
chips[]

Chip

Un array de chips.

Diseño

El diseño de la lista de chips.

Enumeraciones
LAYOUT_UNSPECIFIED No usar. Sin especificar.
WRAPPED Valor predeterminado Si no hay suficiente espacio horizontal, la lista de chips se ajusta a la siguiente línea.
HORIZONTAL_SCROLLABLE Los chips se desplazan horizontalmente si no caben en el espacio disponible.

CollapseControl

Representa un control para expandir y contraer. Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
horizontalAlignment

HorizontalAlignment

La alineación horizontal de los botones para expandir y contraer
expandButton

Button

Opcional. Define un botón personalizable para expandir la sección. Se deben configurar los campos expandButton y contraButton. Solo un campo establecido no tendrá efecto. Si no se configura este campo, se usa el botón predeterminado.
collapseButton

Button

Opcional. Define un botón personalizable para contraer la sección. Se deben configurar los campos expandButton y contraButton. Solo un campo establecido no tendrá efecto. Si no se configura este campo, se usa el botón predeterminado.

Columnas

El widget de Columns muestra hasta 2 columnas en una tarjeta o un diálogo. Puedes agregar widgets a cada columna. los widgets aparecen en el orden en que se especifican. Para ver un ejemplo de las apps de Google Chat, consulta Cómo mostrar tarjetas y diálogos en columnas.

La altura de cada columna está determinada por la columna más alta. Por ejemplo, si la primera columna es más alta que la segunda, ambas tendrán la altura de la primera. Debido a que cada columna puede contener una cantidad distinta de widgets, no puedes definir filas o alinear widgets entre las columnas.

Las columnas se muestran una al lado de la otra. Puedes personalizar el ancho de cada columna con el campo HorizontalSizeStyle. Si el ancho de la pantalla del usuario es demasiado angosto, la segunda columna se ajustará debajo de la primera:

  • En la Web, la segunda columna se ajusta si el ancho de la pantalla es menor o igual que 480 píxeles.
  • En dispositivos iOS, la segunda columna se ajusta si el ancho de la pantalla es menor o igual que 300 pt.
  • En dispositivos Android, la segunda columna se ajusta si el ancho de la pantalla es menor o igual que 320 dp.

Para incluir más de 2 columnas o usar filas, usa el widget Grid.

Disponible para apps de Google Chat y complementos de Google Workspace. Entre las IU de complementos que admiten columnas, se incluyen las siguientes:

  • El diálogo que se muestra cuando los usuarios abren el complemento desde un borrador de correo electrónico.
  • El diálogo que se muestra cuando los usuarios abren el complemento desde el menú Agregar archivo adjunto en un evento del Calendario de Google.
Campos
columnItems[]

Column

Un array de columnas. Puedes incluir hasta 2 columnas en una tarjeta o un diálogo.

Columna

Una columna.

Complementos de Google Workspace y apps de Chat

Campos
horizontalSizeStyle

HorizontalSizeStyle

Especifica cómo una columna rellena el ancho de la tarjeta.
horizontalAlignment

HorizontalAlignment

Especifica si los widgets se alinean a la izquierda, a la derecha o al centro de una columna.
verticalAlignment

VerticalAlignment

Especifica si los widgets se alinean con la parte superior, inferior o central de una columna.
widgets[]

Widgets

Un array de widgets incluidos en una columna. Los widgets aparecen en el orden en que se especifican.

HorizontalSizeStyle

Especifica cómo una columna rellena el ancho de la tarjeta. El ancho de cada columna depende de HorizontalSizeStyle y del ancho de los widgets dentro de la columna.

Complementos de Google Workspace y apps de Chat

Enumeraciones
HORIZONTAL_SIZE_STYLE_UNSPECIFIED No usar. Sin especificar.
FILL_AVAILABLE_SPACE Valor predeterminado La columna llena el espacio disponible, hasta el 70% del ancho de la tarjeta. Si ambas columnas se configuran como FILL_AVAILABLE_SPACE, cada columna ocupa el 50% del espacio.
FILL_MINIMUM_SPACE La columna ocupa la menor cantidad de espacio posible y no más del 30% del ancho de la tarjeta.

VerticalAlignment

Especifica si los widgets se alinean con la parte superior, inferior o central de una columna.

Complementos de Google Workspace y apps de Chat

Enumeraciones
VERTICAL_ALIGNMENT_UNSPECIFIED No usar. Sin especificar.
CENTER Valor predeterminado Alinea los widgets en el centro de una columna.
TOP Alinea los widgets en la parte superior de una columna.
BOTTOM Alinea los widgets en la parte inferior de una columna.

Widgets

Son los widgets admitidos que puedes incluir en una columna.

Complementos de Google Workspace y apps de Chat

Campos

Campo de unión data.

data puede ser una de las siguientes opciones:
textParagraph

TextParagraph

TextParagraph widget
image

Image

Image widget
decoratedText

DecoratedText

DecoratedText widget
buttonList

ButtonList

ButtonList widget
textInput

TextInput

TextInput widget
selectionInput

SelectionInput

SelectionInput widget
dateTimePicker

DateTimePicker

DateTimePicker widget
chipList

ChipList

ChipList widget Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

DateTimePicker

Permite a los usuarios ingresar una fecha, una hora o ambas. Para ver un ejemplo en las apps de Google Chat, consulta Permite que un usuario elija una fecha y una hora.

Los usuarios pueden ingresar texto o usar el selector para seleccionar fechas y horas. Si los usuarios ingresan una hora o fecha no válida, el selector muestra un error que les solicita que ingresen la información correctamente.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
name

string

Es el nombre con el que se identifica el DateTimePicker en un evento de entrada del formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
label

string

Es el texto que solicita a los usuarios que ingresen una fecha, una hora o una fecha y hora. Por ejemplo, si los usuarios están programando una cita, usa una etiqueta como Appointment date o Appointment date and time.
type

DateTimePickerType

Si el widget admite la entrada de una fecha, una hora o la fecha y hora.
valueMsEpoch

int64

Es el valor predeterminado que se muestra en el widget, en milisegundos, desde el tiempo Unix.

Especifica el valor según el tipo de selector (DateTimePickerType):

  • DATE_AND_TIME: Es una fecha y hora de calendario en UTC. Por ejemplo, para representar el 1 de enero de 2023 a las 12:00 p.m. UTC, usa 1672574400000.
  • DATE_ONLY: Es una fecha de calendario a las 00:00:00 UTC. Por ejemplo, para representar el 1 de enero de 2023, usa 1672531200000.
  • TIME_ONLY: Es una hora en UTC. Por ejemplo, para representar las 12:00 p.m., usa 43200000 (o 12 * 60 * 60 * 1000).
timezoneOffsetDate

int32

Número que representa el desplazamiento de la zona horaria desde UTC, en minutos. Si estableces la política, value_ms_epoch se mostrará en la zona horaria especificada. Si no la estableces, el valor predeterminado será la configuración de zona horaria del usuario.
onChangeAction

Action

Se activa cuando el usuario hace clic en Guardar o Borrar en la interfaz DateTimePicker.
validation

Validation

Opcional. Especifica la validación necesaria para este selector de fecha y hora.

Disponible para apps de Google Chat y complementos de Google Workspace.

DateTimePickerType

El formato de la fecha y hora en el widget de DateTimePicker. Determina si los usuarios pueden ingresar una fecha, una hora o ambas.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
DATE_AND_TIME Los usuarios ingresan una fecha y una hora.
DATE_ONLY Los usuarios ingresan una fecha.
TIME_ONLY Los usuarios ingresan una hora.

DecoratedText

Widget que muestra texto con decoraciones opcionales, como una etiqueta encima o debajo del texto, un ícono delante del texto, un widget de selección o un botón después del texto. Para ver un ejemplo en las apps de Google Chat, consulta Muestra texto con texto decorativo.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
icon
(deprecated)

Icon

Obsoleto y se reemplazó por startIcon.
startIcon

Icon

Es el ícono que se muestra delante del texto.
topLabel

string

El texto que aparece sobre text. Siempre se trunca.
text

string

Obligatorio. Es el texto principal.

Admite formatos simples. 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.
wrapText

bool

La configuración para ajustar texto. Si es true, el texto se ajusta y se muestra en varias líneas. De lo contrario, el texto se truncará.

Solo se aplica a text, no a topLabel ni bottomLabel.
bottomLabel

string

El texto que aparece debajo de text. Siempre se ajusta.
onClick

OnClick

Esta acción se activa cuando los usuarios hacen clic en topLabel o bottomLabel.
Campo de unión control. Un botón, un interruptor, una casilla de verificación o una imagen que aparece a la derecha del texto en el widget de decoratedText control puede ser solo uno de los siguientes:
button

Button

Un botón en el que un usuario puede hacer clic para activar una acción.
switchControl

SwitchControl

Un widget de interruptor en el que un usuario puede hacer clic para cambiar su estado y activar una acción.
endIcon

Icon

Un ícono que se muestra después del texto.

Admite íconos integrados y personalizados.

SwitchControl

Puede ser un interruptor de estilo de activación o una casilla de verificación dentro de un widget de decoratedText.

Disponible para apps de Google Chat y complementos de Google Workspace.

Solo se admite en el widget decoratedText.

Campos
name

string

Es el nombre con el que se identifica el widget del interruptor en un evento de entrada del formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
value

string

Es el valor ingresado por un usuario, que se muestra como parte de un evento de entrada del formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
selected

bool

Cuando sea true, se seleccionará el interruptor.
onChangeAction

Action

La acción que se debe realizar cuando cambia el estado del interruptor, como qué función ejecutar.
controlType

ControlType

Cómo aparece el interruptor en la interfaz de usuario

Disponible para apps de Google Chat y complementos de Google Workspace.

ControlType

Cómo aparece el interruptor en la interfaz de usuario

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
SWITCH Un interruptor de forma de botón de activación.
CHECKBOX Obsoleto y se reemplazó por CHECK_BOX.
CHECK_BOX Una casilla de verificación

Separador

Este tipo no tiene campos.

Muestra un divisor entre los widgets como una línea horizontal. Para ver un ejemplo en las apps de Google Chat, consulta Agrega un divisor horizontal entre widgets.

Disponible para apps de Google Chat y complementos de Google Workspace.

Por ejemplo, el siguiente JSON crea un divisor:

"divider": {}

EndNavigation

Acción de flujo de diálogo.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
action

Action

La acción de renderización para que el cliente finalice un flujo de diálogo.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Acción

Los tipos de acción de renderización para que el cliente finalice un flujo de diálogo.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Enumeraciones
ACTION_UNSPECIFIED Acción sin especificar.
CLOSE_DIALOG Cierra el flujo de diálogo.
CLOSE_DIALOG_AND_EXECUTE Cierra el flujo de diálogo y actualiza la tarjeta que lo abrió.

GetAutocompletionResponse

Una respuesta a la obtención del contenedor de autocompletado, que incluye los elementos necesarios para mostrar los elementos de autocompletado en el campo de texto.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat. Por ejemplo:

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
Campos
autoComplete

Suggestions
schema

string

Este es un campo de esquema no-op que podría estar presente en el lenguaje de marcado para la comprobación de sintaxis.

Cuadrícula

Muestra una cuadrícula con una colección de elementos. Los elementos solo pueden incluir texto o imágenes. En el caso de las columnas responsivas, o para incluir más que texto o imágenes, utiliza Columns. Para ver un ejemplo en las apps de Google Chat, consulta Muestra una cuadrícula con una colección de elementos.

Una cuadrícula admite cualquier cantidad de columnas y elementos. La cantidad de filas se determina según los elementos divididos por las columnas. Una cuadrícula con 10 elementos y 2 columnas tiene 5 filas. Una cuadrícula con 11 elementos y 2 columnas tiene 6 filas.

Disponible para apps de Google Chat y complementos de Google Workspace.

Por ejemplo, con el siguiente JSON, se crea una cuadrícula de 2 columnas con un solo elemento:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
Campos
title

string

El texto que se muestra en el encabezado de la cuadrícula
items[]

GridItem

Los elementos que se mostrarán en la cuadrícula
borderStyle

BorderStyle

Es el estilo de borde que se aplicará a cada elemento de la cuadrícula.
columnCount

int32

La cantidad de columnas que se mostrarán en la cuadrícula. Si no se especifica este campo, se usa un valor predeterminado, que varía según dónde se muestra la cuadrícula (diálogo o complementario).
onClick

OnClick

Cada elemento individual de la cuadrícula reutiliza esta devolución de llamada, pero con el identificador y el índice del elemento en la lista de elementos agregados a los parámetros de la devolución de llamada.

GridItem

Representa un elemento en un diseño de cuadrícula. Los elementos pueden contener texto, una imagen o ambos.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
id

string

Es un identificador especificado por el usuario para este elemento de la cuadrícula. Este identificador se muestra en los parámetros de devolución de llamada onClick de la cuadrícula superior.
image

ImageComponent

La imagen que se muestra en el elemento de la cuadrícula.
title

string

Título del elemento de cuadrícula.
subtitle

string

Es el subtítulo del elemento de la cuadrícula.
layout

GridItemLayout

El diseño que se usará para el elemento de cuadrícula.

GridItemLayout

Representa las diversas opciones de diseño disponibles para un elemento de cuadrícula.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
GRID_ITEM_LAYOUT_UNSPECIFIED No usar. Sin especificar.
TEXT_BELOW El título y el subtítulo se muestran debajo de la imagen del elemento de cuadrícula.
TEXT_ABOVE El título y el subtítulo se muestran sobre la imagen del elemento de cuadrícula.

Ícono

Un ícono que se muestra en un widget de una tarjeta. Para ver un ejemplo en las apps de Google Chat, consulta Cómo agregar un ícono.

Admite íconos integrados y personalizados.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
altText

string

Opcional. Una descripción del ícono que se usa para accesibilidad. Si no se especifica, se proporciona el valor predeterminado Button. Como práctica recomendada, debes establecer una descripción útil de lo que muestra el ícono y, si corresponde, lo que hace. Por ejemplo, A user's account portrait o Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Si el ícono está configurado en una Button, la altText aparece como texto auxiliar cuando el usuario coloca el cursor sobre el botón. Sin embargo, si el botón también establece text, se ignora el altText del ícono.
imageType

ImageType

El estilo de recorte aplicado a la imagen. En algunos casos, aplicar un recorte de CIRCLE hace que la imagen se dibuje más grande que un ícono integrado.
Campo de unión icons. El ícono que se muestra en el widget de la tarjeta. Las direcciones (icons) solo pueden ser una de las siguientes opciones:
knownIcon

string

Muestra uno de los íconos integrados que proporciona Google Workspace.

Por ejemplo, para mostrar un ícono de avión, especifica AIRPLANE. Para un autobús, especifica BUS.

Para obtener una lista completa de los íconos compatibles, consulta íconos integrados.
iconUrl

string

Muestra un ícono personalizado alojado en una URL HTTPS.

Por ejemplo:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Los tipos de archivo admitidos incluyen .png y .jpg.
materialIcon

MaterialIcon

Muestra uno de los íconos de material de Google.

Por ejemplo, para mostrar un ícono de casilla de verificación, usa

"materialIcon": {
  "name": "check_box"
}

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Imagen

Una imagen que se especifica mediante una URL y puede tener una acción onClick. Para ver un ejemplo, consulta Agrega una imagen.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
imageUrl

string

Es la URL HTTPS que aloja la imagen.

Por ejemplo:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
onClick

OnClick

Cuando un usuario hace clic en la imagen, el clic activa esta acción.
altText

string

Texto alternativo de esta imagen que se usa con fines de accesibilidad.

ImageComponent

Representa una imagen.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
imageUri

string

Es la URL de la imagen.
altText

string

Es la etiqueta de accesibilidad de la imagen.
cropStyle

ImageCropStyle

El estilo de recorte que se aplicará a la imagen.
borderStyle

BorderStyle

Es el estilo de borde que se aplicará a la imagen.

ImageCropStyle

Representa el estilo de recorte aplicado a una imagen.

Disponible para apps de Google Chat y complementos de Google Workspace.

Por ejemplo, a continuación se muestra cómo aplicar una relación de aspecto de 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
Campos
type

ImageCropType

El tipo de recorte.
aspectRatio

double

La relación de aspecto que se debe usar si el tipo de recorte es RECTANGLE_CUSTOM.

Por ejemplo, a continuación se muestra cómo aplicar una relación de aspecto de 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

ImageCropType

Representa el estilo de recorte aplicado a una imagen.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
IMAGE_CROP_TYPE_UNSPECIFIED No usar. Sin especificar.
SQUARE Valor predeterminado Aplica un recorte cuadrado.
CIRCLE Aplica un recorte circular.
RECTANGLE_CUSTOM Aplica un recorte rectangular con una relación de aspecto personalizada. Establece la relación de aspecto personalizada con aspectRatio.
RECTANGLE_4_3 Aplica un recorte rectangular con una relación de aspecto de 4:3.

LinkPreview

Acción de tarjeta que muestra una tarjeta y un chip inteligente para obtener una vista previa de un vínculo de terceros. Para obtener más información, consulta Cómo obtener una vista previa de vínculos con chips inteligentes.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

Por ejemplo, el siguiente JSON muestra un título único para la vista previa del vínculo y su chip inteligente, y una tarjeta de vista previa con un encabezado y una descripción de texto:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

En el ejemplo, se muestra la siguiente vista previa del vínculo:

Ejemplo de vista previa de vínculo

Campos
previewCard

Card

Es una tarjeta que muestra información sobre un vínculo de un servicio de terceros.
title

string

Es el título que se muestra en el chip inteligente de la vista previa del vínculo. Si no la estableces, el chip inteligente mostrará el encabezado de preview_card.
linkPreviewTitle

string

Es el título que se muestra en la vista previa del vínculo. Si no la estableces, la vista previa del vínculo mostrará el encabezado de preview_card.

MaterialIcon

Un ícono de material de Google, que incluye más de 2,500 opciones.

Por ejemplo, para mostrar un ícono de casilla de verificación con peso y calificación personalizados, escribe lo siguiente:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
name

string

Es el nombre del ícono definido en el ícono de material de Google, por ejemplo, check_box. Se abandonan los nombres no válidos y se reemplazan por una string vacía, lo que hace que no se renderice el ícono.
fill

bool

Indica si el ícono se renderiza como relleno. El valor predeterminado es falso.

Para obtener una vista previa de la configuración de los diferentes íconos, ve a Íconos de fuente de Google y ajusta la configuración en Personalizar.
weight

int32

Es el grosor del trazo del ícono. Elige entre {100, 200, 300, 400, 500, 600, 700}. Si está ausente, el valor predeterminado es 400. Si se especifica cualquier otro valor, se usa el valor predeterminado.

Para obtener una vista previa de la configuración de los diferentes íconos, ve a Íconos de fuente de Google y ajusta la configuración en Personalizar.
grade

int32

El peso y la calificación afectan el grosor de un símbolo. Los ajustes de las calificaciones son más detallados que los de ponderación y tienen un pequeño impacto en el tamaño del símbolo. Elige entre {-25, 0, 200}. Si no está, el valor predeterminado es 0. Si se especifica cualquier otro valor, se usa el valor predeterminado.

Para obtener una vista previa de la configuración de los diferentes íconos, ve a Íconos de fuente de Google y ajusta la configuración en Personalizar.

Acción con cartas que manipula la pila de tarjetas.

Por ejemplo:

1) Agrega una nueva tarjeta a la pila (navega hacia adelante). En el caso de las apps de Chat, solo está disponible para la página principal de la app.

Disponible para apps de Google Chat y complementos de Google Workspace.

 navigations : {
    pushCard : CARD
  }

2) Actualiza la tarjeta en la parte superior de la pila (actualización en el lugar).

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Vuelve un paso sin actualizar.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

  navigations : {
    popCard : true,
  }

4) Vuelve a la página anterior y actualiza la tarjeta.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Vuelve varios pasos a un CARD_NAME definido.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Regresa a la raíz y actualiza la tarjeta.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Ve a la tarjeta especificada y abre esa también.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Reemplaza la tarjeta superior por una nueva. En el caso de las apps de Chat, solo está disponible para la página principal de la app.

Disponible para las apps de Google Chat y los complementos de Google Workspace.

  navigations : {
    updateCard : CARD
  }
Campos

Campo de unión navigate_action.

navigate_action puede ser una de las siguientes opciones:
popToRoot

bool

La pila de tarjetas quita todas las tarjetas, excepto la raíz.
pop

bool

La pila de tarjetas saca una tarjeta.
popToCard

string

La pila de tarjetas muestra todas las tarjetas sobre la tarjeta especificada con su nombre.
pushCard

Card

La pila de cartas empuja una carta sobre la pila de tarjetas.
updateCard

Card

La pila de tarjetas actualiza la tarjeta superior con una tarjeta nueva y conserva los valores de los campos del formulario completados. Para un campo no equivalente, se descarta el valor.
endNavigation

EndNavigation

Acción de navegación de finalización del flujo de diálogo. Para obtener más información, consulta Crea una página principal para una app de Google Chat.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Notificación

Acción de tarjeta que muestra una notificación en la app host.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

Campos
text

string

Texto sin formato para la notificación, sin etiquetas HTML.

OnClick

Representa cómo responder cuando los usuarios hacen clic en un elemento interactivo de una tarjeta, como un botón.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos

Campo de unión data.

data puede ser una de las siguientes opciones:
action

Action

Si se especifica, este onClick activa una acción.
openDynamicLinkAction

Action

Un complemento activa esta acción cuando la acción necesita abrir un vínculo. La diferencia con la open_link anterior es que necesita comunicarse con el servidor para obtener el vínculo. Por lo tanto, se requiere cierto trabajo de preparación para que el cliente web lo haga antes de que regrese la respuesta de acción de vínculo abierto.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.
card

Card

Si se especifica, se envía una nueva tarjeta a la pila de tarjetas después de hacer clic.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.
overflowMenu

OverflowMenu

Si se especifica, este onClick abre un menú ampliado. Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

OnClose

Qué hace el cliente cuando se cierra un vínculo que se abre con una acción OnClick.

La implementación depende de las capacidades de la plataforma del cliente. Por ejemplo, un navegador web podría abrir un vínculo en una ventana emergente con un controlador OnClose.

Si se configuran los controladores OnOpen y OnClose, y la plataforma cliente no admite ambos valores, OnClose tiene prioridad.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

Enumeraciones
NOTHING Valor predeterminado La tarjeta no se vuelve a cargar. no pasa nada.
RELOAD

Vuelve a cargar la tarjeta después de que se cierra la ventana secundaria.

Si se usa junto con OpenAs.OVERLAY, la ventana secundaria actúa como un diálogo modal y la tarjeta superior se bloquea hasta que se cierre la ventana secundaria.

OpenAs

Cuando una acción OnClick abre un vínculo, el cliente puede abrirlo como una ventana de tamaño completo (si ese es el marco que usa el cliente) o como una superposición (como una ventana emergente). La implementación depende de las capacidades de la plataforma del cliente, y el valor seleccionado puede ignorarse si el cliente no lo admite. FULL_SIZE es compatible con todos los clientes.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.

Enumeraciones
FULL_SIZE El vínculo se abre como una ventana de tamaño completo (si ese es el marco que utiliza el cliente).
OVERLAY El vínculo se abre como una superposición, por ejemplo, una ventana emergente.

OverflowMenu

Un widget que presenta un menú emergente con una o más acciones que los usuarios pueden invocar. Por ejemplo, mostrar acciones no principales en una tarjeta. Puedes usar este widget cuando las acciones no caben en el espacio disponible. Para usarlo, especifica este widget en la acción OnClick de los widgets compatibles. Por ejemplo, en un objeto Button.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
items[]

OverflowMenuItem

Obligatorio. Lista de opciones del menú.

OverflowMenuItem

Es una opción que los usuarios pueden invocar en un menú ampliado.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
startIcon

Icon

Es el ícono que se muestra delante del texto.
text

string

Obligatorio. Es el texto que identifica o describe el elemento a los usuarios.
onClick

OnClick

Obligatorio. La acción que se invoca cuando se selecciona una opción del menú. Este OnClick no puede contener un OverflowMenu, se descarta cualquier OverflowMenu especificado y se inhabilita el elemento de menú.
disabled

bool

Indica si la opción del menú está inhabilitada. La configuración predeterminada es "false".

RenderActions

Un conjunto de instrucciones de renderización que le indican a una tarjeta que realice una acción o le indica a la app host del complemento o a la app de Chat que realicen una acción específica de la app.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
action

Action
hostAppAction

HostAppActionMarkup

Acciones que administran las apps de host individuales.
schema

string

Este es un campo de esquema no-op que podría estar presente en el lenguaje de marcado para la comprobación de sintaxis.

Acción

Campos
navigations[]

Navigation

Presiona, muestra o actualiza las tarjetas que se muestran.
notification

Notification

Mostrar una notificación al usuario final
linkPreview

LinkPreview

Muestra una vista previa del vínculo al usuario final.

SelectionInput

Es un widget que crea uno o más elementos de la IU que los usuarios pueden seleccionar. Por ejemplo, un menú desplegable o casillas de verificación. Puedes usar este widget para recopilar datos que se pueden predecir o enumerar. Para ver un ejemplo de apps de Google Chat, consulta Agrega elementos seleccionables de la IU.

Las apps de Chat pueden procesar el valor de los elementos que los usuarios seleccionan o ingresan. Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

Para recopilar datos indefinidos o abstractos de los usuarios, usa el widget de TextInput.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
name

string

Obligatorio. Es el nombre que identifica la entrada de selección en un evento de entrada del formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
label

string

Es el texto que aparece sobre el campo de entrada de selección en la interfaz de usuario.

Especifica el texto que ayude al usuario a ingresar la información que necesita tu app. Por ejemplo, si los usuarios seleccionan la urgencia de un ticket de trabajo en un menú desplegable, la etiqueta podría ser "Urgencia" o "Seleccionar la urgencia".
type

SelectionType

El tipo de elementos que se muestran a los usuarios en un widget SelectionInput. Los tipos de selección admiten diferentes tipos de interacciones. Por ejemplo, los usuarios pueden seleccionar una o más casillas de verificación, pero solo pueden seleccionar un valor de un menú desplegable.
items[]

SelectionItem

Es un array de elementos seleccionables. Por ejemplo, un array de botones de selección o casillas de verificación. Admite hasta 100 elementos.
onChangeAction

Action

Si se especifica, el formulario se envía cuando cambia la selección. Si no se especifica, debes especificar un botón aparte que envíe el formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
multiSelectMaxSelectedItems

int32

Es la cantidad máxima de elementos que un usuario puede seleccionar para menús de selección múltiple. El valor mínimo es 1 artículo. Si no se especifica, el valor predeterminado es de 3 elementos.
multiSelectMinQueryLength

int32

En el caso de los menús de selección múltiple, la cantidad de caracteres de texto que un usuario ingresa antes de que la app consulta se autocompleta y muestra los elementos sugeridos en el menú.

Si no se especifica, el valor predeterminado es 0 caracteres para las fuentes de datos estáticos y 3 caracteres para las fuentes de datos externas.
validation

Validation

En el caso de los menús desplegables, es la validación de este campo de entrada de selección.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campo de unión multi_select_data_source. Para un menú de selección múltiple, la fuente de datos que propaga los elementos de selección.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace. Las direcciones (multi_select_data_source) solo pueden ser una de las siguientes opciones:
externalDataSource

Action

Una fuente de datos externa, como una base de datos relacional
platformDataSource

PlatformDataSource

Una fuente de datos de Google Workspace

PlatformDataSource

Para un widget SelectionInput que usa un menú de selección múltiple, una fuente de datos de Google Workspace. Se usa para propagar elementos en un menú de selección múltiple.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Campos
Campo de unión data_source. Es la fuente de datos. Las direcciones (data_source) solo pueden ser una de las siguientes opciones:
commonDataSource

CommonDataSource

Una fuente de datos que comparten todas las aplicaciones de Google Workspace, como los usuarios de una organización de Google Workspace.
hostAppDataSource

HostAppDataSourceMarkup

Una fuente de datos exclusiva de una aplicación host de Google Workspace, como los espacios de Google Chat

Este campo es compatible con las bibliotecas cliente de la API de Google, pero no está disponible en las bibliotecas cliente de Cloud. Para obtener más información, consulta Instala las bibliotecas cliente.

CommonDataSource

Una fuente de datos que comparten todas las aplicaciones de Google Workspace.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Enumeraciones
UNKNOWN Valor predeterminado No usar.
USER usuarios de Google Workspace. El usuario solo puede ver y seleccionar usuarios de su organización de Google Workspace.

SelectionItem

Es un elemento que los usuarios pueden seleccionar en una entrada de selección, como una casilla de verificación o un interruptor.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
text

string

Es el texto que identifica o describe el elemento a los usuarios.
value

string

Es el valor asociado con este elemento. El cliente debe usar esto como un valor de entrada del formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
selected

bool

Indica si el elemento está seleccionado de forma predeterminada. Si la entrada de selección solo acepta un valor (como para los botones de selección o un menú desplegable), configura este campo únicamente para un elemento.
startIconUri

string

En el caso de los menús de selección múltiple, la URL del ícono se muestra junto al campo text del elemento. Admite archivos PNG y JPEG. Debe ser una URL de HTTPS. Por ejemplo, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
bottomText

string

En el caso de los menús de selección múltiple, una descripción de texto o una etiqueta que se muestra debajo del campo text del elemento.

SelectionType

Es el formato de los elementos que los usuarios pueden seleccionar. Las diferentes opciones admiten distintos tipos de interacciones. Por ejemplo, los usuarios pueden seleccionar varias casillas de verificación, pero solo pueden seleccionar un elemento de un menú desplegable.

Cada entrada de selección admite un tipo de selección. Por ejemplo, no se pueden mezclar interruptores ni casillas de verificación.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
CHECK_BOX Un conjunto de casillas de verificación. Los usuarios pueden seleccionar una o más casillas de verificación.
RADIO_BUTTON Un conjunto de botones de selección. Los usuarios pueden seleccionar un botón de selección.
SWITCH Un conjunto de interruptores Los usuarios pueden activar uno o más interruptores.
DROPDOWN Un menú desplegable Los usuarios pueden seleccionar un elemento del menú.
MULTI_SELECT

Un menú de selección múltiple para datos estáticos o dinámicos. En la barra de menú, los usuarios seleccionan uno o más elementos. Los usuarios también pueden ingresar valores para propagar datos dinámicos. Por ejemplo, los usuarios pueden comenzar a escribir el nombre de un espacio de Google Chat, y el widget lo sugiere automáticamente.

Para propagar elementos de un menú de selección múltiple, puedes usar uno de los siguientes tipos de fuentes de datos:

  • Datos estáticos: los elementos se especifican como objetos SelectionItem en el widget. Hasta 100 elementos.
  • Datos de Google Workspace: Los elementos se propagan con datos de Google Workspace, como los usuarios de Google Workspace o los espacios de Google Chat.
  • Datos externos: Los elementos se propagan desde una fuente de datos externa fuera de Google Workspace.

Para ver ejemplos de cómo implementar menús de selección múltiple, consulta Cómo agregar un menú de selección múltiple.

Disponible para apps de Google Chat y complementos de Google Workspace.

SubmitFormResponse

Una respuesta a un envío de formulario que no es la obtención de un contenedor de autocompletado, que contiene las acciones que debe realizar la tarjeta o la app host del complemento, y si el estado de la tarjeta ha cambiado.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat. Por ejemplo:

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
Campos
renderActions

RenderActions

Es un conjunto de instrucciones de renderización que le indican a la tarjeta que realice una acción o le indica a la app host del complemento que realice una acción específica de la app.
stateChanged

bool

Si el estado de las tarjetas cambió y los datos en las tarjetas existentes están inactivos
schema

string

Este es un campo de esquema no-op que puede estar presente en el lenguaje de marcado para la comprobación de sintaxis.

Sugerencias

Valores sugeridos que los usuarios pueden ingresar. Estos valores aparecen cuando los usuarios hacen clic en el campo de entrada de texto. A medida que los usuarios escriben, los valores sugeridos se filtran de forma dinámica para coincidir con lo que escribieron los usuarios.

Por ejemplo, un campo de entrada de texto para el lenguaje de programación podría sugerir Java, JavaScript, Python y C++. Cuando los usuarios comiencen a escribir Jav, se mostrará la lista de filtros de sugerencias para mostrar Java y JavaScript.

Los valores sugeridos ayudan a guiar a los usuarios para que ingresen valores que la aplicación pueda comprender. Cuando se hace referencia a JavaScript, algunos usuarios pueden ingresar javascript y otros java script. Si sugieres JavaScript, puedes estandarizar la forma en que los usuarios interactúan con tu app.

Cuando se especifica, TextInput.type siempre es SINGLE_LINE, incluso si se establece en MULTIPLE_LINE.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
items[]

SuggestionItem

Una lista de sugerencias que se usan para las recomendaciones de autocompletar en los campos de entrada de texto.

SuggestionItem

Un valor sugerido que los usuarios pueden ingresar en un campo de entrada de texto.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos

Campo de unión content.

content puede ser una de las siguientes opciones:
text

string

Es el valor de una entrada sugerida para un campo de entrada de texto. Esto equivale a lo que los usuarios ingresan por su cuenta.

TextInput

Es un campo en el que los usuarios pueden ingresar texto. Admite sugerencias y acciones ante cambios. Para ver un ejemplo en las apps de Google Chat, consulta Agrega un campo en el que un usuario puede ingresar texto.

Las apps de chat reciben y pueden procesar el valor del texto ingresado durante los eventos de entrada de formularios. Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

Cuando necesites recopilar datos indefinidos o abstractos de los usuarios, usa una entrada de texto. Para recopilar datos definidos o enumerados de los usuarios, usa el widget SelectionInput.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
name

string

Es el nombre con el que se identifica la entrada de texto en un evento de entrada de formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
label

string

El texto que aparece sobre el campo de entrada de texto en la interfaz de usuario.

Especifica el texto que ayude al usuario a ingresar la información que necesita tu app. Por ejemplo, si estás preguntando el nombre de alguien, pero necesitas específicamente su apellido, escribe surname en lugar de name.

Es obligatorio si no se especifica hintText. De lo contrario, es opcional.
hintText

string

Texto que aparece debajo del campo de entrada de texto para ayudar a los usuarios con un mensaje que les pide que ingresen un valor determinado. Este texto siempre está visible.

Es obligatorio si no se especifica label. De lo contrario, es opcional.
value

string

Es el valor ingresado por un usuario, que se muestra como parte de un evento de entrada del formulario.

Si quieres obtener más información para trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.
type

Type

Cómo aparece un campo de entrada de texto en la interfaz de usuario Por ejemplo, si el campo es de una o varias líneas.
onChangeAction

Action

Qué hacer cuando se produce un cambio en el campo de entrada de texto. Por ejemplo, cuando un usuario agrega texto al campo o lo borra.

Algunos ejemplos de acciones que puedes realizar incluyen ejecutar una función personalizada o abrir un diálogo en Google Chat.
initialSuggestions

Suggestions

Valores sugeridos que los usuarios pueden ingresar. Estos valores aparecen cuando los usuarios hacen clic en el campo de entrada de texto. A medida que los usuarios escriben, los valores sugeridos se filtran de forma dinámica para coincidir con lo que escribieron los usuarios.

Por ejemplo, un campo de entrada de texto para el lenguaje de programación podría sugerir Java, JavaScript, Python y C++. Cuando los usuarios comiencen a escribir Jav, se mostrará la lista de filtros de sugerencias para mostrar solo Java y JavaScript.

Los valores sugeridos ayudan a guiar a los usuarios para que ingresen valores que la aplicación pueda comprender. Cuando se hace referencia a JavaScript, algunos usuarios pueden ingresar javascript y otros java script. Si sugieres JavaScript, puedes estandarizar la forma en que los usuarios interactúan con tu app.

Cuando se especifica, TextInput.type siempre es SINGLE_LINE, incluso si se establece en MULTIPLE_LINE.

Disponible para apps de Google Chat y complementos de Google Workspace.
autoCompleteAction

Action

Opcional. Especifica qué acción se debe realizar cuando el campo de entrada de texto proporcione sugerencias a los usuarios que interactúan con él.

Si no se especifica, initialSuggestions establece las sugerencias, y el cliente las procesa.

Si se especifica, la app realiza la acción que se especifica aquí, como ejecutar una función personalizada.

Disponible para los complementos de Google Workspace y no disponible para las apps de Google Chat.
validation

Validation

Especifica la validación necesaria para este campo de entrada de texto.

Disponible para apps de Google Chat y complementos de Google Workspace.
placeholderText

string

Texto que aparece en el campo de entrada de texto cuando el campo está vacío Usa este texto para solicitar a los usuarios que ingresen un valor. Por ejemplo, Enter a number from 0 to 100.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Tipo

Cómo aparece un campo de entrada de texto en la interfaz de usuario Por ejemplo, puede ser un campo de entrada de una sola línea o una entrada de varias líneas. Si se especifica initialSuggestions, type siempre es SINGLE_LINE, incluso si se establece en MULTIPLE_LINE.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
SINGLE_LINE El campo de entrada de texto tiene una altura fija de una línea.
MULTIPLE_LINE El campo de entrada de texto tiene una altura fija de varias líneas.

TextParagraph

Un párrafo de texto que admite formato. Para ver un ejemplo en las apps de Google Chat, consulta Cómo agregar un párrafo de 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.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
text

string

El texto que se muestra en el widget.
maxLines

int32

La cantidad máxima de líneas de texto que se muestran en el widget. Si el texto supera la cantidad máxima de líneas especificada, el contenido excedente se ocultará detrás del botón mostrar más. Si el texto es igual o inferior a la cantidad máxima de líneas especificada, no se muestra el botón mostrar más.

El valor predeterminado es 0, en cuyo caso se muestra todo el contexto. Se ignoran los valores negativos. Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Validación

Representa los datos necesarios para validar el widget al que se adjunta.

Disponible para apps de Google Chat y complementos de Google Workspace.

Campos
characterLimit

int32

Especifica el límite de caracteres para los widgets de entrada de texto. Ten en cuenta que esto solo se usa para la entrada de texto y se ignora para otros widgets.

Disponible para apps de Google Chat y complementos de Google Workspace.
inputType

InputType

Especifica el tipo de los widgets de entrada.

Disponible para apps de Google Chat y complementos de Google Workspace.

InputType

El tipo del widget de entrada.

Enumeraciones
INPUT_TYPE_UNSPECIFIED Tipo no especificado No lo utilices.
TEXT Texto normal que acepta todos los caracteres.
INTEGER Es un valor entero.
FLOAT Un valor flotante.
EMAIL Una dirección de correo electrónico.
EMOJI_PICKER Un emoji seleccionado del selector de emojis proporcionado por el sistema.

Widget

Cada tarjeta está compuesta por widgets.

Un widget es un objeto compuesto que puede representar texto, imágenes, botones y otros tipos de objetos.

Campos
horizontalAlignment

HorizontalAlignment

Especifica si los widgets se alinean a la izquierda, a la derecha o al centro de una columna.
Campo de unión data. Un widget solo puede tener uno de los siguientes elementos. Puedes usar varios campos de widget para mostrar más elementos. Las direcciones (data) solo pueden ser una de las siguientes opciones:
textParagraph

TextParagraph

Muestra un párrafo de texto. Admite texto simple con formato HTML. 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.

Por ejemplo, el siguiente JSON crea un texto en negrita:

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

Image

Muestra una imagen.

Por ejemplo, el siguiente JSON crea una imagen con texto alternativo:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

DecoratedText

Muestra un elemento de texto decorado.

Por ejemplo, con el siguiente JSON, se crea un widget de texto decorado que muestra la dirección de correo electrónico:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

ButtonList

Una lista de botones.

Por ejemplo, el siguiente JSON crea dos botones. El primero es un botón de texto azul y el segundo es un botón de imagen que abre un vínculo:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

TextInput

Muestra un cuadro de texto en el que los usuarios pueden escribir.

Por ejemplo, el siguiente JSON crea una entrada de texto para una dirección de correo electrónico:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Como otro ejemplo, el siguiente JSON crea una entrada de texto para un lenguaje de programación con sugerencias estáticas:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

SelectionInput

Muestra un control de selección que permite a los usuarios seleccionar elementos. Los controles de selección pueden ser casillas de verificación, botones de selección, interruptores o menús desplegables.

Por ejemplo, el siguiente JSON crea un menú desplegable que permite a los usuarios elegir un tamaño:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

DateTimePicker

Muestra un widget que permite a los usuarios ingresar una fecha, hora u fecha y hora.

Por ejemplo, con el siguiente JSON, se crea un selector de fecha y hora para programar una cita:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}
divider

Divider

Muestra un divisor de líneas horizontales entre widgets.

Por ejemplo, el siguiente JSON crea un divisor:

"divider": {
}
grid

Grid

Muestra una cuadrícula con una colección de elementos.

Una cuadrícula admite cualquier cantidad de columnas y elementos. El número de filas se determina por los límites superiores del número de elementos dividido por el número de columnas. Una cuadrícula con 10 elementos y 2 columnas tiene 5 filas. Una cuadrícula con 11 elementos y 2 columnas tiene 6 filas.

Disponible para apps de Google Chat y complementos de Google Workspace.

Por ejemplo, con el siguiente JSON, se crea una cuadrícula de 2 columnas con un solo elemento:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

Columns

Muestra hasta 2 columnas.

Para incluir más de 2 columnas o usar filas, usa el widget Grid.

Por ejemplo, con el siguiente JSON, se crean 2 columnas que contienen párrafos de texto:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
chipList

ChipList

Una lista de chips.

Por ejemplo, el siguiente JSON crea dos chips. El primero es un chip de texto y el segundo es un chip de ícono que abre un vínculo:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

HorizontalAlignment

Especifica si los widgets se alinean a la izquierda, a la derecha o al centro de una columna.

Disponible para apps de Google Chat y no disponible para complementos de Google Workspace.

Enumeraciones
HORIZONTAL_ALIGNMENT_UNSPECIFIED No usar. Sin especificar.
START Valor predeterminado Alinea los widgets en la posición inicial de la columna. Para diseños de izquierda a derecha, se alinea a la izquierda. Para diseños de derecha a izquierda, se alinea a la derecha.
CENTER Alinea los widgets en el centro de la columna.
END Alinea los widgets con la posición final de la columna. Para diseños de izquierda a derecha, alinea los widgets a la derecha. Para diseños de derecha a izquierda, alinea los widgets a la izquierda.

ImageType

La forma que se usa para recortar la imagen.

Disponible para apps de Google Chat y complementos de Google Workspace.

Enumeraciones
SQUARE Valor predeterminado Aplica una máscara cuadrada a la imagen. Por ejemplo, una imagen de 4 × 3 se convierte en 3 × 3.
CIRCLE Aplica una máscara circular a la imagen. Por ejemplo, una imagen de 4 x 3 se convierte en un círculo con un diámetro de 3.