HTML Service

HTML

Esse serviço permite que os aplicativos do Apps Script retornem HTML, geralmente como uma interface do usuário. Se você não conhece essa classe, recomendamos que consulte também o guia do serviço HTML

.

Classes

NomeBreve descrição
HtmlOutputUm HtmlOutput objeto que pode ser veiculado de um script.
HtmlOutputMetaTagUm objeto que representa uma metatag adicionada à página chamando HtmlOutput.addMetaTag(name, content).
HtmlServiceServiço para retornar HTML e outros conteúdos de texto de um script.
HtmlTemplateUm objeto de modelo para criar HTML dinamicamente.
SandboxModeUma enumeração que representa os modos sandbox que podem ser usados para scripts HtmlService do lado do cliente.
XFrameOptionsModeUma enumeração que representa os X-Frame-Options modos que podem ser usados para scripts HtmlService do lado do cliente.

HtmlOutput

Métodos

MétodoTipo de retornoBreve descrição
addMetaTag(name, content)HtmlOutputAdiciona uma metatag à página.
append(addedContent)HtmlOutputAnexa um novo conteúdo ao conteúdo desse HtmlOutput.
appendUntrusted(addedContent)HtmlOutputAnexa um novo conteúdo ao conteúdo desse HtmlOutput, usando escape contextual.
asTemplate()HtmlTemplateRetorna um HtmlTemplate com suporte desse HtmlOutput.
clear()HtmlOutputLimpa o conteúdo atual.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorna os dados dentro desse objeto como um blob.
getContent()StringRecebe o conteúdo desse HtmlOutput.
getFaviconUrl()StringRecebe o URL de uma tag de link de favicon adicionada à página chamando setFaviconUrl(iconUrl).
getHeight()IntegerRecebe a altura inicial da caixa de diálogo personalizada nos Documentos, Planilhas ou Formulários Google.
getMetaTags()HtmlOutputMetaTag[]Recebe uma matriz de objetos que representam metatags adicionadas à página chamando addMetaTag(name, content).
getTitle()StringRecebe o título da página de saída.
getWidth()IntegerRecebe a largura inicial da caixa de diálogo personalizada nos Google Documentos, Planilhas ou Formulários.
setContent(content)HtmlOutputDefine o conteúdo desse HtmlOutput.
setFaviconUrl(iconUrl)HtmlOutputAdiciona uma tag de link para um favicon à página.
setHeight(height)HtmlOutputDefine a altura inicial da caixa de diálogo personalizada nos Documentos, Planilhas ou Formulários Google.
setSandboxMode(mode)HtmlOutputEsse método não tem efeito. Antes, ele definia o sandbox mode usado para scripts do lado do cliente.
setTitle(title)HtmlOutputDefine o título da página de saída.
setWidth(width)HtmlOutputDefine a largura inicial de uma caixa de diálogo personalizada nos Documentos, Planilhas ou Formulários Google.
setXFrameOptionsMode(mode)HtmlOutputDefine o estado do cabeçalho X-Frame-Options da página, que controla a prevenção de clickjacking.

HtmlOutputMetaTag

Métodos

MétodoTipo de retornoBreve descrição
getContent()StringRecebe o conteúdo dessa metatag.
getName()StringRecebe o nome desse HtmlOutputMetaTag.

HtmlService

Propriedades

PropriedadeTipoDescrição
SandboxModeSandboxModeUma enumeração que representa os modos sandbox que podem ser usados para scripts HtmlService do lado do cliente.
XFrameOptionsModeXFrameOptionsModeUma enumeração que representa os X-Frame-Options modos 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 de um arquivo no editor de código.
createTemplate(blob)HtmlTemplateCria um novo HtmlTemplate objeto 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.

HtmlTemplate

Métodos

MétodoTipo de retornoBreve descrição
evaluate()HtmlOutputAvalia esse modelo e retorna um HtmlOutput objeto.
getCode()StringGera uma string de código JavaScript, com base no arquivo de modelo, que pode ser avaliada.
getCodeWithComments()StringGera uma string de código JavaScript que pode ser avaliada, com cada linha do código contendo a linha original do modelo como um comentário.
getRawContent()StringRetorna o conteúdo não processado desse modelo.

SandboxMode

Propriedades

PropriedadeTipoDescrição
EMULATEDEnumUm modo sandbox legado que emula o modo estrito do ECMAScript 5 usando apenas os recursos disponíveis no ECMAScript 3.
IFRAMEEnumUm modo sandbox que usa o sandbox de iframe em vez da tecnologia sandbox do Caja usada pelos modos EMULATED e NATIVE.
NATIVEEnumUm modo sandbox criado com base no modo estrito do ECMAScript 5.

XFrameOptionsMode

Propriedades

PropriedadeTipoDescrição
ALLOWALLEnumNenhum cabeçalho X-Frame-Options está definido.
DEFAULTEnumDefine o valor padrão para o cabeçalho X-Frame-Options, que preserva as suposições de segurança normais.