Class KeyValue

  • This class is deprecated and should not be used in new scripts; instead, use DecoratedText.

  • You can set an authorization action that opens a URL to the authorization flow when the object is clicked.

  • You can set an action that composes a draft email when the object is clicked.

  • You can set an action that executes or opens a URL in a tab when the object is clicked.

  • You can set a URL to be opened directly when the object is clicked.

KeyValue

Deprecated. This class is deprecated and should not be used in new scripts.

This class is deprecated. Instead, useDecoratedText.

Methods

MethodReturn typeBrief description
addEventAction(eventAction)WidgetAdds the event action that can be performed on the widget.
setAuthorizationAction(action)KeyValueSets an authorization action that opens a URL to the authorization flow when the object isclicked.
setComposeAction(action, composedEmailType)KeyValueSets an action that composes a draft email when the object is clicked.
setId(id)WidgetSets the unique ID assigned that's used to identify the widget to be mutated.
setOnClickAction(action)KeyValueSets an action that executes when the object is clicked.
setOnClickOpenLinkAction(action)KeyValueSets an action that opens a URL in a tab when the object is clicked.
setOpenLink(openLink)KeyValueSets a URL to be opened when the object is clicked.
setVisibility(visibility)WidgetSets the visibility of the widget.

Deprecated methods

MethodReturn typeBrief description
setBottomLabel(text)KeyValueSets the label text to be used as the key.
setButton(button)KeyValueSets theButton that is displayed to the right of the context.
setContent(text)KeyValueSets the text to be used as the value.
setIcon(icon)KeyValueSets the icon to be used as the key.
setIconAltText(altText)KeyValueSets the alternative text for the icon.
setIconUrl(url)KeyValueSets the URL of the icon to be used as the key.
setMultiline(multiline)KeyValueSets whether the value text should be displayed on a single line or multiple lines.
setSwitch(switchToSet)KeyValueSets theSwitch that is displayed to the right of the content.
setTopLabel(text)KeyValueSets the label text to be used as the key.

Detailed documentation

addEventAction(eventAction)

Adds the event action that can be performed on the widget.

Parameters

NameTypeDescription
eventActionEventActionTheEventAction to be added.

Return

Widget — The 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

KeyValue — 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

KeyValue — This object, for chaining.

setId(id)

Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutationis only supported in Add-Ons.

Parameters

NameTypeDescription
idStringThe id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`.

Return

Widget — 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

KeyValue — 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

KeyValue — 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

KeyValue — This object, for chaining.

setVisibility(visibility)

Sets the visibility of the widget. The default value is `VISIBLE`.

Parameters

NameTypeDescription
visibilityVisibilityTheVisibility of the widget.

Return

Widget — The Object, for chaining.

Deprecated methods

setBottomLabel(text)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the label text to be used as the key. Displayed below the text-content.

Parameters

NameTypeDescription
textStringThe label text. Note: It doesn't supportbasic HTML formatting.

Return

KeyValue — This object, for chaining.

setButton(button)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets theButton that is displayed to the right of the context. AKeyValue canonly support one button, one switch or one icon.

Parameters

NameTypeDescription
buttonButtonThe button to add.

Return

KeyValue — This object, for chaining.

setContent(text)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text to be used as the value. Supportsbasic HTML formatting. Required.

Parameters

NameTypeDescription
textStringThe text content for this widget.

Return

KeyValue — This object, for chaining.

setIcon(icon)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the icon to be used as the key.

Parameters

NameTypeDescription
iconIconOne of the predefinedIcon values.

Return

KeyValue — This object, for chaining.

setIconAltText(altText)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the alternative text for the icon.

Parameters

NameTypeDescription
altTextStringThe alternative text for the icon.

Return

KeyValue — This object, for chaining.

setIconUrl(url)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the URL of the icon to be used as the key.

Parameters

NameTypeDescription
urlStringThe URL address of a hosted image to use as an icon.

Return

KeyValue — This object, for chaining.

setMultiline(multiline)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether the value text should be displayed on a single line or multiple lines.

Parameters

NameTypeDescription
multilineBooleanThe multiline setting.

Return

KeyValue — This object, for chaining.

setSwitch(switchToSet)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets theSwitch that is displayed to the right of the content. AKeyValue canonly support one button, one switch or one icon.

Parameters

NameTypeDescription
switchToSetSwitchThe switch to add.

Return

KeyValue — This object, for chaining.

setTopLabel(text)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the label text to be used as the key. Displayed above the text-content.

Parameters

NameTypeDescription
textStringThe label text. Note: It doesn't supportbasic HTML formatting.

Return

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