Class CardHeader

Cabeçalho do cartão

O cabeçalho de um Card.

Disponível para os apps do Google Workspace Add-ons e do Google Chat.

const 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 retorno	Breve descrição
setImageAltText(imageAltText)	CardHeader	Define o texto alternativo para a imagem do cabeçalho.
setImageStyle(imageStyle)	CardHeader	Define o corte do ícone no cabeçalho do card.
setImageUrl(imageUrl)	CardHeader	Define a imagem a ser usada no cabeçalho fornecendo o URL ou a string de dados.
setSubtitle(subtitle)	CardHeader	Define o subtítulo do cabeçalho do card.
setTitle(title)	CardHeader	Define o título do cabeçalho do card.

Documentação detalhada

setImageAltText(imageAltText)

Define o texto alternativo para a imagem do cabeçalho.

Parâmetros

Nome	Tipo	Descrição
imageAltText	String	O texto alternativo da imagem do cabeçalho.

Retornar

CardHeader: este objeto, para encadeamento.

---

setImageStyle(imageStyle)

Define o corte do ícone no cabeçalho do card. O padrão é sem corte. Opcional.

Parâmetros

Nome	Tipo	Descrição
imageStyle	ImageStyle	A configuração de estilo.

Retornar

CardHeader: este objeto, para encadeamento.

---

setImageUrl(imageUrl)

Define a imagem a ser usada no cabeçalho fornecendo o URL ou a string de dados.

O URL fornecido pode ser um URL acessível publicamente ou uma string de imagem codificada em base64. Para conseguir o último, use o código abaixo para criar uma string de imagem codificada de uma imagem no Google Drive e armazene essa string para uso posterior com setImageUrl(imageUrl). Esse método evita que o complemento precise acessar um URL de imagem disponível publicamente:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// CardHeader.setImageUrl(imageUrl).

Parâmetros

Nome	Tipo	Descrição
imageUrl	String	O endereço do URL de uma imagem hospedada a ser usada ou uma string de imagem codificada.

Retornar

CardHeader: este objeto, para encadeamento.

---

setSubtitle(subtitle)

Define o subtítulo do cabeçalho do card. Opcional.

Parâmetros

Nome	Tipo	Descrição
subtitle	String	O texto do subtítulo do cabeçalho.

Retornar

CardHeader: este objeto, para encadeamento.

---

setTitle(title)

Define o título do cabeçalho do card. Obrigatório.

Parâmetros

Nome	Tipo	Descrição
title	String	O texto do cabeçalho.

Retornar

CardHeader: este objeto, para encadeamento.