HTML Service

HTML

Esse serviço permite que aplicativos do Apps Script retornem HTML, geralmente como uma interface do usuário. Se você não tem experiência com essa classe, recomendamos que também veja o guia para o serviço HTML

.

Classes

NomeBreve descrição
HtmlOutputUm objeto HtmlOutput que pode ser exibido a partir de um script.
HtmlOutputMetaTagUm objeto que representa uma metatag adicionada à página chamando HtmlOutput.addMetaTag(name, content).
HtmlServiceServiço para retornar HTML e outro conteúdo de texto de um script.
HtmlTemplateUm objeto de modelo para a construção de HTML dinamicamente.
SandboxModeUma enumeração que representa os modos do sandbox que podem ser usados para scripts HtmlService do cliente.
XFrameOptionsModeUma enumeração que representa os modos X-Frame-Options 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 novo conteúdo ao conteúdo desta HtmlOutput.
appendUntrusted(addedContent)HtmlOutputAdiciona novo conteúdo ao conteúdo desta HtmlOutput, usando código de escape.
asTemplate()HtmlTemplateRetorna uma HtmlTemplate apoiada por este 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()BlobRetorne os dados dentro desse objeto como um blob.
getContent()StringRecebe o conteúdo desse HtmlOutput.
getFaviconUrl()StringAcessa o URL de uma tag de link favicon adicionada à página chamando setFaviconUrl(iconUrl).
getHeight()IntegerRecebe a altura inicial da caixa de diálogo personalizada no Documentos, Planilhas ou Formulários Google.
getMetaTags()HtmlOutputMetaTag[]Recebe uma matriz de objetos que representam metatags adicionadas à página chamando addMetaTag(name, content).
getTitle()StringAcessa o título da página de saída.
getWidth()IntegerRecebe a largura inicial da caixa de diálogo personalizada no Documentos, Planilhas ou Formulários Google.
setContent(content)HtmlOutputDefine o conteúdo desta 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 no Documentos, Planilhas ou Formulários Google.
setSandboxMode(mode)HtmlOutputEsse método agora não tem efeito. Antes, ele define 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 no app 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 contra cliques.

HtmlOutputMetaTag

Métodos

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

HtmlService

Propriedades

PropriedadeTipoDescrição
SandboxModeSandboxModeUma enumeração que representa os modos do sandbox que podem ser usados para scripts HtmlService do cliente.
XFrameOptionsModeXFrameOptionsModeUma enumeração 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 pelo script.
createHtmlOutput(blob)HtmlOutputCria um novo objeto HtmlOutput com base em um recurso BlobSource.
createHtmlOutput(html)HtmlOutputCria um novo objeto HtmlOutput que pode ser retornado pelo script.
createHtmlOutputFromFile(filename)HtmlOutputCria um novo objeto HtmlOutput com base em um arquivo no editor de código.
createTemplate(blob)HtmlTemplateCria um novo objeto HtmlTemplate com base em um recurso BlobSource.
createTemplate(html)HtmlTemplateCria um novo objeto HtmlTemplate que pode ser retornado pelo script.
createTemplateFromFile(filename)HtmlTemplateCria um novo objeto HtmlTemplate com base em 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 este modelo e retorna um objeto HtmlOutput.
getCode()StringGera uma string de código JavaScript, com base no arquivo do modelo, que pode ser avaliada.
getCodeWithComments()StringGera uma string de código JavaScript que pode ser avaliada, e cada linha do código conte a linha original do modelo como um comentário.
getRawContent()StringRetorna o conteúdo não processado deste modelo.

SandboxMode

Propriedades

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

XFrameOptionsMode

Propriedades

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