Package google.apps.card.v1

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 un ejemplo de uso, consulta Lee datos de formulario.

ActionParameter

Lista de parámetros de acción.

LoadIndicator

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

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

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 las apps de Google Chat y no para los complementos de Google Workspace.

string

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

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

bool

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

string

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

string

El valor del parámetro.

BorderType

Es el tipo de borde.

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 de punto flotante entre 0 y 1 según el valor de color RGB, en el que 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 trazo. Si se especifica, este campo se ignora.

int32

Es el radio de esquina del borde.

string

El texto que se muestra dentro del botón.

Icon

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

Color

Opcional. Es 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

Obligatorio. Es la acción que se realizará cuando un usuario haga clic en el botón, como abrir un hipervínculo o ejecutar una función personalizada.

bool

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

string

Es 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, puedes escribir lo siguiente: "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".

Type

Opcional. Indica el tipo de botón. Si no se configura, el tipo de botón se establece de forma predeterminada en 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 las apps de Google Chat y no para los complementos de Google Workspace.

Button

Un array de botones.

CardHeader

Es el encabezado de la tarjeta. Por lo general, un encabezado contiene una imagen principal y un título. Los encabezados siempre aparecen en la parte superior de una tarjeta.

Section

Contiene una colección de widgets. Cada sección tiene su propio encabezado opcional. Las secciones se separan visualmente con un divisor de línea. Para ver un ejemplo en las apps de Google Chat, consulta Define la sección de una tarjeta.

DividerStyle

Es el estilo del divisor entre el encabezado, las secciones y el pie de página.

CardAction

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

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

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

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

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.

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 las apps de Google Chat y los complementos de Google Workspace.

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.

CardHeader

Cuando se muestra contenido contextual, el encabezado de la tarjeta de vista previa actúa como 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.

string

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

OnClick

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

Button

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

Button

Es 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 establecer primaryButton.

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.

string

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

ImageType

Es la forma que se usa para recortar la imagen.

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

string

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

string

Es el texto alternativo de esta imagen que se usa para la accesibilidad.

string

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

Widget

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

bool

Indica si esta sección se puede contraer.

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.

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 uncollapsibleWidgetsCount se establece en 2, siempre se muestran los dos primeros widgets y los tres últimos se contraen de forma predeterminada. uncollapsibleWidgetsCount se tiene en cuenta solo cuando collapsible es true.

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 las apps de Google Chat y no para los complementos de Google Workspace.

Icon

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

string

Es el texto que se muestra dentro del chip.

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.

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.

bool

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

string

Es el texto alternativo que se usa para la accesibilidad.

Establece un texto descriptivo que les permita a los usuarios saber 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".

Layout

Diseño de lista de chips especificado.

Chip

Un array de chips.

HorizontalAlignment

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

Button

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

Button

Opcional. Define un botón personalizable para contraer la sección. Se deben configurar los campos expand_button y collapse_button. Solo un conjunto de campos no se aplicará. Si no se configura este campo, se usa el botón predeterminado.

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

TextParagraph widget

Image

Image widget

DecoratedText

DecoratedText widget

ButtonList

ButtonList widget

TextInput

TextInput widget

SelectionInput

SelectionInput widget

DateTimePicker

DateTimePicker widget

ChipList

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

string

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

Para obtener más información sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

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.

DateTimePickerType

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

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 del 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).

int32

Número que representa el desfase de la zona horaria con respecto a UTC, en minutos. Si estableces la política, value_ms_epoch se mostrará en la zona horaria especificada. Si no se establece, el valor predeterminado es la configuración de zona horaria del usuario.

Action

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

Validation

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

Icon

Se dio de baja y se reemplazó por startIcon.

Icon

Es el ícono que se muestra frente al texto.

string

Es el texto que aparece sobre text. Siempre se trunca.

string

Obligatorio. Es el texto principal.

Admite un formato simple. 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.

bool

Es la configuración de ajuste de texto. Si es true, el texto se une y se muestra en varias líneas. De lo contrario, el texto se truncará.

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

string

Es el texto que aparece debajo de text. Siempre se une.

OnClick

Esta acción se activa cuando los usuarios hacen clic en topLabel o bottomLabel.

Button

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

SwitchControl

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

Icon

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

Admite íconos integrados y personalizados.

string

Es el nombre por el que se identifica el widget de interruptor 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.

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.

bool

Cuando es true, el interruptor está seleccionado.

Action

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

ControlType

Cómo aparece el interruptor en la interfaz de usuario

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

string

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

GridItem

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

BorderStyle

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

int32

Es 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

Cada elemento 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.

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.

ImageComponent

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

string

Título del elemento de cuadrícula.

string

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

GridItemLayout

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

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

Es el estilo de recorte aplicado a la imagen. En algunos casos, aplicar un recorte CIRCLE hace que la imagen se dibuje más grande que un ícono integrado.

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.

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

Muestra uno de los íconos de material de Google.

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

"material_icon": {
  "name": "check_box"
}

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

string

Es la URL HTTPS que aloja la imagen.

Por ejemplo:

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

OnClick

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

string

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

string

Es la URL de la imagen.

string

Es la etiqueta de accesibilidad de la imagen.

ImageCropStyle

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

BorderStyle

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

ImageCropType

El tipo de recorte.

double

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

string

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 procese el ícono.

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.

int32

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

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

int32

El grosor y el grado 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á presente, el valor predeterminado es 0. Si se especifica cualquier otro valor, se usará 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.

Action

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

OpenLink

Si se especifica, onClick activa una acción de vínculo abierto.

Action

Un complemento activa esta acción cuando 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 complementos de Google Workspace y no disponible para apps de Google Chat.

Card

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

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

OverflowMenu

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

string

La URL que se abrirá.

OpenAs

Cómo abrir un vínculo

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

OnClose

Si el cliente se olvida de un vínculo después de abrirlo o lo observa hasta que se cierra la ventana.

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

OverflowMenuItem

Obligatorio. La lista de opciones del menú.

Icon

Es el ícono que se muestra delante del texto.

string

Obligatorio. Es el texto que identifica o describe el artículo a los usuarios.

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

bool

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

string

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

Para obtener más información sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

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 desde un menú desplegable, la etiqueta podría ser "Urgency" o "Select urgency".

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.

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.

Action

Si se especifica, el formulario se envía cuando cambia la selección. Si no se especifica, debes especificar un botón independiente 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.

int32

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

int32

En el caso de los menús de selección múltiple, es la cantidad de caracteres de texto que un usuario ingresa antes de que la app consulte el autocompletado y muestre los elementos sugeridos en el menú.

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

Validation

Para los menús desplegables, la validación de este campo de entrada de selección.

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

Action

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

PlatformDataSource

Una fuente de datos de Google Workspace

CommonDataSource

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

HostAppDataSourceMarkup

Es una fuente de datos única para una aplicación de 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.

string

Es el texto que identifica o describe el artículo a los usuarios.

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.

bool

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

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.

string

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

SuggestionItem

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

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.

string

Es el nombre por 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.

string

Es 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 le preguntas el nombre a alguien, pero necesitas específicamente su apellido, escribe surname en lugar de name.

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

string

Es el texto que aparece debajo del campo de entrada de texto para ayudar a los usuarios pidiéndoles que ingresen un valor determinado. Este texto siempre está visible.

Obligatorio si no se especifica label. De lo contrario, es opcional.

string

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

Para obtener más información sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

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.

Action

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

Algunos ejemplos de acciones que se pueden realizar son ejecutar una función personalizada o abrir un diálogo en Google Chat.

Suggestions

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

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 comienzan a escribir Jav, la lista de sugerencias se filtra para mostrar solo Java y JavaScript.

Los valores sugeridos ayudan a guiar a los usuarios para que ingresen valores que la app pueda comprender. Cuando se hace referencia a JavaScript, algunos usuarios pueden ingresar javascript y otros java script. Sugerir JavaScript puede 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.

Action

Opcional. Especifica qué acción se debe realizar cuando el campo de entrada de texto proporciona 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 especificada aquí, como ejecutar una función personalizada.

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

Validation

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

string

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

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

string

Es el texto que se muestra en el widget.

int32

Es 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 las apps de Google Chat y no para los complementos de Google Workspace.

int32

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

InputType

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

HorizontalAlignment

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

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

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

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

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

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

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

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

Por ejemplo, el siguiente JSON 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

Muestra un divisor de línea horizontal entre los widgets.

Por ejemplo, el siguiente JSON crea un divisor:

"divider": {
}

Grid

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 límites superiores de la cantidad de elementos divididos por la cantidad 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

Muestra hasta 2 columnas.

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

Por ejemplo, el siguiente JSON crea 2 columnas, cada una con 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

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.