Class OpenLink
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
AbrirVínculo
Representa una acción para abrir un vínculo con algunas opciones.
Disponible para complementos de Google Workspace y apps de Google Chat.
// 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();
Nota: Para volver a cargar los complementos después de cerrar un vínculo, no uses un vínculo con el encabezado de política de apertura de origen cruzado (COOP) habilitado. Si la COOP está habilitada en un vínculo, los complementos no pueden detectar el estado de la ventana y la tarjeta del complemento no se actualiza.
Documentación detallada
setOnClose(onClose)
Establece el comportamiento de la acción de URL cuando se cierra la ventana o la pestaña de la URL.
Parámetros
Nombre | Tipo | Descripción |
onClose | OnClose | El parámetro de configuración de cierre. |
Volver
OpenLink
: Este objeto, para encadenar.
setOpenAs(openAs)
Establece el comportamiento de la URL cuando se abre.
Parámetros
Nombre | Tipo | Descripción |
openAs | OpenAs | Es el parámetro de configuración de apertura. |
Volver
OpenLink
: Este objeto, para encadenar.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003e\u003ccode\u003eOpenLink\u003c/code\u003e allows Google Workspace Add-ons and Google Chat apps to open specified URLs with customizable behaviors.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can set how the link opens (overlay or full-screen) and the action taken when it's closed (reload add-on or do nothing).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eOpenLink\u003c/code\u003e object provides methods like \u003ccode\u003esetOnClose\u003c/code\u003e, \u003ccode\u003esetOpenAs\u003c/code\u003e, and \u003ccode\u003esetUrl\u003c/code\u003e for configuration.\u003c/p\u003e\n"],["\u003cp\u003eWhen using \u003ccode\u003esetOnClose\u003c/code\u003e to reload add-ons, avoid links with Cross-Origin-Opener-Policy (COOP) enabled for proper functionality.\u003c/p\u003e\n"]]],[],null,["# Class OpenLink\n\nOpenLink\n\nRepresents an action to open a link with some options.\n\nAvailable for Google Workspace add-ons and Google Chat apps.\n\n```javascript\n// A button that opens as a link in an overlay and\n// requires a reload when closed.\nconst button = CardService.newTextButton()\n .setText('This button opens a link in an overlay window')\n .setOpenLink(\n CardService.newOpenLink()\n .setUrl('https://www.google.com')\n .setOpenAs(CardService.OpenAs.OVERLAY)\n .setOnClose(CardService.OnClose.RELOAD_ADD_ON),\n );\n\n// An action response that opens a link in full screen and\n// requires no action when closed.\nconst actionResponse = CardService.newActionResponseBuilder()\n .setOpenLink(\n CardService.newOpenLink()\n .setUrl('https://www.google.com')\n .setOpenAs(CardService.OpenAs.FULL_SIZE)\n .setOnClose(CardService.OnClose.NOTHING),\n )\n .build();\n```\n\n\n**Note:** To reload add-ons after closing a link, don't use a link with\nCross-Origin-Opener-Policy (COOP) header enabled. If COOP is enabled in a link, add-ons can't\ndetect the window state, and the add-on card doesn't update. \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------|---------------|---------------------------------------------------------------------------|\n| [setOnClose(onClose)](#setOnClose(OnClose)) | [OpenLink](#) | Sets the behavior of the URL action when the URL window or tab is closed. |\n| [setOpenAs(openAs)](#setOpenAs(OpenAs)) | [OpenLink](#) | Sets the behavior of URL when it is opened. |\n| [setUrl(url)](#setUrl(String)) | [OpenLink](#) | Sets the URL to be opened. |\n\nDetailed documentation\n----------------------\n\n### `set``On``Close(onClose)`\n\nSets the behavior of the URL action when the URL window or tab is closed.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------|---------------------------------------------------------|----------------------|\n| `on``Close` | [OnClose](/apps-script/reference/card-service/on-close) | The closing setting. |\n\n#### Return\n\n\n[OpenLink](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Open``As(openAs)`\n\nSets the behavior of URL when it is opened.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------|-------------------------------------------------------|----------------------|\n| `open``As` | [OpenAs](/apps-script/reference/card-service/open-as) | The opening setting. |\n\n#### Return\n\n\n[OpenLink](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Url(url)`\n\nSets the URL to be opened. The URL must match a prefix [whitelisted in\nthe manifest](/gmail/add-ons/concepts/manifests#manifest_structure_for_gmail_add-ons).\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|------------------|\n| `url` | `String` | The URL to open. |\n\n#### Return\n\n\n[OpenLink](#) --- This object, for chaining."]]