Class OpenLink
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
링크 열기
일부 옵션이 있는 링크를 여는 작업을 나타냅니다.
Google Workspace 부가기능 및 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();
참고: 링크를 닫은 후 부가기능을 새로고침하려면 Cross-Origin-Opener-Policy (COOP) 헤더가 사용 설정된 링크를 사용하지 마세요. 링크에서 COOP가 사용 설정된 경우 부가기능에서 창 상태를 감지할 수 없으며 부가기능 카드가 업데이트되지 않습니다.
자세한 문서
setOnClose(onClose)
URL 창 또는 탭이 닫힐 때 URL 작업의 동작을 설정합니다.
매개변수
리턴
OpenLink: 연결을 위한 객체입니다.
setOpenAs(openAs)
URL이 열릴 때의 동작을 설정합니다.
매개변수
리턴
OpenLink: 연결을 위한 객체입니다.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2025-07-26(UTC)
[null,null,["최종 업데이트: 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."]]
