Class HtmlService

HtmlService

Serviço para retornar HTML e outros conteúdos de texto de um script.

Por motivos de segurança, os scripts não podem retornar conteúdo diretamente a um navegador. Em vez disso, eles precisam limpar o HTML para que ele não possa realizar ações maliciosas. Consulte a descrição de HtmlOutput para saber quais são as limitações em relação ao que pode ser retornado.

Propriedades

PropriedadeTipoDescrição
SandboxModeSandboxModeUm tipo enumerado que representa os modos de sandbox que podem ser usados para scripts HtmlService do lado do cliente.
XFrameOptionsModeXFrameOptionsModeUm tipo enumerado que representa os modos X-Frame-Options que podem ser usados para scripts HtmlService do lado do cliente.

Métodos

MétodoTipo de retornoBreve descrição
createHtmlOutput()HtmlOutputCria um novo objeto HtmlOutput que pode ser retornado do script.
createHtmlOutput(blob)HtmlOutputCria um novo objeto HtmlOutput de um recurso BlobSource.
createHtmlOutput(html)HtmlOutputCria um novo objeto HtmlOutput que pode ser retornado do script.
createHtmlOutputFromFile(filename)HtmlOutputCria um novo objeto HtmlOutput a partir de um arquivo no editor de código.
createTemplate(blob)HtmlTemplateCria um novo objeto HtmlTemplate de um recurso BlobSource.
createTemplate(html)HtmlTemplateCria um novo objeto HtmlTemplate que pode ser retornado do script.
createTemplateFromFile(filename)HtmlTemplateCria um novo objeto HtmlTemplate de um arquivo no editor de código.
getUserAgent()StringRecebe a string do user agent do navegador atual.

Documentação detalhada

createHtmlOutput()

Cria um novo objeto HtmlOutput que pode ser retornado do script.

const output = HtmlService.createHtmlOutput();

Retornar

HtmlOutput: o novo objeto HtmlOutput


createHtmlOutput(blob)

Cria um novo objeto HtmlOutput de um recurso BlobSource.

function createFromBlob(blob) {
  const output = HtmlService.createHtmlOutput(blob);
  return output;
}

Parâmetros

NomeTipoDescrição
blobBlobSourceo objeto para extrair o HTML

Retornar

HtmlOutput: o novo objeto HtmlOutput.

Gera

Error: se o blob não tiver HTML ou se o HTML estiver incorreto


createHtmlOutput(html)

Cria um novo objeto HtmlOutput que pode ser retornado do script.

const output = HtmlService.createHtmlOutput('<b>Hello world!</b>');

Parâmetros

NomeTipoDescrição
htmlStringo conteúdo a ser veiculado

Retornar

HtmlOutput: o novo objeto HtmlOutput

Gera

Error: se o HTML estiver incorreto.


createHtmlOutputFromFile(filename)

Cria um novo objeto HtmlOutput a partir de um arquivo no editor de código.

const output = HtmlService.createHtmlOutputFromFile('myPage');

Parâmetros

NomeTipoDescrição
filenameStringo nome do arquivo a ser usado

Retornar

HtmlOutput: o novo objeto HtmlOutput.

Gera

Error: se o arquivo não foi encontrado ou se o HTML nele estiver incorreto.


createTemplate(blob)

Cria um novo objeto HtmlTemplate de um recurso BlobSource.

function createFromBlob(blob) {
  const template = HtmlService.createTemplate(blob);
  const output = template.evaluate();
  return output;
}

Parâmetros

NomeTipoDescrição
blobBlobSourceO objeto de onde o HTML será extraído.

Retornar

HtmlTemplate: o novo objeto HtmlTemplate.

Gera

Error: se o blob não contiver HTML.


createTemplate(html)

Cria um novo objeto HtmlTemplate que pode ser retornado do script.

const template = HtmlService.createTemplate(
    '<b>The time is &lt;?= new Date() ?&gt;</b>',
);

Parâmetros

NomeTipoDescrição
htmlStringo conteúdo do modelo

Retornar

HtmlTemplate: o novo objeto HtmlTemplate.


createTemplateFromFile(filename)

Cria um novo objeto HtmlTemplate a partir de um arquivo no editor de código.

const template = HtmlService.createTemplateFromFile('myTemplate');

Parâmetros

NomeTipoDescrição
filenameStringo nome do arquivo a ser usado

Retornar

HtmlTemplate: o novo objeto HtmlTemplate.

Gera

Error: se o arquivo não foi encontrado.


getUserAgent()

Recebe a string do user agent do navegador atual. Retorna null para a maioria das execuções de script se não for usado na função doGet() ou doPost() de um app da Web.

Retornar

String: a string do user agent