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 =
    AddOnsResponseService.newActionResponseBuilder()
        .setOpenLink(
            AddOnsResponseService.newOpenLink()
                .setUrl('https://www.google.com')
                .setOpenAs(AddOnsResponseService.OpenAs.FULL_SIZE)
                .setOnClose(AddOnsResponseService.OnClose.NOTHING),
            )
        .build();

注: リンクを閉じた後にアドオンを再読み込みするには、Cross-Origin-Opener-Policy（COOP）ヘッダーが有効になっているリンクを使用しないでください。リンクで COOP が有効になっている場合、アドオンはウィンドウの状態を検出できず、アドオンカードは更新されません。

メソッド

メソッド戻り値の型概要
setOnClose(onClose)OpenLinkURL ウィンドウまたはタブが閉じられたときの URL アクションの動作を設定します。
setOpenAs(openAs)OpenLinkURL が開かれたときの動作を設定します。
setUrl(url)OpenLink開く URL を設定します。

詳細なドキュメント

setOnClose(onClose)

URL ウィンドウまたはタブが閉じられたときの URL アクションの動作を設定します。

パラメータ

名前型説明
onCloseOnClose終了設定。

戻る

OpenLink - チェーン用のこのオープンリンク オブジェクト。

setOpenAs(openAs)

URL が開かれたときの動作を設定します。

パラメータ

名前型説明
openAsOpenAsオープニング設定。

戻る

OpenLink - チェーン用のこのオープンリンク オブジェクト。

setUrl(url)

開く URL を設定します。URL は、マニフェストでホワイトリストに登録されているプレフィックスと一致する必要があります。

パラメータ

名前型説明
urlString開くリンク先 URL。

戻る

OpenLink - チェーン用のこのオープンリンク オブジェクト。