Class Chip

  • A Chip is a UI element with an icon and text label that can be deactivated.

  • Chips are available for Google Chat apps and are in developer preview for Google Workspace add-ons.

  • Various methods are available to configure Chip behavior, such as setting alternative text, disabling the chip, setting an icon or label, and defining click actions.

  • Chip click actions can include opening a link, triggering an authorization flow, composing an email, or executing a custom action.

  • A UI object can only have one type of click action set among setOpenLink, setOnClickAction, setOnClickOpenLinkAction, setAuthorizationAction, or setComposeAction.

Chip

AChip with an icon and text label. You can deactivate the chip when needed.

Available for Google Chat apps. In developer preview for Google Workspace add-ons.

Developer Preview: Available as part of theGoogle Workspace Developer Preview Program, which grants early access to certain features.

constchip=CardService.newChip().setLabel('Open Link').setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'));

Methods

MethodReturn typeBrief description
setAltText(altText)ChipSets the alternative text of the chip for accessibility.
setAuthorizationAction(action)ChipSets an authorization action that opens a URL to the authorization flow when the object isclicked.
setComposeAction(action, composedEmailType)ChipSets an action that composes a draft email when the object is clicked.
setDisabled(disabled)ChipSets whether the chip is disabled.
setIcon(icon)ChipSets the icon to be used as the chip.
setLabel(label)ChipSets the title of the chip.
setOnClickAction(action)ChipSets an action that executes when the object is clicked.
setOnClickOpenLinkAction(action)ChipSets an action that opens a URL in a tab when the object is clicked.
setOpenLink(openLink)ChipSets a URL to be opened when the object is clicked.

Detailed documentation

setAltText(altText)

Sets the alternative text of the chip for accessibility. If unset, defaults to the text thatdisplays on the chip.

Parameters

NameTypeDescription
altTextStringThe alternative text to assign to this chip.

Return

Chip — This object, for chaining.

setAuthorizationAction(action)

Sets an authorization action that opens a URL to the authorization flow when the object isclicked. This opens the URL in a new window. When the user finishes the authorization flow andreturns to the application, the add-on reloads.

A UI object can only have one ofsetOpenLink(openLink),setOnClickAction(action),setOnClickOpenLinkAction(action),setAuthorizationAction(action), orsetComposeAction(action, composedEmailType) set.

// ...constaction=CardService.newAuthorizationAction().setAuthorizationUrl('url');CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parameters

NameTypeDescription
actionAuthorizationActionThe object that specifies the authorization action to take when this element is clicked.

Return

Chip — This object, for chaining.

setComposeAction(action, composedEmailType)

Sets an action that composes a draft email when the object is clicked. A UI object can onlyhave one ofsetOpenLink(openLink),setOnClickAction(action),setOnClickOpenLinkAction(action),setAuthorizationAction(action), orsetComposeAction(action, composedEmailType) set.

TheAction parameter must specify a callback function that returns aComposeActionResponse object configured usingComposeActionResponseBuilder.setGmailDraft(draft).

Note: This method doesn't set acompose action that isused toextend the compose UI.Rather, this method connects this UI element to anAction thatcomposes draft messages in Apps Script that areopened in Gmail when the action completes.

// ...constaction=CardService.newAction().setFunctionName('composeEmailCallback');CardService.newTextButton().setText('Compose Email').setComposeAction(action,CardService.ComposedEmailType.REPLY_AS_DRAFT);// ...functioncomposeEmailCallback(e){constthread=GmailApp.getThreadById(e.threadId);constdraft=thread.createDraftReply('This is a reply');returnCardService.newComposeActionResponseBuilder().setGmailDraft(draft).build();}

Parameters

NameTypeDescription
actionActionThe object that specifies the compose action to take when this element is clicked.
composedEmailTypeComposedEmailTypeAn enum value that specifies whether the composed draft is a standalone or reply draft.

Return

Chip — This object, for chaining.

setDisabled(disabled)

Sets whether the chip is disabled. A disabled chip is greyed out and cannot be clicked.

constchip=CardService.newChip().setLabel('bug Report').setDisabled(true);

Parameters

NameTypeDescription
disabledBooleanThe disabled state.

Return

Chip — This object, for chaining.

setIcon(icon)

Sets the icon to be used as the chip.

constchip=CardService.newChip().setIcon(CardService.newIconImage().setMaterialIcon(CardService.newMaterialIcon().setName('bug_report'),),);

Parameters

NameTypeDescription
iconIconImageOne of the predefinedIconImage values.

Return

Chip — This object, for chaining.

setLabel(label)

Sets the title of the chip. Required.

constchip=CardService.newChip().setLabel('bug Report');

Parameters

NameTypeDescription
labelStringThe text to display.

Return

Chip — This object, for chaining.

setOnClickAction(action)

Sets an action that executes when the object is clicked. A UI object can only have one ofsetOpenLink(openLink),setOnClickAction(action),setOnClickOpenLinkAction(action),setAuthorizationAction(action), orsetComposeAction(action, composedEmailType) set.

TheAction parameter must specify a callback function that returns aActionResponse object.

// ...constaction=CardService.newAction().setFunctionName('notificationCallback');CardService.newTextButton().setText('Create notification').setOnClickAction(action);// ...functionnotificationCallback(){returnCardService.newActionResponseBuilder().setNotification(CardService.newNotification().setText('Some info to display to user'),).build();}

Parameters

NameTypeDescription
actionActionThe action to take when this element is clicked.

Return

Chip — This object, for chaining.

setOnClickOpenLinkAction(action)

Sets an action that opens a URL in a tab when the object is clicked. Use this function when theURL needs to be built or when you need to take other actions in addition to creating theOpenLink object. A UI object can only have one ofsetOpenLink(openLink),setOnClickAction(action),setOnClickOpenLinkAction(action),setAuthorizationAction(action), orsetComposeAction(action, composedEmailType) set.

TheAction parameter must specify a callback function that returns aActionResponse object configured usingActionResponseBuilder.setOpenLink(openLink).

// ...constaction=CardService.newAction().setFunctionName('openLinkCallback');CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action);// ...functionopenLinkCallback(){returnCardService.newActionResponseBuilder().setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com')).build();}

Parameters

NameTypeDescription
actionActionThe object that specifies the open link action to take when this element is clicked.

Return

Chip — This object, for chaining.

setOpenLink(openLink)

Sets a URL to be opened when the object is clicked. Use this function when the URL is alreadyknown and only needs to be opened. A UI object can only have one ofsetOpenLink(openLink),setOnClickAction(action),setOnClickOpenLinkAction(action),setAuthorizationAction(action),orsetComposeAction(action, composedEmailType) set.

Parameters

NameTypeDescription
openLinkOpenLinkAnOpenLink object describing the URL to open.

Return

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