Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

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

object (Section)

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

enum (DividerStyle)

el estilo de divisor entre las secciones.

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 JSON construye un menú de acciones de tarjeta con Settings y Send Feedback Opciones:

"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

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

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

object (CardFixedFooter)

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

Si configuras fixedFooter sin especificar un primaryButton o un secondaryButton, se 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 apps de Google Chat y complementos de Google Workspace.

enum (DisplayStyle)

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

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

object (CardHeader)

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

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

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

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

string

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

enum (ImageType)

La forma que se usa para recortar la imagen.

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

string

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

string

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

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}

string

Es el 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 Da formato al texto en las apps de Google Chat y Dar formato al texto en complementos de Google Workspace.

object (Widget)

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

boolean

Indica si esta sección es contraíble.

Las secciones que se pueden contraer ocultan algunos widgets o todos, pero los usuarios pueden expandir la sección para ver los widgets ocultos haciendo clic en ellos. 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 no contraíbles que permanecen visibles incluso cuando se contrae una sección.

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

object (CollapseControl)

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

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

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 simple con formato HTML. Para obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en las apps de Google Chat y Dar formato al texto en complementos de Google Workspace.

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

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

object (Image)

Muestra una imagen.

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

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

object (DecoratedText)

Muestra un elemento de texto decorado.

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

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

object (ButtonList)

Una lista de botones.

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

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

object (TextInput)

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

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

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

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

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

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 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, hora u fecha y hora.

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

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

object (Divider)

Muestra un divisor de líneas horizontales entre widgets.

Por ejemplo, el siguiente 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. El número de filas se determina por los límites superiores del número de elementos dividido por el número de columnas. Una cuadrícula con 10 elementos y 2 columnas tiene 5 filas. Una cuadrícula con 11 elementos y 2 columnas tiene 6 filas.

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

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

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

object (Columns)

Muestra hasta 2 columnas.

Para incluir más de dos columnas o utilizar filas, utiliza la Grid widget.

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

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

object (ChipList)

Una lista de chips.

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

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

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

{
  "text": string,
  "maxLines": integer
}

string

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 excede la cantidad máxima de líneas especificada, el contenido excedente se oculta detrás de un mostrar más . Si el texto es igual o más corto que el número máximo de líneas especificado, una mostrar más no se muestra el botón.

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.

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

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

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

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // End of list of possible types for union field data.
}

object (Action)

Si se especifica, esta acción activará una acción onClick

object (OpenLink)

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

object (Action)

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

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

object (Card)

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

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

object (OverflowMenu)

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

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}

string

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

Para ver ejemplos de uso, consulta Lee los datos del formulario.

object (ActionParameter)

Lista de parámetros de acción.

enum (LoadIndicator)

Especifica el indicador de carga que muestra la acción mientras se hace 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 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. Para mensajes de tarjetas en las apps de Chat, también debes establecer ResponseType a UPDATE_MESSAGE y usan el mismo cardId de la tarjeta que contenía la acción.

Si 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 a SPINNER

enum (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 action (como abrir un vínculo o ejecutar una función) de la forma habitual.

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 para los complementos de Google Workspace.

string

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

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

boolean

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

{
  "key": string,
  "value": string
}

string

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

string

El valor del parámetro.

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

La URL que se abrirá.

enum (OpenAs)

Cómo abrir un vínculo

Disponible para complementos de Google Workspace y no disponible para 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.

{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}

object (OverflowMenuItem)

Obligatorio. Lista de opciones del menú.

{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}

object (Icon)

Es el ícono que se muestra delante del texto.

string

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

object (OnClick)

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

boolean

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

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

string

Opcional. Una descripción del ícono que se usa para accesibilidad. Si no se especifica, 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 está configurado en una 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, el ícono altText se ignora.

enum (ImageType)

El estilo de recorte aplicado a la imagen. En algunos casos, aplicar un CIRCLE recortar 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 bus, especifica BUS.

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

string

Muestra un ícono personalizado alojado en una URL HTTPS.

Por ejemplo:

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

Los tipos de archivo admitidos incluyen .png y .jpg

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.

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

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

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 Íconos de fuentes de Google y ajusta la configuración en Personalizar.

integer

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.

integer

El grosor y el grado afectan el grosor de un símbolo. Los ajustes de las calificaciones son más detallados que los de ponderación y tienen un pequeño impacto en el tamaño del símbolo. Elige entre {-25, 0, 200}. Si no está, 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 íconos, ve a Íconos de fuentes de Google y ajusta la configuración en Personalizar.

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

object (Icon)

Dejó de estar disponible y se reemplazó por startIcon.

object (Icon)

Es el ícono que se muestra frente al texto.

string

El texto que aparece arriba text Siempre se trunca.

string

Obligatorio. Es el texto principal.

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

boolean

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

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

string

El texto que aparece debajo text Siempre se une.

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

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

Admite íconos integrados y personalizados.

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}

string

El texto que se muestra dentro del botón.

object (Icon)

Un ícono que se muestra dentro del botón. Si ambos icon y text aparecen, el icono aparece antes del texto.

object (Color)

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

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

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

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

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

object (OnClick)

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

boolean

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

string

El texto alternativo que se usa para la accesibilidad.

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

enum (Type)

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

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

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

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 representa como un color sólido (como si al valor alfa se le hubiera dado explícitamente un valor de 1.0).

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

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

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Recibe los datos del formulario.

string

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

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Recibe los datos del formulario.

boolean

Cuándo true, se seleccionó el interruptor.

object (Action)

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

enum (ControlType)

Cómo aparece el interruptor en la interfaz de usuario

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

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

Una matriz de botones.

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}

string

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.

string

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

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

Obligatorio si hintText sin especificar. De lo contrario, es opcional.

string

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

Obligatorio si label sin especificar. De lo contrario, es opcional.

string

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

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Recibe los datos del formulario.

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

object (Action)

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

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

object (Suggestions)

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

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

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

Cuando se especifica, TextInput.type siempre es SINGLE_LINE, incluso si está configurada en MULTIPLE_LINE

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

object (Action)

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

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

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

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

object (Validation)

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

string

Es el texto que aparece en el campo de entrada de texto cuando está vacío. Usa este texto para 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 para los complementos de Google Workspace.

Action

Navigation

Enviar o actualizar las tarjetas que se muestran

Card

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

Card

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

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

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

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

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

{
  "characterLimit": integer,
  "inputType": enum (InputType)
}

integer

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

enum (InputType)

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

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,
  "validation": {
    object (Validation)
  },

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

string

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

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

string

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

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

enum (SelectionType)

El tipo de elementos que se muestran a los usuarios en una SelectionInput widget. 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 especificar un botón aparte que envíe el formulario.

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Recibe los datos del formulario.

integer

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

integer

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.

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

object (Action)

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

object (PlatformDataSource)

Una fuente de datos de Google Workspace

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

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

string

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

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Recibe los datos del formulario.

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

string

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

string

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

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

Una fuente de datos exclusiva de una aplicación 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.

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

Una fuente de datos de Google Chat.

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

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

{
  "defaultToCurrentSpace": boolean
}

boolean

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

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}

string

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

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Recibe los datos del formulario.

string

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

enum (DateTimePickerType)

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

string (int64 format)

El valor predeterminado que se muestra en el widget, en milisegundos, desde Tiempo Unix.

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

• DATE_AND_TIME : una fecha y hora de calendario en UTC. Por ejemplo, para representar el 1 de enero de 2023 a las 12:00 p.m. UTC, usa 1672574400000
• DATE_ONLY : una fecha 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:00 p.m., usa 43200000 (o 12 * 60 * 60 * 1000).

integer

Número que representa el desplazamiento de la zona horaria desde UTC, en minutos. Si se establece, valueMsEpoch se muestra en la zona horaria especificada. Si no la estableces, el valor predeterminado será la configuración de zona horaria del usuario.

object (Action)

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

object (Validation)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (GridItem)

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

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

object (OnClick)

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

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

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

object (ImageComponent)

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

string

Título del elemento de cuadrícula.

string

El subtítulo del elemento de cuadrícula.

enum (GridItemLayout)

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

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

Es la URL de la imagen.

string

Es la etiqueta de accesibilidad de la imagen.

object (ImageCropStyle)

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

object (BorderStyle)

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

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

El tipo de recorte.

number

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

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

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

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

Es el tipo de borde.

object (Color)

Los colores que se usarán cuando el tipo sea BORDER_TYPE_STROKE

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

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

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

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

integer

El radio de la esquina del borde.

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

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

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

Especifica cómo una columna rellena 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)

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

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

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

{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}

enum (Layout)

Diseño de lista de chips especificado.

object (Chip)

Un array de chips.

{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}

object (Icon)

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

string

Es el texto que se muestra dentro del chip.

object (OnClick)

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

boolean

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

boolean

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

string

El texto alternativo que se usa para la accesibilidad.

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

{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}

enum (HorizontalAlignment)

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

object (Button)

Opcional. Define un botón personalizable para expandir 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.

object (Button)

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.

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (OnClick)

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

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

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

object (Button)

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