Es el encabezado de un Card
.
Está disponible para complementos de Google Workspace y apps de Google Chat.
var cardHeader = CardService.newCardHeader() .setTitle("Card header title") .setSubtitle("Card header subtitle") .setImageStyle(CardService.ImageStyle.CIRCLE) .setImageUrl("https://image.png");
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
setImageAltText(imageAltText) | CardHeader | Establece el texto alternativo de la imagen del encabezado. |
setImageStyle(imageStyle) | CardHeader | Establece el recorte del ícono en el encabezado de la tarjeta. |
setImageUrl(imageUrl) | CardHeader | Establece la imagen que se usará en el encabezado mediante la URL o la cadena de datos. |
setSubtitle(subtitle) | CardHeader | Establece el subtítulo del encabezado de la tarjeta. |
setTitle(title) | CardHeader | Establece el título del encabezado de la tarjeta. |
Documentación detallada
setImageAltText(imageAltText)
Establece el texto alternativo de la imagen del encabezado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
imageAltText | String | El texto alternativo de la imagen del encabezado. |
Devolvedor
CardHeader
: Este objeto se usa para encadenar.
setImageStyle(imageStyle)
Establece el recorte del ícono en el encabezado de la tarjeta. La configuración predeterminada es "sin recorte". Opcional.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
imageStyle | ImageStyle | La configuración de estilo. |
Devolvedor
CardHeader
: Este objeto se usa para encadenar.
setImageUrl(imageUrl)
Establece la imagen que se usará en el encabezado mediante la URL o la cadena de datos.
La URL proporcionada puede ser una URL de acceso público o una cadena de imagen codificada en base64.
Para obtener este último, puedes usar el siguiente código a fin de crear una string de imagen codificada a partir de una imagen en tu unidad de Google Drive y, luego, almacenar esa string para usarla más adelante con setImageUrl(imageUrl)
. Este método evita la necesidad de que tu complemento acceda a una URL de imagen disponible de forma pública:
// The following assumes you have the image to use in Google Drive and have its ID. var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes(); var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes); // You can store encodeImageURL and use it as a parameter to CardHeader.setImageUrl(imageUrl).
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
imageUrl | String | Es la dirección URL de una imagen alojada que se usará, o bien una cadena de imagen codificada. |
Devolvedor
CardHeader
: Este objeto se usa para encadenar.
setSubtitle(subtitle)
Establece el subtítulo del encabezado de la tarjeta. Opcional.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
subtitle | String | Es el texto del subtítulo del encabezado. |
Devolvedor
CardHeader
: Este objeto se usa para encadenar.
setTitle(title)
Establece el título del encabezado de la tarjeta. Obligatorio.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
title | String | Es el texto del encabezado. |
Devolvedor
CardHeader
: Este objeto se usa para encadenar.