Class CardHeader

CardHeader

O cabeçalho de uma Card.

Disponível nos complementos do Google Workspace e nos apps do 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étodoTipo de retornoBreve descrição
setImageAltText(imageAltText)CardHeaderDefine o texto alternativo para a imagem do cabeçalho.
setImageStyle(imageStyle)CardHeaderDefine o corte do ícone no cabeçalho do cartão.
setImageUrl(imageUrl)CardHeaderDefine a imagem a ser usada no cabeçalho, fornecendo seu URL ou string de dados.
setSubtitle(subtitle)CardHeaderDefine o subtítulo do cabeçalho do cartão.
setTitle(title)CardHeaderDefine o título do cabeçalho do cartão.

Documentação detalhada

setImageAltText(imageAltText)

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

Parâmetros

NomeTipoDescrição
imageAltTextStringO texto alternativo da imagem do cabeçalho.

Retornar

CardHeader: este objeto, para encadeamento.


setImageStyle(imageStyle)

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

Parâmetros

NomeTipoDescrição
imageStyleImageStyleA configuração de estilo.

Retornar

CardHeader: este objeto, para encadeamento.


setImageUrl(imageUrl)

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

O URL fornecido pode ser um URL de acesso público ou uma string de imagem codificada em base64. Para obter o último, você pode usar o seguinte código para criar uma string de imagem codificada a partir de um imagem no Google Drive e armazene essa string para uso posterior com setImageUrl(imageUrl). Esse método evita a necessidade de seu complemento acessar um arquivo URL de imagem disponível:

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

NomeTipoDescrição
imageUrlStringO endereço de 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 cartão. Opcional.

Parâmetros

NomeTipoDescrição
subtitleStringO texto de subtítulo do cabeçalho.

Retornar

CardHeader: este objeto, para encadeamento.


setTitle(title)

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

Parâmetros

NomeTipoDescrição
titleStringO texto do cabeçalho.

Retornar

CardHeader: este objeto, para encadeamento.