Tarjeta
Una interfaz de tarjeta que se muestra en un mensaje de Google Chat o un complemento de Google Workspace.
Las tarjetas admiten un diseño definido, elementos interactivos de la IU, como botones, y contenido rich media, como imágenes. Usa tarjetas para presentar información detallada, recopilar información de los usuarios y guiarlos para que realicen el siguiente paso.
Diseña tarjetas y obtén una vista previa de ellas con Card Builder.
Abre el compilador de tarjetas
Para aprender a crear tarjetas, consulta la siguiente documentación:
- Para las apps de Google Chat, consulta Cómo diseñar los componentes de una tarjeta o un diálogo.
- Para los complementos de Google Workspace, consulta Interfaces basadas en tarjetas.
Ejemplo: Mensaje de tarjeta para una app de Google Chat
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"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
Representación JSON |
---|
{ "header": { object ( |
Campos | |
---|---|
header
|
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 una tarjeta. |
sections[]
|
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 una sección de una tarjeta. |
section
|
Es el estilo del divisor entre el encabezado, las secciones y el pie de página. |
card
|
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 JSON crea un menú de acciones de tarjetas con opciones
|
name
|
Es el nombre de la tarjeta. Se usa como identificador de tarjeta en la navegación de tarjetas. Disponible para complementos de Google Workspace y no disponible para apps de Google Chat. |
fixed
|
El pie de página fijo que se muestra en la parte inferior de esta tarjeta.
Si se configura Disponible para las apps de Google Chat y los complementos de Google Workspace. |
display
|
En complementos de Google Workspace, establece las propiedades de visualización de Disponible para complementos de Google Workspace y no disponible para apps de Google Chat. |
peek
|
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. |
CardHeader
Representa el encabezado de una tarjeta. Para ver un ejemplo en las apps de Google Chat, consulta Cómo agregar un encabezado.
Disponible para apps de Google Chat y complementos de Google Workspace.
Representación JSON |
---|
{
"title": string,
"subtitle": string,
"imageType": enum ( |
Campos | |
---|---|
title
|
Obligatorio. Es 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
|
Es el subtítulo del encabezado de la tarjeta. Si se especifica, aparece en su propia línea debajo de |
image
|
Es la forma que se usa para recortar la imagen. Disponible para las apps de Google Chat y los complementos de Google Workspace. |
image
|
Es la URL HTTPS de la imagen en el encabezado de la tarjeta. |
image
|
Es el texto alternativo de esta imagen que se usa para la accesibilidad. |
ImageType
Es 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. |
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.
Representación JSON |
---|
{ "header": string, "widgets": [ { object ( |
Campos | |
---|---|
header
|
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. |
widgets[]
|
Todos los widgets de la sección. Debe contener al menos un widget. |
collapsible
|
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 |
uncollapsible
|
Es 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 |
collapse
|
Opcional. Define el botón para expandir y contraer 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. Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace. |
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.
Representación JSON |
---|
{ "horizontalAlignment": enum ( |
Campos | |
---|---|
horizontal
|
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.
data puede ser solo una de las siguientes opciones:
|
|
text
|
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:
|
image
|
Muestra una imagen. Por ejemplo, el siguiente JSON crea una imagen con texto alternativo:
|
decorated
|
Muestra un elemento de texto decorado. Por ejemplo, el siguiente JSON crea un widget de texto decorado que muestra la dirección de correo electrónico:
|
button
|
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:
|
text
|
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:
En este otro ejemplo, el siguiente JSON crea una entrada de texto para un lenguaje de programación con sugerencias estáticas:
|
selection
|
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:
|
date
|
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:
|
divider
|
Muestra un divisor de línea horizontal entre los widgets. Por ejemplo, el siguiente JSON crea un divisor:
|
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, el siguiente JSON crea una cuadrícula de 2 columnas con un solo elemento:
|
columns
|
Muestra hasta 2 columnas.
Para incluir más de 2 columnas o usar filas, usa el widget
Por ejemplo, con el siguiente JSON, se crean 2 columnas que contienen párrafos de texto:
|
chip
|
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:
Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace. |
TextParagraph
Un párrafo de texto que admite el 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.
Representación JSON |
---|
{ "text": string, "maxLines": integer } |
Campos | |
---|---|
text
|
El texto que se muestra en el widget. |
max
|
La cantidad máxima de líneas de texto que se muestran en el widget. Si el texto excede la cantidad máxima de líneas especificada, el contenido excedente se oculta detrás del botón mostrar más. Si el texto es igual o más corto que la cantidad máxima de líneas especificada, no se mostrará 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 disponible para los 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.
Representación JSON |
---|
{
"imageUrl": string,
"onClick": {
object ( |
Campos | |
---|---|
image
|
Es la URL HTTPS que aloja la imagen. Por ejemplo:
|
on
|
Cuando un usuario hace clic en la imagen, el clic activa esta acción. |
alt
|
Texto alternativo de esta imagen que se usa con fines de accesibilidad. |
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.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
action
|
Si se especifica, este |
open
|
Si se especifica, este |
open
|
Un complemento activa esta acción cuando necesita abrir un vínculo. La diferencia con el Disponible para complementos de Google Workspace y no disponible para apps de Google Chat. |
card
|
Si se especifica, se envía una nueva tarjeta a la pila de tarjetas después de hacer clic. Disponible para complementos de Google Workspace y no disponible para apps de Google Chat. |
overflow
|
Si se especifica, esta |
Acción
Es 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 controlar el formulario. Si se activa la acción, los valores del formulario se envían al servidor.
Disponible para las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "function": string, "parameters": [ { object ( |
Campos | |
---|---|
function
|
Es una función personalizada que se invoca cuando se hace clic en el elemento contenedor o se activa de otra manera. Para ver un ejemplo de uso, consulta Cómo leer datos del formulario. |
parameters[]
|
Es la lista de parámetros de acción. |
load
|
Especifica el indicador de carga que muestra la acción mientras se hace la llamada a la acción. |
persist
|
Indica si los valores del formulario persisten después de la acción. El valor predeterminado es
Si es
Si es |
interaction
|
Opcional. Es 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
Cuando se especifica un Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace. |
required
|
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. |
all
|
Opcional. Si es así, todos los widgets se consideran obligatorios para esta acción.
Disponible para las apps de Google Chat y los complementos de Google Workspace. |
ActionParameter
Es una lista de parámetros de cadena que se deben proporcionar cuando se invoca el método de acción. Por ejemplo, considera tres botones para posponer: posponer ahora, posponer un día o 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 las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "key": string, "value": string } |
Campos | |
---|---|
key
|
Es el nombre del parámetro para la secuencia de comandos de acción. |
value
|
El valor del parámetro. |
LoadIndicator
Especifica el indicador de carga que muestra la acción mientras se realiza la llamada a la acción.
Disponible para las apps de Google Chat y los complementos de Google Workspace.
Enumeraciones | |
---|---|
SPINNER
|
Muestra un ícono giratorio que indica que se está cargando el contenido. |
NONE
|
No se muestra nada. |
Interacción
Opcional. Es 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 configuras 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.
Enumeraciones | |
---|---|
INTERACTION_UNSPECIFIED
|
Valor predeterminado action se ejecuta normalmente.
|
OPEN_DIALOG
|
Abre un diálogo, una interfaz basada en ventanas y tarjetas que usan las apps de Chat 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 las apps de Google Chat y no para los complementos de Google Workspace. |
OpenLink
Representa un evento onClick
que abre un hipervínculo.
Disponible para apps de Google Chat y complementos de Google Workspace.
Representación JSON |
---|
{ "url": string, "openAs": enum ( |
Campos | |
---|---|
url
|
La URL que se abrirá. |
open
|
Cómo abrir un vínculo Disponible para complementos de Google Workspace y no disponible para apps de Google Chat. |
on
|
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. |
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 usa el cliente). |
OVERLAY
|
El vínculo se abre como una superposición, por ejemplo, una ventana emergente. |
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 puede 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 puede admitir ambos valores, OnClose
tiene prioridad.
Disponible para complementos de Google Workspace y no disponible para apps de Google Chat.
Enumeraciones | |
---|---|
NOTHING
|
Valor predeterminado La tarjeta no se vuelve a cargar y no sucede nada. |
RELOAD
|
Vuelve a cargar la tarjeta después de que se cierra la ventana secundaria.
Si se usa junto con |
OverflowMenu
Es 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 que lo admiten. Por ejemplo, en un objeto Button
.
Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.
Representación JSON |
---|
{
"items": [
{
object ( |
Campos | |
---|---|
items[]
|
Obligatorio. Lista de opciones del menú. |
OverflowMenuItem
Es una opción que los usuarios pueden invocar en un menú ampliado.
Disponible para las apps de Google Chat y no para los complementos de Google Workspace.
Representación JSON |
---|
{ "startIcon": { object ( |
Campos | |
---|---|
start
|
Es el ícono que se muestra delante del texto. |
text
|
Obligatorio. Es el texto que identifica o describe el elemento a los usuarios. |
on
|
Obligatorio. Es la acción que se invoca cuando se selecciona una opción de menú. Este |
disabled
|
Indica si la opción de menú está inhabilitada. La configuración predeterminada es "false". |
Í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 las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "altText": string, "imageType": enum ( |
Campos | |
---|---|
alt
|
Opcional. Es una descripción del ícono que se usa para accesibilidad. Si no se especifica, se proporciona el valor predeterminado
Si el ícono se establece en un |
image
|
Es el estilo de recorte aplicado a la imagen. En algunos casos, aplicar un recorte de |
Campo de unión icons . El ícono que se muestra en el widget de la tarjeta.
icons puede ser solo una de las siguientes opciones:
|
|
known
|
Muestra uno de los íconos integrados que proporciona Google Workspace.
Por ejemplo, para mostrar un ícono de avión, especifica Para obtener una lista completa de los íconos compatibles, consulta íconos integrados. |
icon
|
Muestra un ícono personalizado alojado en una URL HTTPS. Por ejemplo:
Entre los tipos de archivo compatibles, se incluyen |
material
|
Muestra uno de los íconos de material de Google. Por ejemplo, para mostrar un ícono de casilla de verificación, usa
Disponible para las apps de Google Chat y no para los complementos de Google Workspace. |
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 grosor y calificación personalizados, escribe lo siguiente:
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.
Representación JSON |
---|
{ "name": string, "fill": boolean, "weight": integer, "grade": integer } |
Campos | |
---|---|
name
|
Es el nombre del ícono definido en el ícono de material de Google, por ejemplo, |
fill
|
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
|
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 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. |
grade
|
El grosor y el grado afectan el grosor de un símbolo. Los ajustes de grado son más detallados que los ajustes de grosor 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 usa 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. |
DecoratedText
Es un widget que muestra texto con decoraciones opcionales, como una etiqueta sobre 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 las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "icon": { object ( |
Campos | |
---|---|
icon
|
Dejó de estar disponible y se reemplazó por |
start
|
Es el ícono que se muestra frente al texto. |
top
|
El texto que aparece sobre |
text
|
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. |
wrap
|
La configuración de ajuste de texto. Si es
Solo se aplica a |
bottom
|
El texto que aparece debajo de |
on
|
Esta acción se activa cuando los usuarios hacen clic en |
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 decoratedText .
control puede ser solo una de las siguientes opciones:
|
|
button
|
Es un botón en el que un usuario puede hacer clic para activar una acción. |
switch
|
Un widget de interruptor en el que un usuario puede hacer clic para cambiar su estado y activar una acción. |
end
|
Un ícono que se muestra después del texto. Admite íconos integrados y personalizados. |
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 convertir una imagen en un botón en el que se puede hacer clic, especifica un elemento
(no un Image
) y configura una acción ImageComponent
onClick
.
Disponible para las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "text": string, "icon": { object ( |
Campos | |
---|---|
text
|
El texto que se muestra dentro del botón. |
icon
|
Un ícono que se muestra dentro del botón. Si se configuran |
color
|
Opcional. El color del botón. Si se establece, el botón
Para establecer el color del botón, especifica un valor para los campos En el siguiente ejemplo, se establece el color en rojo en su intensidad máxima:
El campo |
on
|
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. |
disabled
|
Si es |
alt
|
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
|
Opcional. Indica el tipo de botón. Si no se configura, el tipo de botón predeterminado es Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace. |
Color
Representa un color en el espacio de color RGBA. Esta representación está diseñada para simplificar la conversión desde y hacia las representaciones de color en varios idiomas por sobre la compactación. Por ejemplo, los campos de esta representación se pueden proporcionar de forma trivial al constructor de java.awt.Color
en Java, también se pueden proporcionar de forma trivial al método +colorWithRed:green:blue:alpha
de UIColor en iOS y, con un poco de trabajo, se pueden dar formato fácilmente a una cadena rgba()
de CSS en JavaScript.
Esta página de referencia no tiene información sobre el espacio de color absoluto que se debe usar para interpretar el valor RGB, por ejemplo, sRGB, Adobe RGB, DCI-P3 y BT.2020. De forma predeterminada, las aplicaciones deben asumir el espacio de color sRGB.
Cuando se debe decidir la igualdad de color, las implementaciones, a menos que se documente lo contrario, tratan dos colores como iguales si todos sus valores rojo, verde, azul y alfa difieren como máximo en 1e-5
.
Ejemplo (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
Ejemplo (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
Ejemplo (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
Representación JSON |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
Campos | |
---|---|
red
|
La cantidad de rojo en el color como un valor en el intervalo [0, 1]. |
green
|
La cantidad de verde en el color como un valor en el intervalo [0, 1]. |
blue
|
La cantidad de azul en el color como un valor en el intervalo [0, 1]. |
alpha
|
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:
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 representa como un color sólido (como si al valor alfa se le hubiera dado explícitamente un valor de 1.0). |
Tipo
Opcional. El tipo de un botón. Si se configura el campo color
, type
se establece de forma forzosa en FILLED
.
Disponible para las apps de Google Chat y no para los 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 relleno tiene un contenedor con 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 punto medio alternativo entre los botones rellenos y con contorno. Son útiles en contextos en los que un botón de prioridad inferior requiere un poco más de énfasis que el que le daría un botón con contorno. |
BORDERLESS
|
Un botón no tiene un contenedor invisible en su estado predeterminado. A menudo, se usa para las acciones de menor prioridad, en especial cuando se presentan varias opciones. |
SwitchControl
Puede ser un interruptor de estilo de activación o una casilla de verificación dentro de un widget decoratedText
.
Disponible para apps de Google Chat y complementos de Google Workspace.
Solo se admite en el widget decoratedText
.
Representación JSON |
---|
{ "name": string, "value": string, "selected": boolean, "onChangeAction": { object ( |
Campos | |
---|---|
name
|
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 Recibe datos de formularios. |
value
|
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 Recibe datos de formularios. |
selected
|
Cuando se establece |
on
|
La acción que se debe realizar cuando cambia el estado del interruptor, como qué función ejecutar. |
control
|
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
|
Se dio de baja y se reemplazó por CHECK_BOX .
|
CHECK_BOX
|
Una casilla de verificación |
ButtonList
Una lista de botones dispuestos horizontalmente. Para ver un ejemplo en las apps de Google Chat, consulta Agrega un botón.
Disponible para las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{
"buttons": [
{
object ( |
Campos | |
---|---|
buttons[]
|
Un array de botones. |
TextInput
Es un campo en el que los usuarios pueden ingresar texto. Admite sugerencias y acciones de cambio. Para ver un ejemplo en las apps de Google Chat, consulta Cómo agregar un campo en el que un usuario pueda 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 Recibe 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 las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum ( |
Campos | |
---|---|
name
|
Es el nombre con el que se identifica la entrada de texto 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. |
label
|
El texto que aparece sobre el campo de entrada de texto en la interfaz de usuario.
Especifica un 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
Obligatorio si no se especifica |
hint
|
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.
Obligatorio si no se especifica |
value
|
Es el valor que ingresa un usuario, que se muestra como parte de 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. |
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. |
on
|
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. |
initial
|
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 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 comienzan a escribir
Los valores sugeridos ayudan a guiar a los usuarios para que ingresen valores que tu app pueda interpretar. Cuando se hace referencia a JavaScript, algunos usuarios pueden ingresar
Cuando se especifica, Disponible para apps de Google Chat y complementos de Google Workspace. |
auto
|
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, Si se especifica, la app realiza la acción que se especifica aquí, como ejecutar una función personalizada. Disponible para complementos de Google Workspace y no disponible para apps de Google Chat. |
validation
|
Especifica la validación necesaria para este campo de entrada de texto.
Disponible para apps de Google Chat y complementos de Google Workspace. |
placeholder
|
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, Disponible para las apps de Google Chat y no disponible para los 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. |
RenderActions
Es 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 |
Acción
Campos | |
---|---|
navigations[] |
Envía o actualiza las tarjetas que se muestran. |
Sugerencias
Son 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 Java
y JavaScript
.
Los valores sugeridos ayudan a guiar a los usuarios para que ingresen valores que tu app pueda entender. 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 las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{
"items": [
{
object ( |
Campos | |
---|---|
items[]
|
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 las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
text
|
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. |
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.
Representación JSON |
---|
{
"characterLimit": integer,
"inputType": enum ( |
Campos | |
---|---|
character
|
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. |
input
|
Especifica el tipo de widgets de entrada.
Disponible para apps de Google Chat y complementos de Google Workspace. |
InputType
Es el tipo de widget de entrada.
Enumeraciones | |
---|---|
INPUT_TYPE_UNSPECIFIED
|
Tipo no especificado No lo utilices. |
TEXT
|
Texto normal que acepta todos los caracteres. |
INTEGER
|
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. |
SelectionInput
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 en las apps de Google Chat, consulta Cómo agregar elementos de IU seleccionables.
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 Recibe datos de formularios.
Para recopilar datos indefinidos o abstractos de los usuarios, usa el widget TextInput
.
Disponible para las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Campos | |
---|---|
name
|
Obligatorio. Es el nombre que identifica la entrada de selección en 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. |
label
|
El texto que aparece sobre el campo de entrada de selección en la interfaz de usuario. Especifica un 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 urgencia". |
type
|
El tipo de elementos que se muestran a los usuarios en un widget |
items[]
|
Es un array de elementos seleccionables. Por ejemplo, un array de botones de selección o casillas de verificación. Admite hasta 100 elementos. |
on
|
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 Recibe datos de formularios. |
multi
|
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 3 elementos. |
multi
|
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
|
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
Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.
|
|
external
|
Una fuente de datos externa, como una base de datos relacional |
platform
|
Una fuente de datos de Google Workspace |
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 las apps de Google Chat y los 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 para un menú de selección múltiple, puedes usar uno de los siguientes tipos de fuentes de datos:
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 las apps de Google Chat y los complementos 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.
Representación JSON |
---|
{ "text": string, "value": string, "selected": boolean, "startIconUri": string, "bottomText": string } |
Campos | |
---|---|
text
|
Es el texto que identifica o describe el elemento a los usuarios. |
value
|
Es el valor asociado con este elemento. El cliente debe usar esto como un valor 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. |
selected
|
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. |
start
|
En el caso de los menús de selección múltiple, la URL del ícono se muestra junto al campo |
bottom
|
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 |
PlatformDataSource
Para un widget
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.
SelectionInput
Disponible para las apps de Google Chat y no para los complementos de Google Workspace.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión data_source . Es la fuente de datos.
data_source solo puede ser uno de los siguientes:
|
|
common
|
Es una fuente de datos que comparten todas las aplicaciones de Google Workspace, como los usuarios de una organización de Google Workspace. |
host
|
Es una fuente de datos única para una aplicación de host de Google Workspace, como los espacios de Google Chat. Este campo admite 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
Es una fuente de datos que comparten todas las aplicaciones de Google Workspace.
Disponible para las apps de Google Chat y no para los 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. |
HostAppDataSourceMarkup
Para un widget
que usa un menú de selección múltiple, una fuente de datos de una aplicación de Google Workspace. La fuente de datos propaga los elementos de selección para el menú de selección múltiple.
SelectionInput
Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión data_source . La aplicación de Google Workspace que propaga elementos para un menú de selección múltiple.
data_source solo puede ser uno de los siguientes:
|
|
chat
|
Una fuente de datos de Google Chat. |
ChatClientDataSourceMarkup
Para un widget
que usa un menú de selección múltiple, una fuente de datos de Google Chat. La fuente de datos propaga los elementos de selección para el menú de selección múltiple. Por ejemplo, un usuario puede seleccionar espacios de Google Chat de los que es miembro.
SelectionInput
Disponible para las apps de Google Chat y no para los complementos de Google Workspace.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión source . La fuente de datos de Google Chat
source solo puede ser uno de los siguientes:
|
|
space
|
Espacios de Google Chat de los que el usuario es miembro |
SpaceDataSource
Es una fuente de datos que propaga los espacios de Google Chat como elementos de selección para un menú de selección múltiple. Solo se propagan los espacios de los que el usuario es miembro.
Disponible para las apps de Google Chat y no para los complementos de Google Workspace.
Representación JSON |
---|
{ "defaultToCurrentSpace": boolean } |
Campos | |
---|---|
default
|
Si se establece en |
DateTimePicker
Permite a los usuarios ingresar una fecha, una hora o ambas. Para ver un ejemplo en las apps de Google Chat, consulta Cómo permitir que un usuario elija una fecha y 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.
Representación JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Campos | |
---|---|
name
|
Es el nombre con el que se identifica el Para obtener más información sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios. |
label
|
Es el texto que 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 |
type
|
Si el widget admite la entrada de una fecha, una hora o la fecha y hora. |
value
|
Es el valor predeterminado que se muestra en el widget, en milisegundos desde la época Unix.
Especifica el valor según el tipo de selector (
|
timezone
|
Es el número que representa la diferencia de zona horaria respecto de UTC, en minutos. Si se establece, |
on
|
Se activa cuando el usuario hace clic en Guardar o Borrar en la interfaz |
validation
|
Opcional. Especifica la validación necesaria para este selector de fecha y hora.
Disponible para las apps de Google Chat y los 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 las apps de Google Chat y los complementos de Google Workspace.
Enumeraciones | |
---|---|
DATE_AND_TIME
|
Los usuarios ingresan una fecha y hora. |
DATE_ONLY
|
Los usuarios ingresan una fecha. |
TIME_ONLY
|
Los usuarios ingresan una hora. |
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 Cómo agregar 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": {}
Cuadrícula
Muestra una cuadrícula con una colección de elementos. Los elementos solo pueden incluir texto o imágenes. Para columnas responsivas o para incluir más que texto o imágenes, usa
. Para ver un ejemplo en las apps de Google Chat, consulta Cómo mostrar una cuadrícula con una colección de elementos.
Columns
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 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"
}
}
}
Representación JSON |
---|
{ "title": string, "items": [ { object ( |
Campos | |
---|---|
title
|
Es el texto que se muestra en el encabezado de la cuadrícula. |
items[]
|
Los elementos que se mostrarán en la cuadrícula |
border
|
Es el estilo de borde que se aplicará a cada elemento de la cuadrícula. |
column
|
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). |
on
|
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 las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "id": string, "image": { object ( |
Campos | |
---|---|
id
|
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 |
image
|
Es la imagen que se muestra en el elemento de la cuadrícula. |
title
|
Título del elemento de cuadrícula. |
subtitle
|
El subtítulo del elemento de cuadrícula. |
layout
|
Es el diseño que se usará para el elemento de la cuadrícula. |
ImageComponent
Representa una imagen.
Disponible para apps de Google Chat y complementos de Google Workspace.
Representación JSON |
---|
{ "imageUri": string, "altText": string, "cropStyle": { object ( |
Campos | |
---|---|
image
|
Es la URL de la imagen. |
alt
|
Es la etiqueta de accesibilidad de la imagen. |
crop
|
Es el estilo de recorte que se aplicará a la imagen. |
border
|
Es el estilo de borde que se aplicará a la imagen. |
ImageCropStyle
Representa el estilo de recorte aplicado a una imagen.
Disponible para las apps de Google Chat y los complementos de Google Workspace.
Por ejemplo, aquí se muestra cómo aplicar una relación de aspecto de 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
Representación JSON |
---|
{
"type": enum ( |
Campos | |
---|---|
type
|
El tipo de recorte. |
aspect
|
Es la relación de aspecto que se usará si el tipo de recorte es Por ejemplo, a continuación se muestra cómo aplicar una relación de aspecto de 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. |
BorderStyle
Son las opciones de diseño para el borde de una tarjeta o un widget, incluido el tipo y el color del borde.
Disponible para las apps de Google Chat y los complementos de Google Workspace.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type
|
Es el tipo de borde. |
stroke
|
Son los colores que se usarán cuando el tipo sea
Para establecer el color del trazo, especifica un valor para los campos En el siguiente ejemplo, se establece el color en rojo en su intensidad máxima:
El campo |
corner
|
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
|
Outline |
GridItemLayout
Representa las diferentes opciones de diseño disponibles para un elemento de cuadrícula.
Disponible para las apps de Google Chat y los 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. |
Columnas
El widget 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 en las apps de Google Chat, consulta Cómo mostrar tarjetas y diálogos en columnas.
La altura de cada columna se determina según la columna más alta. Por ejemplo, si la primera columna es más alta que la segunda, ambas columnas tienen la altura de la primera. Dado que cada columna puede contener una cantidad diferente de widgets, no puedes definir filas ni 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 une si el ancho de la pantalla es inferior o igual a 300 pt.
- En dispositivos Android, la segunda columna se une si el ancho de la pantalla es inferior o igual a 320 dp.
Para incluir más de dos columnas o usar filas, usa el widget
.
Grid
Disponible para las apps de Google Chat y los 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.
- Es 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.
Representación JSON |
---|
{
"columnItems": [
{
object ( |
Campos | |
---|---|
column
|
Un array de columnas. Puedes incluir hasta 2 columnas en una tarjeta o un diálogo. |
Columna
Una columna.
Representación JSON |
---|
{ "horizontalSizeStyle": enum ( |
Campos | |
---|---|
horizontal
|
Especifica cómo una columna completa el ancho de la tarjeta. |
horizontal
|
Especifica si los widgets se alinean a la izquierda, a la derecha o en el centro de una columna. |
vertical
|
Especifica si los widgets se alinean en 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. |
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.
Enumeraciones | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED
|
No usar. Sin especificar. |
FILL_AVAILABLE_SPACE
|
Valor predeterminado La columna ocupa 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. |
HorizontalAlignment
Especifica si los widgets se alinean a la izquierda, a la derecha o en el centro de una columna.
Disponible para las apps de Google Chat y no disponible para los 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. En el caso de los diseños de izquierda a derecha, alinea los widgets a la derecha. En el caso de los diseños de derecha a izquierda, alinea los widgets a la izquierda. |
VerticalAlignment
Especifica si los widgets se alinean con la parte superior, inferior o central de una columna.
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
Los widgets compatibles que puedes incluir en una columna.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
text
|
|
image
|
|
decorated
|
|
button
|
|
text
|
|
selection
|
|
date
|
|
chip
|
|
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 las apps de Google Chat y no para los complementos de Google Workspace.
Representación JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout
|
Diseño de lista de chips especificado. |
chips[]
|
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. |
Chip
Un texto, un ícono o un chip de texto y un ícono en el que los usuarios pueden hacer clic.
Disponible para las apps de Google Chat y no para los complementos de Google Workspace.
Representación JSON |
---|
{ "icon": { object ( |
Campos | |
---|---|
icon
|
La imagen del ícono. Si se configuran |
label
|
Es el texto que se muestra dentro del chip. |
on
|
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
|
Indica si el chip está en un estado activo y responde a las acciones del usuario. La configuración predeterminada es
|
disabled
|
Indica si el chip está en un estado inactivo y si ignora las acciones del usuario. La configuración predeterminada es |
alt
|
Es 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". |
CollapseControl
Representa un control para expandir y contraer. Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.
Representación JSON |
---|
{ "horizontalAlignment": enum ( |
Campos | |
---|---|
horizontal
|
Es la alineación horizontal del botón para expandir y contraer. |
expand
|
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 se aplicará. Si no se establece este campo, se usa el botón predeterminado. |
collapse
|
Opcional. Define un botón personalizable para contraer la sección. Se deben configurar los campos expandButton y collapseButton. Solo un campo establecido no tendrá efecto. Si no se configura este campo, se usa el botón predeterminado. |
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. |
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 complementos de Google Workspace y no disponible para apps de Google Chat.
Representación JSON |
---|
{
"actionLabel": string,
"onClick": {
object ( |
Campos | |
---|---|
action
|
La etiqueta que se muestra como el elemento del menú de acciones. |
on
|
Es la acción |
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 superior actual de la pila. Cuando haces clic en el encabezado, la tarjeta aparece en la pila de tarjetas. Si la tarjeta no tiene encabezado, se usa uno generado. |
REPLACE
|
Valor predeterminado La tarjeta se muestra reemplazando la vista de la parte superior de la pila de tarjetas. |