Serviço HTML: criar e exibir HTML

O serviço HTML permite exibir páginas da Web que podem interagir com as funções do Apps Script do lado do servidor. Ele é particularmente útil para criar apps da Web ou adicionar interfaces de usuário personalizadas a Documentos, Planilhas e Formulários Google. Você pode até usá-lo para gerar o corpo de um e-mail.

Criar arquivos HTML

Para adicionar um arquivo HTML ao seu projeto do Apps Script, siga estas etapas:

  1. Abra o editor do Apps Script.
  2. À esquerda, clique em Adicionar um arquivo > HTML.

No arquivo HTML, é possível escrever a maioria dos códigos HTML, CSS e JavaScript do lado do cliente. A página será veiculada como HTML5, embora alguns recursos avançados do HTML5 não estejam disponíveis, conforme explicado em Restrições.

O arquivo também pode incluir scriptlets de modelo processados no servidor antes do envio da página ao usuário (semelhante ao PHP), conforme explicado na seção sobre HTML modelado.

Disponibilizar HTML como um app da Web

Para criar um app da Web com o serviço HTML, seu código precisa incluir uma função doGet() que informe ao script como exibir a página. A função precisa retornar um objeto HtmlOutput, conforme mostrado neste exemplo.

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    Hello, World!
  </body>
</html>

Depois que o framework básico estiver em vigor, basta salvar uma versão do script e, em seguida, implantar o script como um app da Web.

Depois que o script for implantado como um app da Web, você também poderá incorporá-lo a um site do Google.

Servir HTML como interface do usuário dos apps Documentos, Planilhas, Apresentações ou Formulários Google

O serviço HTML poderá exibir uma caixa de diálogo ou uma barra lateral nos Documentos, Planilhas, Apresentações ou Formulários Google se o script estiver vinculado a um contêiner ao arquivo. No Formulários Google, as interfaces do usuário personalizadas ficam visíveis apenas para um editor que abre o formulário para modificá-lo, não para um usuário que abre o formulário para responder.

Ao contrário de um app da Web, um script que cria uma interface de usuário para um documento, uma planilha ou um formulário não precisa de uma função doGet() especificamente, e você não precisa salvar uma versão do seu script ou implantá-la. Em vez disso, a função que abre a interface do usuário precisa transmitir seu arquivo HTML como um objeto HtmlOutput para os métodos showModalDialog()) ou showSidebar() do objeto Ui para o documento, formulário ou planilha ativa.

Estes exemplos incluem alguns recursos extras para conveniência: a função onOpen() cria um menu personalizado que facilita a abertura da interface, e o botão no arquivo HTML invoca um método close() especial da API google.script.host para fechar a interface.

Code.gs

// Use this code for Google Docs, Slides, Forms, or Sheets.
function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Dialog')
      .addItem('Open', 'openDialog')
      .addToUi();
}

function openDialog() {
  var html = HtmlService.createHtmlOutputFromFile('Index');
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showModalDialog(html, 'Dialog title');
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    Hello, World!
    <input type="button" value="Close"
        onclick="google.script.host.close()" />
  </body>
</html>

Na primeira vez que você quiser mostrar essa interface do usuário, será necessário executar a função onOpen() manualmente no editor de script ou recarregar a janela do editor de Documentos, Planilhas ou Formulários, o que fechará o editor de script. Depois disso, o menu personalizado vai aparecer em alguns segundos sempre que você abrir o arquivo. Escolha Dialog > Open para conferir a interface.