Class CardHeader
Page Summary
CardHeaderrepresents the header for aCardin Google Workspace add-ons and Google Chat apps.You can set the title, subtitle, image URL, image style, and image alt text for a
CardHeaderusing its methods.The
setImageUrlmethod accepts either a publicly accessible URL or a base64 encoded image string.Methods like
setTitleandsetSubtitleare used to define the text content of the header.
The header of aCard.
Available for Google Workspace add-ons and Google Chat apps.
constcardHeader=CardService.newCardHeader().setTitle('Card header title').setSubtitle('Card header subtitle').setImageStyle(CardService.ImageStyle.CIRCLE).setImageUrl('https://image.png');
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Card | Sets the alternative text for the header image. |
set | Card | Sets the cropping of the icon in the card header. |
set | Card | Sets the image to use in the header by providing its URL or data string. |
set | Card | Sets the subtitle of the card header. |
set | Card | Sets the title of the card header. |
Detailed documentation
setImageAltText(imageAltText)
Sets the alternative text for the header image.
Parameters
| Name | Type | Description |
|---|---|---|
image | String | The alternative text for the header image. |
Return
Card — This object, for chaining.
setImageStyle(imageStyle)
Sets the cropping of the icon in the card header. Defaults to no crop. Optional.
Parameters
| Name | Type | Description |
|---|---|---|
image | Image | The style setting. |
Return
Card — This object, for chaining.
setImageUrl(imageUrl)
Sets the image to use in the header by providing its URL or data string.
The provided URL can either be a publicly accessible URL or a base64 encoded image string.To obtain the latter, you can use the following code to create an encoded image string from animage in your Google Drive, then store that string for later use withset. This method prevents the need for your add-on to access a publiclyavailable image URL:
// The following assumes you have the image to use in Google Drive and have its// ID.constimageBytes=DriveApp.getFileById('123abc').getBlob().getBytes();constencodedImageURL=`data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;// You can store encodeImageURL and use it as a parameter to// CardHeader.setImageUrl(imageUrl).
Parameters
| Name | Type | Description |
|---|---|---|
image | String | The URL address of a hosted image to use, or an encoded image string. |
Return
Card — This object, for chaining.
setSubtitle(subtitle)
Sets the subtitle of the card header. Optional.
Parameters
| Name | Type | Description |
|---|---|---|
subtitle | String | The header subtitle text. |
Return
Card — This object, for chaining.
setTitle(title)
Sets the title of the card header. Required.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | The header text. |
Return
Card — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.