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)

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

object (Section)

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

enum (DividerStyle)

El estilo divisor entre secciones.

object (CardAction)

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

Como las tarjetas de la app de Chat no tienen una barra de herramientas, cardActions[] no es compatible con las apps de Chat.

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

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

string

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

Debido a que las apps de Chat no admiten la navegación por tarjetas, ignoran este campo.

object (CardFixedFooter)

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

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

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

enum (DisplayStyle)

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

No es compatible con las apps de Chat.

object (CardHeader)

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

No es compatible con las apps de Chat.

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

string

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

string

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

enum (ImageType)

La forma que se usa para recortar la imagen.

string

Es la URL HTTPS de la imagen en el encabezado de la tarjeta.

string

El texto alternativo de esta imagen que se utiliza para la accesibilidad.

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

string

Texto que aparece en la parte superior de una sección. Admite texto simple con formato HTML. Para obtener más información sobre cómo dar formato al texto, consulta Da formato al texto en apps de Google Chat y Da 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 contraíbles ocultan algunos o todos los widgets, pero los usuarios pueden hacer clic en Mostrar más para expandir la sección y mostrar los widgets ocultos. Los usuarios pueden volver a ocultar los widgets haciendo clic en Mostrar menos.

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

integer

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

Por ejemplo, cuando una sección contiene cinco widgets y la uncollapsibleWidgetsCount se configura 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 cuando collapsible es true.

{
  "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)
  }
  // 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 apps de Google Chat y Da formato al texto en complementos de Google Workspace.

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

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

object (Image)

Muestra una imagen.

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

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

object (DecoratedText)

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:

"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,
        "alpha": 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"
}

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

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

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

object (Divider)

Muestra una línea divisoria 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 mediante los límites superiores de la cantidad de elementos divididos 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.

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

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

object (Columns)

Muestra hasta 2 columnas.

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

Por ejemplo, el siguiente JSON crea 2 columnas, cada una de las cuales contiene 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"
          }
        }
      ]
    }
  ]
}

{
  "text": string
}

string

El texto que se muestra en el widget.

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

string

La URL HTTPS que aloja la imagen.

Por ejemplo:

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

object (OnClick)

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

string

El texto alternativo de esta imagen que se utiliza para la accesibilidad.

{

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

object (Action)

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

object (OpenLink)

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

object (Action)

Un complemento activa esta acción cuando la acción necesita abrir un vínculo. Esto difiere de openLink anterior en que debe comunicarse con el servidor para obtener el vínculo. Por lo tanto, se requiere un trabajo de preparación para que el cliente web lo haga antes de que regrese la respuesta de acción de vínculo abierto. Compatible con los complementos de Google Workspace, pero no con 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.

Compatible con los complementos de Google Workspace, pero no con las apps de Google Chat.

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

string

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

Para ver ejemplos de uso, consulta Cómo crear tarjetas interactivas.

object (ActionParameter)

Lista de parámetros de acción.

enum (LoadIndicator)

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

boolean

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

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

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

enum (Interaction)

Opcional. Es obligatorio cuando se abre un diálogo.

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

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

Cuando se especifica un interaction, la app puede responder de maneras interactivas especiales. Por ejemplo, si configuras interaction en OPEN_DIALOG, la app podrá abrir un diálogo. Si se especifica, no se muestra un indicador de carga.

Compatible con las apps de Chat, pero no con los complementos de Google Workspace. Si se especifica para un complemento, se quita toda la tarjeta y no se muestra nada en el cliente.

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

string

El nombre del parámetro para 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 No es compatible con las apps de Chat.

enum (OnClose)

Si el cliente se olvida de un vínculo después de abrirlo o si lo observa hasta que se cierra la ventana. No es compatible con las apps de Chat.

{
  "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)

Se dio de baja y se reemplazó por startIcon.

object (Icon)

El ícono que se muestra delante del texto.

string

Es el texto que aparece sobre text. Siempre 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 apps de Google Chat y Da formato al texto en complementos de Google Workspace.

boolean

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

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

string

El texto que aparece debajo de text Ajustar siempre.

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

Un ícono que aparece después del texto.

Admite íconos integrados y personalizados.

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

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

string

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

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

enum (ImageType)

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

string

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

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

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

string

Muestra un ícono personalizado alojado en una URL HTTPS.

Por ejemplo:

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

Entre los tipos de archivo admitidos, se incluyen .png y .jpg.

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

string

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

object (Icon)

Imagen del ícono Si se configuran icon y text, el ícono aparece antes del texto.

object (Color)

Si se configura, el botón se rellena con un color de fondo sólido y el color de la fuente cambia para mantener el contraste con el color de fondo. Por ejemplo, si estableces un fondo azul, es probable que el resultado sea un texto blanco.

Si no la estableces, el fondo de la imagen será blanco y el color de la fuente será azul.

Para el rojo, el verde y el azul, el valor de cada campo es un número float que se puede expresar de dos maneras: como un número entre 0 y 255 dividido por 255 (153/255), o como un valor entre 0 y 1 (0.6). 0 representa la ausencia de un color y 1 o 255/255 representan la presencia total de ese color en la escala RGB.

De manera opcional, configura alpha, que establece un nivel de transparencia con esta ecuación:

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

Para alpha, un valor de 1 corresponde a un color sólido, y un valor de 0 corresponde a un color completamente transparente.

Por ejemplo, el siguiente color representa un rojo transparente medio:

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

object (OnClick)

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

boolean

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

string

Texto alternativo que se utiliza para la accesibilidad.

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

{
  "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 asignado explícitamente un valor de 1.0).

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

string

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

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

string

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

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

boolean

Cuando es true, se selecciona el interruptor.

object (Action)

La acción que se realiza cuando cambia el estado del interruptor, por ejemplo, qué función se debe ejecutar.

enum (ControlType)

Cómo aparece el interruptor en la interfaz de usuario

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

object (Button)

Array de botones.

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

string

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 Recibe datos de formularios.

string

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

Especifica texto que ayude al usuario a ingresar la información que necesita tu app. Por ejemplo, si le preguntas el nombre de una persona, pero necesitas específicamente su apellido, escribe surname en lugar de name.

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

string

Texto que aparece debajo del campo de entrada de texto para ayudar a los usuarios al solicitarles que ingresen un valor determinado Este texto siempre es visible.

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

string

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

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

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, un usuario que agrega elementos al campo o borra texto.

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

object (Suggestions)

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

Por ejemplo, un campo de entrada de texto para 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 los usuarios a ingresar valores que la app pueda comprender. Cuando se hace referencia a JavaScript, algunos usuarios pueden ingresar javascript y otros java script. Sugerir JavaScript puede estandarizar la forma en que los usuarios interactúan con tu app.

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

object (Action)

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

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

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

Compatible con los complementos de Google Workspace, pero no con las apps de Google Chat.

string

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

Compatible con las apps de Google Chat, pero no con los complementos de Google Workspace.

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

object (SuggestionItem)

Una lista de sugerencias que se usan para autocompletar recomendaciones 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

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

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

  // 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

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 Recibe datos de formularios.

string

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

Especifica 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”.

enum (SelectionType)

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

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 otro botón que envíe el formulario.

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

integer

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

integer

En los menús de selección múltiple, la cantidad de caracteres de texto que un usuario ingresa antes de las consultas de la app de Chat se completa automáticamente y muestra los elementos sugeridos en la tarjeta.

Si no se especifica, se establece en 0 caracteres para las fuentes de datos estáticas y 3 caracteres para las fuentes de datos externas.

object (Action)

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

object (PlatformDataSource)

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

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

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

boolean

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

string

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

string

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

{

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

Para un widget SelectionInput que usa un menú de selección múltiple, es una fuente de datos compartida por todas las aplicaciones host de Google Workspace, como los usuarios de una organización de Google Workspace.

object (HostAppDataSourceMarkup)

Una fuente de datos que es exclusiva de una aplicación host de Google Workspace, como los correos electrónicos de Gmail, los eventos del Calendario de Google o los mensajes de Google Chat

{

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

La fuente de datos es 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)

Una fuente de datos que representa un espacio de Google Chat

Formato: espacios/{space}

{
  "defaultToCurrentSpace": boolean
}

boolean

Cuando true, usa el espacio de Google Chat de la tarjeta como selección predeterminada. El valor predeterminado es false.

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

string

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

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

string

Es el texto que solicita a los usuarios que ingresen una fecha, hora, 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 ingresar una fecha, una hora o una fecha y hora

string (int64 format)

Es el valor predeterminado que se muestra en el widget en milisegundos desde el época Unix.

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

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

integer

El número que representa el desplazamiento de la zona horaria respecto de UTC, en minutos. Si se configura, valueMsEpoch se muestra en la zona horaria especificada. Si no se establece, el valor se establecerá de forma predeterminada en la configuración de zona horaria del usuario.

object (Action)

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

{
  "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)

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

object (BorderStyle)

Estilo de borde que se aplicará a cada elemento de la cuadrícula.

integer

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

object (OnClick)

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

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

string

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

object (ImageComponent)

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

string

Título del elemento de la cuadrícula.

string

Subtítulo del elemento de la cuadrícula.

enum (GridItemLayout)

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

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

integer

Radio de la esquina del borde.

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

object (Column)

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 cubre 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)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph.

object (Image)

Image.

object (DecoratedText)

DecoratedText.

object (ButtonList)

ButtonList.

object (TextInput)

TextInput.

object (SelectionInput)

SelectionInput.

object (DateTimePicker)

DateTimePicker.

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

string

Es 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 se configura secondaryButton, también debes configurar primaryButton.