Cards v2

object (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.

object (Section)

Contiene una colección de widgets. Cada sección tiene su propio encabezado opcional. Las secciones están separadas visualmente por una línea divisoria. Para ver un ejemplo en las apps de Google Chat, consulta Cómo definir una sección de una tarjeta.

enum (DividerStyle)

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

object (CardAction)

Son 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 código JSON crea 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"
      }
    }
  }
]

string

Nombre de la tarjeta. Se usa como identificador de la tarjeta en la navegación de tarjetas.

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

object (CardFixedFooter)

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

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

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

enum (DisplayStyle)

En los 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.

object (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 hacia adelante 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

Obligatorio. Es el título del encabezado de la tarjeta. El encabezado tiene una altura fija: si se especifican un título y un subtítulo, cada uno ocupa una línea. Si solo se especifica el título, este ocupará ambas líneas.

string

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

enum (ImageType)

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 en el encabezado de la tarjeta.

string

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

string

Es el texto que aparece en la parte superior de una sección. Admite texto con formato HTML simple. Para obtener más información sobre el formato de texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.

object (Widget)

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

boolean

Indica si esta sección se puede contraer.

Las secciones contraíbles ocultan algunos o todos los widgets, pero los usuarios pueden expandir la sección para revelar los widgets ocultos haciendo clic en Mostrar más. Los usuarios pueden volver a ocultar los widgets haciendo clic en Mostrar menos.

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

integer

Es la cantidad de widgets que no se pueden contraer y que permanecen visibles incluso cuando se contrae una sección.

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

object (CollapseControl)

Opcional. Define el botón de expansión y contracción de la sección. Este botón solo se mostrará si la sección se puede contraer. Si no se establece este campo, se usa el botón predeterminado.

enum (HorizontalAlignment)

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

object (TextParagraph)

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

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

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

object (Image)

Muestra una imagen.

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

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

object (DecoratedText)

Muestra un elemento de texto decorado.

Por ejemplo, el siguiente código JSON 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"
  }
}

object (ButtonList)

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

object (TextInput)

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

Por ejemplo, el siguiente código 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 código 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"
      }
    ]
  }
}

object (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 código 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
    }
  ]
}

object (DateTimePicker)

Muestra un widget que permite a los usuarios ingresar una fecha, una hora o ambas.

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
}

object (Divider)

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

Por ejemplo, el siguiente código JSON crea un divisor:

"divider": {
}

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

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

object (Columns)

Muestra hasta 2 columnas.

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

Por ejemplo, el siguiente código JSON crea 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"
          }
        }
      ]
    }
  ]
}

object (Carousel)

Un carrusel contiene una colección de widgets anidados. Por ejemplo, esta es una representación JSON de un carrusel que contiene dos párrafos de texto.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

object (ChipList)

Es una lista de chips.

Por ejemplo, el siguiente código 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"
        }
      }
    }
  ]
}

string

Es el texto que se muestra en el widget.

integer

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 oculta detrás de un botón de Mostrar más. Si el texto es igual o más corto que 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.

enum (TextSyntax)

Es la sintaxis del texto. Si no se configura, el texto se renderiza como HTML.

Disponible para las apps de Google Chat y no disponible 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

object (OnClick)

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

string

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

object (Action)

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

object (OpenLink)

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

object (Action)

Un complemento activa esta acción cuando necesita abrir un vínculo. Esto difiere del openLink anterior en que este necesita comunicarse con el servidor para obtener el vínculo. Por lo tanto, el cliente web debe realizar algunos trabajos de preparación antes de que se devuelva la respuesta de la acción de vínculo abierto.

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

object (Card)

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

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

object (OverflowMenu)

Si se especifica, onClick abre un menú ampliado.

string

Es una función personalizada que se invoca cuando se hace clic en el elemento contenedor o se lo activa de otro modo.

Para ver un ejemplo de uso, consulta Cómo leer datos de formularios.

object (ActionParameter)

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

enum (LoadIndicator)

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

boolean

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 el ResponseType de la acción en UPDATE_MESSAGE y usar el mismo cardId 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.

enum (Interaction)

Opcional. Se requiere cuando se abre un diálogo.

Qué hacer en respuesta a una interacción con un usuario, por ejemplo, cuando un usuario hace clic en un botón en 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 forma normal.

Si se especifica un interaction, la app puede responder de formas interactivas especiales. Por ejemplo, si se configura interaction en OPEN_DIALOG, la app puede 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 disponible para los complementos de Google Workspace.

string

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

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

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

boolean

Opcional. Si es verdadero, esta acción considera que todos los widgets son obligatorios.

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

string

Es el nombre del parámetro para el script de acción.

string

El valor del parámetro.

string

Es la URL que se abrirá.

enum (OpenAs)

Cómo abrir un vínculo

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

enum (OnClose)

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

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

object (OverflowMenuItem)

Obligatorio. Es la lista de opciones del menú.

object (Icon)

Es el ícono que se muestra delante del texto.

string

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

object (OnClick)

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

boolean

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

string

Opcional. Es una descripción del ícono que se usa para la 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, de 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 se establece en un Button, el 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.

enum (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 los í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.

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

string

Nombre del ícono definido en el ícono de Material de Google, por ejemplo, check_box. Los nombres no válidos se descartan y se reemplazan por una cadena vacía, lo que provoca que el ícono no se renderice.

boolean

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

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

integer

Es 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 Google Font Icons y ajusta la configuración en Personalizar.

integer

El peso y el grado afectan el grosor de un símbolo. Los ajustes de grado son más detallados que los ajustes de peso 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 los diferentes parámetros de configuración de los íconos, ve a Google Font Icons y ajusta la configuración en Personalizar.

object (Icon)

Se dio de baja y se reemplazó por startIcon.

object (Icon)

Es el ícono que se muestra delante del texto.

enum (VerticalAlignment)

Opcional. Alineación vertical del ícono de inicio. Si no se configura, el ícono se centrará verticalmente.

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

string

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

object (TextParagraph)

TextParagraph equivalente de topLabel. Siempre se trunca. Permite un formato más complejo que topLabel.

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

string

Obligatorio. Es el texto principal.

Admite el formato simple. Para obtener más información sobre el formato de texto, consulta Cómo dar formato al texto en las apps de Google Chat y Cómo dar formato al texto en los complementos de Google Workspace.

object (TextParagraph)

TextParagraph equivalente de text. Permite un formato más complejo que text.

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

boolean

Es el parámetro de configuración de ajuste de texto. Si es true, el texto se ajusta y se muestra en varias líneas. De lo contrario, el texto se trunca.

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

string

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

object (TextParagraph)

TextParagraph equivalente de bottomLabel. Siempre se ajusta. Permite un formato más complejo que bottomLabel.

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

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

Es un ícono que se muestra después del texto.

Admite íconos integrados y personalizados.

string

Es el texto que se muestra dentro del botón.

object (Icon)

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

object (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 está establecido en azul, cualquier texto o ícono del botón se establecerá 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 de punto flotante entre 0 y 1 basado en 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.

Por ejemplo, el siguiente código establece el color 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.

object (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.

boolean

Si es true, el botón se muestra en un 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 les permita a los usuarios saber qué hace el botón. Por ejemplo, si un botón abre un hipervínculo, puedes escribir: "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".

enum (Type)

Opcional. Es el tipo de botón. Si no se configura, el tipo de botón se establece de forma predeterminada en OUTLINED. Si se establece el campo color, el tipo de botón se fuerza a FILLED y se ignora cualquier valor establecido para este campo.

number

La cantidad de rojo en el color como un valor en el intervalo [0, 1].

number

La cantidad de verde en el color como un valor en el intervalo [0, 1].

number

La cantidad de azul en el color como un valor en el intervalo [0, 1].

number

La fracción de este color que se debe aplicar al píxel. Es decir, el color del píxel final se define mediante la siguiente ecuación:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Esto significa que el valor 1.0 corresponde a un color sólido, mientras que el valor 0.0 corresponde a un color completamente transparente. Esto utiliza un mensaje de wrapper en lugar de un escalar flotante simple, para que sea posible distinguir entre un valor predeterminado y el valor que no se configura. Si se omite, este objeto de color se renderiza como un color sólido (como si el valor alfa se hubiera proporcionado de forma explícita con un valor de 1.0).

string

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

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

string

Es el valor que ingresa un usuario y que se devuelve como parte de un evento de entrada de formulario.

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

boolean

Cuando es true, el interruptor está seleccionado.

object (Action)

Es la acción que se realizará cuando cambie el estado del interruptor, como la función que se ejecutará.

enum (ControlType)

Es la forma en que aparece el botón de activación en la interfaz de usuario.

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

object (Button)

Es un array de botones.

string

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

Para obtener detalles 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 texto en la interfaz de usuario.

Especifica el texto que ayuda al usuario a ingresar la información que necesita tu app. Por ejemplo, si le preguntas a alguien su nombre, pero específicamente necesitas 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 y que tiene como objetivo ayudar a los usuarios solicitá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 que ingresa un usuario y que se devuelve como parte de un evento de entrada de formulario.

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

enum (Type)

Es la forma en que aparece un campo de entrada de texto en la interfaz de usuario. Por ejemplo, si el campo es de una sola línea o de varias.

object (Action)

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

Entre los ejemplos de acciones que se pueden realizar, se incluyen ejecutar una función personalizada o abrir un diálogo en Google Chat.

object (Suggestions)

Son los 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 comiencen a escribir Jav, la lista de sugerencias se filtrará para mostrar solo Java y JavaScript.

Los valores sugeridos ayudan a guiar a los usuarios para que ingresen valores que tu app pueda comprender. Cuando se refieren a JavaScript, algunos usuarios pueden ingresar javascript y otros java script. Las sugerencias de JavaScript pueden 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 las apps de Google Chat y los complementos de Google Workspace.

object (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, las sugerencias se establecen con initialSuggestions y el cliente las procesa.

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

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

object (Validation)

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

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

Action

Navigation

Envía, muestra o actualiza una tarjeta.

Complementos en Google Chat.

Card

Coloca una tarjeta en la pila.

En el caso de los diálogos en Google Chat, abre o actualiza un diálogo.

Card

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.

En el caso de los diálogos en Google Chat, abre o actualiza un diálogo.

object (SuggestionItem)

Es una lista de sugerencias que se usan para las recomendaciones de autocompletado 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 ingresan los usuarios.

integer

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

enum (InputType)

Especifica el tipo de widgets de entrada.

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

string

Obligatorio. Nombre que identifica la entrada de selección en un evento de entrada de formulario.

Para obtener detalles 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 ayuda 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 "Selecciona la urgencia".

enum (SelectionType)

Es el tipo de elementos que se muestran a los usuarios en un widget de 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.

object (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.

object (Action)

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

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

integer

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

integer

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

Si no se establece, el menú de selección múltiple usa los siguientes valores predeterminados:

• Si el menú usa un array estático de elementos SelectionInput, el valor predeterminado es 0 caracteres y se propagan los elementos del array de inmediato.
• Si el menú usa una fuente de datos dinámica (multi_select_data_source), el valor predeterminado es 3 caracteres antes de consultar la fuente de datos para devolver elementos sugeridos.

object (Action)

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

object (PlatformDataSource)

Es una fuente de datos de Google Workspace.

string

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

string

Es el valor asociado a este elemento. El cliente debe usarlo como un valor de entrada de formulario.

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

boolean

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), solo configura este campo para un elemento.

string

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

string

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

Este campo admite las bibliotecas cliente de las APIs de Google, pero no está disponible en las bibliotecas cliente de Cloud. Para obtener más información, consulta Instala las bibliotecas cliente.

object (ChatClientDataSourceMarkup)

Es una fuente de datos de Google Chat.

object (SpaceDataSource)

Espacios de Google Chat de los que el usuario es miembro.

boolean

Si se configura como true, el menú de selección múltiple selecciona el espacio de Google Chat actual como un elemento de forma predeterminada.

string

Nombre con el que se identifica el objeto DateTimePicker en un evento de entrada de formulario.

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

string

Es el texto que les solicita a los usuarios que ingresen una fecha, una hora o una fecha y hora. Por ejemplo, si los usuarios programan una cita, usa una etiqueta como Appointment date o Appointment date and time.

enum (DateTimePickerType)

Indica si el widget admite el ingreso de una fecha, una hora o la fecha y la hora.

int64

Es el valor predeterminado que se muestra en el widget, en milisegundos desde el tiempo de época de 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 : Una fecha de calendario a las 00:00:00 UTC. Por ejemplo, para representar el 1 de enero de 2023, usa 1672531200000.
• TIME_ONLY : Una hora en UTC. Por ejemplo, para representar las 12 p.m., usa 43200000 (o 12 * 60 * 60 * 1000).

integer

Es el número que representa el desplazamiento de la zona horaria con respecto al UTC, en minutos. Si se configura, el campo valueMsEpoch se muestra en la zona horaria especificada. Si no se establece, el valor predeterminado es la configuración de zona horaria del usuario.

object (Action)

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

string

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

object (GridItem)

Son los elementos que se mostrarán en la cuadrícula.

object (BorderStyle)

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

integer

Cantidad de columnas que se mostrarán en la cuadrícula. Se usa un valor predeterminado si no se especifica este campo, y ese valor predeterminado es diferente según dónde se muestre la cuadrícula (diálogo o complementario).

object (OnClick)

Cada elemento de la cuadrícula individual 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 devuelve en los parámetros de devolución de llamada onClick de la cuadrícula principal.

object (ImageComponent)

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

string

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

string

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

enum (GridItemLayout)

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

string

Es la URL de la imagen.

string

Es la etiqueta de accesibilidad de la imagen.

object (ImageCropStyle)

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

object (BorderStyle)

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

enum (ImageCropType)

Es el tipo de recorte.

number

Es la relación de aspecto que se usará si el tipo de recorte es RECTANGLE_CUSTOM.

Por ejemplo, así se aplica una relación de aspecto de 16:9:

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

enum (BorderType)

Es el tipo de borde.

object (Color)

Son los colores que se usarán cuando el tipo sea 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 basado en 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.

Por ejemplo, el siguiente código establece el color 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.

integer

Radio de esquina del borde.

object (Column)

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

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

object (TextParagraph)

TextParagraph widget.

object (Image)

Image widget.

object (DecoratedText)

DecoratedText widget.

object (ButtonList)

ButtonList widget.

object (TextInput)

TextInput widget.

object (SelectionInput)

SelectionInput widget.

object (DateTimePicker)

DateTimePicker widget.

object (ChipList)

ChipList widget.

enum (Layout)

Diseño de lista de chips especificado.

object (Chip)

Es un array de chips.

object (Icon)

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.

object (OnClick)

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

boolean

Indica si el chip está en un estado activo y responde a las acciones del usuario. El valor predeterminado es true. Obsoleta. En su lugar, usa disabled.

boolean

Indica si el chip está en un estado inactivo y si ignora las acciones del usuario. El valor predeterminado 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".

object (CarouselCard)

Es una lista de las tarjetas incluidas en el carrusel.

object (NestedWidget)

Es una lista de widgets que se muestran en la tarjeta del carrusel. Los widgets se muestran en el orden en que se especifican.

object (NestedWidget)

Es una lista de widgets que se muestran en la parte inferior de la tarjeta del carrusel. Los widgets se muestran en el orden en que se especifican.

object (TextParagraph)

Es un widget de párrafo de texto.

object (ButtonList)

Es un widget de lista de botones.

object (Image)

Es un widget de imagen.

enum (HorizontalAlignment)

Alineación horizontal del botón de expansión y contracción.

object (Button)

Opcional. Define un botón personalizable para expandir la sección. Se deben configurar los campos expandButton y collapseButton. Solo un conjunto de campos no entrará en vigencia. Si no se establece este campo, se usa el botón predeterminado.

object (Button)

Opcional. Define un botón personalizable para contraer la sección. Se deben configurar los campos expandButton y collapseButton. Solo un conjunto de campos no entrará en vigencia. Si no se establece este campo, se usa el botón predeterminado.

string

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

object (OnClick)

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

object (Button)

Es el botón principal del pie de página fijo. El botón debe ser un botón de texto con texto y color establecidos.

object (Button)

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