Class OpenLink

  • OpenLink represents an action to open a link with options.

  • It is available for Google Workspace add-ons and Google Chat apps.

  • OpenLink can be configured to open links in an overlay or full screen, and to reload the add-on or do nothing when closed.

  • Add-ons cannot detect window state or update if a link has the Cross-Origin-Opener-Policy (COOP) header enabled when trying to reload.

  • Key methods for OpenLink include setOnClose, setOpenAs, and setUrl.
OpenLink

Represents an action to open a link with some options.

Available for Google Workspace add-ons and Google Chat apps. 

// A button that opens as a link in an overlay and
// requires a reload when closed.
const button = CardService.newTextButton()
                   .setText('This button opens a link in an overlay window')
                   .setOpenLink(
                       CardService.newOpenLink()
                           .setUrl('https://www.google.com')
                           .setOpenAs(CardService.OpenAs.OVERLAY)
                           .setOnClose(CardService.OnClose.RELOAD_ADD_ON),
                   );

// An action response that opens a link in full screen and
// requires no action when closed.
const actionResponse = CardService.newActionResponseBuilder()
                           .setOpenLink(
                               CardService.newOpenLink()
                                   .setUrl('https://www.google.com')
                                   .setOpenAs(CardService.OpenAs.FULL_SIZE)
                                   .setOnClose(CardService.OnClose.NOTHING),
                               )
                           .build();

Note: To reload add-ons after closing a link, don't use a link with Cross-Origin-Opener-Policy (COOP) header enabled. If COOP is enabled in a link, add-ons can't detect the window state, and the add-on card doesn't update.

Methods

MethodReturn typeBrief description
setOnClose(onClose)OpenLinkSets the behavior of the URL action when the URL window or tab is closed.
setOpenAs(openAs)OpenLinkSets the behavior of URL when it is opened.
setUrl(url)OpenLinkSets the URL to be opened.

Detailed documentation

setOnClose(onClose)

Sets the behavior of the URL action when the URL window or tab is closed.

Parameters

NameTypeDescription
onCloseOnCloseThe closing setting.

Return

OpenLink — This object, for chaining.

setOpenAs(openAs)

Sets the behavior of URL when it is opened.

Parameters

NameTypeDescription
openAsOpenAsThe opening setting.

Return

OpenLink — This object, for chaining.

setUrl(url)

Sets the URL to be opened. The URL must match a prefix whitelisted in the manifest.

Parameters

NameTypeDescription
urlStringThe URL to open.

Return

OpenLink — This object, for chaining.