Classe google.script.host (API do cliente)

google.script.host é uma API JavaScript assíncrona do lado do cliente que pode interagir com caixas de diálogo ou barras laterais nos Documentos, Planilhas ou Formulários Google que contêm páginas de serviço HTML. Para executar funções do lado do servidor a partir do código do lado do cliente, use google.script.run. Para mais informações, consulte o guia para comunicação com funções de servidor no serviço HTML.

Propriedades

PropriedadeDescrição
originFornece o domínio do host para que os scripts possam definir a origem corretamente.

Métodos

MétodoTipo de retornoBreve descrição
close() void Fecha a caixa de diálogo ou a barra lateral atual.
editor.focus() void Muda o foco do navegador da caixa de diálogo ou da barra lateral para o editor do Documentos, Planilhas ou Formulários Google.
setHeight(height) void Define a altura da caixa de diálogo atual.
setWidth(width) void Define a largura da caixa de diálogo atual.

Documentação detalhada

close()

Fecha a caixa de diálogo ou a barra lateral atual.

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"
  onclick="google.script.host.close()" />

editor.focus()

Muda o foco do navegador da caixa de diálogo ou da barra lateral para o editor do Documentos, Planilhas ou Formulários Google.

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"
  onclick="google.script.host.editor.focus()" />

setHeight(height)

Define a altura da caixa de diálogo atual.

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"
  onclick="resizeDialog(450, 300)" />

Parâmetros

NomeTipoDescrição
heightIntegera nova altura, em pixels

setWidth(width)

Define a largura da caixa de diálogo atual.

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"
  onclick="resizeDialog(450, 300)" />

Parâmetros

NomeTipoDescrição
widthIntegera nova largura, em pixels