HTML Service

  • The HTML service in Apps Script allows applications to return HTML, typically for user interfaces.

  • Key classes for working with HTML in Apps Script include HtmlOutput, HtmlService, and HtmlTemplate.

  • HtmlOutput objects represent HTML content that can be served from a script and offer methods for managing content, meta tags, and display properties.

  • HtmlService is the main service for creating and managing HtmlOutput and HtmlTemplate objects.

  • HtmlTemplate allows for dynamically constructing HTML content before evaluating it to an HtmlOutput object.
HTML

This service allows Apps Script applications to return HTML, usually as a user interface. If you're new to using this class, we recommend you also see the guide to Html Service

.

Classes

NameBrief description
HtmlOutput An HtmlOutput object that can be served from a script.
HtmlOutputMetaTag An object that represents a meta tag added to the page by calling HtmlOutput.addMetaTag(name, content) .
HtmlService Service for returning HTML and other text content from a script.
HtmlTemplate A template object for dynamically constructing HTML.
SandboxMode An enum representing the sandbox modes that can be used for client-side HtmlService scripts.
XFrameOptionsMode An enum representing the X-Frame-Options modes that can be used for client-side HtmlService scripts.

HtmlOutput

Methods

MethodReturn typeBrief description
addMetaTag(name, content) HtmlOutput Adds a meta tag to the page.
append(addedContent) HtmlOutput Appends new content to the content of this HtmlOutput.
appendUntrusted(addedContent) HtmlOutput Appends new content to the content of this HtmlOutput, using contextual escaping.
asTemplate() HtmlTemplate Returns an HtmlTemplate backed by this HtmlOutput.
clear() HtmlOutput Clears the current content.
getAs(contentType) Blob Return the data inside this object as a blob converted to the specified content type.
getBlob() Blob Return the data inside this object as a blob.
getContent() StringGets the content of this HtmlOutput.
getFaviconUrl() StringGets the URL for a favicon link tag added to the page by calling setFaviconUrl(iconUrl) .
getHeight() IntegerGets the initial height of the custom dialog in Google Docs, Sheets, or Forms.
getMetaTags() HtmlOutputMetaTag[] Gets an array of objects that represent meta tags added to the page by calling addMetaTag(name, content) .
getTitle() StringGets the title of the output page.
getWidth() IntegerGets the initial width of the custom dialog in Google Docs, Sheets, or Forms.
setContent(content) HtmlOutput Sets the content of this HtmlOutput.
setFaviconUrl(iconUrl) HtmlOutput Adds a link tag for a favicon to the page.
setHeight(height) HtmlOutput Sets the initial height of the custom dialog in Google Docs, Sheets, or Forms.
setSandboxMode(mode) HtmlOutput This method now has no effect — previously it set the sandbox mode used for client-side scripts.
setTitle(title) HtmlOutput Sets the title of the output page.
setWidth(width) HtmlOutput Sets the initial width of a custom dialog in Google Docs, Sheets, or Forms.
setXFrameOptionsMode(mode) HtmlOutput Sets the state of the page's X-Frame-Options header, which controls clickjacking prevention.

HtmlOutputMetaTag

Methods

MethodReturn typeBrief description
getContent() StringGets the content of this meta tag.
getName() StringGets the name of this HtmlOutputMetaTag.

HtmlService

Properties

PropertyTypeDescription
SandboxModeSandboxMode An enum representing the sandbox modes that can be used for client-side HtmlService scripts.
XFrameOptionsModeXFrameOptionsMode An enum representing the X-Frame-Options modes that can be used for client-side HtmlService scripts.

Methods

MethodReturn typeBrief description
createHtmlOutput() HtmlOutput Creates a new HtmlOutput object that can be returned from the script.
createHtmlOutput(blob) HtmlOutput Creates a new HtmlOutput object from a BlobSource resource.
createHtmlOutput(html) HtmlOutput Creates a new HtmlOutput object that can be returned from the script.
createHtmlOutputFromFile(filename) HtmlOutput Creates a new HtmlOutput object from a file in the code editor.
createTemplate(blob) HtmlTemplate Creates a new HtmlTemplate object from a BlobSource resource.
createTemplate(html) HtmlTemplate Creates a new HtmlTemplate object that can be returned from the script.
createTemplateFromFile(filename) HtmlTemplate Creates a new HtmlTemplate object from a file in the code editor.
getUserAgent() StringGets the user-agent string for the current browser.

HtmlTemplate

Methods

MethodReturn typeBrief description
evaluate() HtmlOutput Evaluates this template and returns an HtmlOutput object.
getCode() StringGenerates a string of JavaScript code, based on the template file, that can be evaluated.
getCodeWithComments() StringGenerates a string of JavaScript code that can be evaluated, with each line of the code containing the original line from the template as a comment.
getRawContent() StringReturns the unprocessed content of this template.

SandboxMode

Properties

PropertyTypeDescription
EMULATEDEnumA legacy sandbox mode that emulates ECMAScript 5 strict mode using only the features available in ECMAScript 3.
IFRAMEEnumA sandbox mode that uses iframe sandboxing instead of the Caja sandbox technology used by the EMULATED and NATIVE modes.
NATIVEEnumA sandbox mode that is built on top of ECMAScript 5 strict mode.

XFrameOptionsMode

Properties

PropertyTypeDescription
ALLOWALLEnumNo X-Frame-Options header will be set.
DEFAULTEnumSets the default value for the X-Frame-Options header, which preserves normal security assumptions.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年12月11日 UTC.