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.
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
HtmlOutput
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Html | Adds a meta tag to the page. |
append(addedContent) | Html | Appends new content to the content of this Html. |
append | Html | Appends new content to the content of this Html, using contextual escaping. |
as | Html | Returns an Html backed by this Html. |
clear() | Html | Clears the current content. |
get | Blob | Return the data inside this object as a blob converted to the specified content type. |
get | Blob | Return the data inside this object as a blob. |
get | String | Gets the content of this Html. |
get | String | Gets the URL for a favicon link tag added to the page by calling set. |
get | Integer | Gets the initial height of the custom dialog in Google Docs, Sheets, or Forms. |
get | Html | Gets an array of objects that represent meta tags added to the page by calling add. |
get | String | Gets the title of the output page. |
get | Integer | Gets the initial width of the custom dialog in Google Docs, Sheets, or Forms. |
set | Html | Sets the content of this Html. |
set | Html | Adds a link tag for a favicon to the page. |
set | Html | Sets the initial height of the custom dialog in Google Docs, Sheets, or Forms. |
set | Html | This method now has no effect — previously it set the sandbox
mode used for client-side scripts. |
set | Html | Sets the title of the output page. |
set | Html | Sets the initial width of a custom dialog in Google Docs, Sheets, or Forms. |
set | Html | Sets the state of the page's X-Frame-Options header, which controls clickjacking
prevention. |
Methods
| Method | Return type | Brief description |
|---|---|---|
get | String | Gets the content of this meta tag. |
get | String | Gets the name of this Html. |
HtmlService
HtmlTemplate
Methods
| Method | Return type | Brief description |
|---|---|---|
evaluate() | Html | Evaluates this template and returns an Html object. |
get | String | Generates a string of JavaScript code, based on the template file, that can be evaluated. |
get | String | Generates 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. |
get | String | Returns the unprocessed content of this template. |
SandboxMode
Properties
| Property | Type | Description |
|---|---|---|
EMULATED | Enum | A legacy sandbox mode that emulates ECMAScript 5 strict mode using only the features available in ECMAScript 3. |
IFRAME | Enum | A sandbox mode that uses iframe sandboxing instead of the Caja sandbox technology used by the
EMULATED and NATIVE modes. |
NATIVE | Enum | A sandbox mode that is built on top of ECMAScript 5 strict mode. |
XFrameOptionsMode
Properties
| Property | Type | Description |
|---|---|---|
ALLOWALL | Enum | No X-Frame-Options header will be set. |
DEFAULT | Enum | Sets the default value for the X-Frame-Options header, which preserves normal security
assumptions. |