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

Parameters

Return

Widget — The Object, for chaining.

Sets the alternative text of the image for accessibility. Required.

Parameters

Return

Image — This object, for chaining.

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

Return

Image — This object, for chaining.

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

Return

Image — This object, for chaining.

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

Parameters

Return

Widget — This object, for chaining.

Sets the image to use by providing its URL or data string. Required.

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 withsetImageUrl(url). 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// Image.setImageUrl(url).

Parameters

Return

Image — This object, for chaining.

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

Return

Image — This object, for chaining.

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

Return

Image — This object, for chaining.

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

Return

Image — This object, for chaining.

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

Parameters

Return

Widget — The Object, for chaining.