Class google.script.host (Client-side API)

  • google.script.host is a client-side JavaScript API for interacting with dialogs or sidebars in Google Docs, Sheets, or Forms containing HTML-service pages.

  • It provides theorigin property to set the host domain and methods likeclose(),editor.focus(),setHeight(), andsetWidth().

  • Theclose() method is used to close the current dialog or sidebar.

  • Theeditor.focus() method switches focus from the dialog or sidebar back to the Google editor.

  • ThesetHeight() andsetWidth() methods are used to adjust the dimensions of a dialog.

google.script.host is an asynchronous client-side JavaScript API that can interact with dialogs or sidebars in Google Docs, Sheets, or Forms that containHTML-service pages. To execute server-side functions from client-side code, usegoogle.script.run. For more information, see theguide to communicating with server functions in HTML service.

Properties

PropertyDescription
originProvides the host domain, so scripts can set their origin correctly.

Methods

MethodReturn typeBrief description
close()voidCloses the current dialog or sidebar.
editor.focus()voidSwitches browser focus from the dialog or sidebar to the Google Docs, Sheets, or Forms editor.
setHeight(height)voidSets the height of the current dialog.
setWidth(width)voidSets the width of the current dialog.

Detailed documentation

close()

Closes the current dialog or sidebar.

Code.gs

function onOpen(e) {  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();}function showSidebar() {  var html = HtmlService.createHtmlOutputFromFile('Index');  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .showSidebar(html);}

Index.html

<input type="button" value="Close"  />

editor.focus()

Switches browser focus from the dialog or sidebar to the Google Docs, Sheets, or Forms editor.

Code.gs

function onOpen(e) {  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();}function showSidebar() {  var html = HtmlService.createHtmlOutputFromFile('Index');  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .showSidebar(html);}

Index.html

<input type="button" value="Switch focus"  />

setHeight(height)

Sets the height of the current dialog.

Code.gs

function onOpen(e) {  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .createMenu('Dialog').addItem('Show', 'showDialog').addToUi();}function showDialog() {  var html = HtmlService.createHtmlOutputFromFile('Index')      .setWidth(300)      .setHeight(200);  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .showModalDialog(html, 'Dialog title');}

Index.html

<script>  function resizeDialog(width, height) {    google.script.host.setWidth(width);    google.script.host.setHeight(height);  }</script><input type="button" value="Resize dialog"  />

Parameters

NameTypeDescription
heightIntegerthe new height, in pixels

setWidth(width)

Sets the width of the current dialog.

Code.gs

function onOpen(e) {  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .createMenu('Dialog').addItem('Show', 'showDialog').addToUi();}function showDialog() {  var html = HtmlService.createHtmlOutputFromFile('Index')      .setWidth(300)      .setHeight(200);  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.      .showModalDialog(html, 'Dialog title');}

Index.html

<script>  function resizeDialog(width, height) {    google.script.host.setWidth(width);    google.script.host.setHeight(height);  }</script><input type="button" value="Resize dialog"  />

Parameters

NameTypeDescription
widthIntegerthe new width, in pixels

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-10-31 UTC.