Class HtmlOutput

Stay organized with collections Save and categorize content based on your preferences.

Adds a meta tag to the page. Meta tags included directly in an Apps Script HTML file are ignored. Only the following meta tags are allowed:

const output = HtmlService.createHtmlOutput('Hello, world!');
output.addMetaTag('viewport', 'width=device-width, initial-scale=1');

Parameters

Return

HtmlOutput — This output, for chaining.

Appends new content to the content of this HtmlOutput. Use this only for content from a trusted source, because it is not escaped.

// Log "Hello, world!
Hello again, world.
"
const output = HtmlService.createHtmlOutput('Hello, world!');
output.append('
Hello again, world.
');
Logger.log(output.getContent());

Parameters

Return

HtmlOutput — This output, for chaining.

Throws

Error — if the HTML is malformed

See also

• appendUntrusted(addedContent)

Appends new content to the content of this HtmlOutput, using contextual escaping.

This method correctly escapes content based on the current state of the HtmlOutput, so that the result is a safe string with no markup or side affects. Use this instead of using append whenever you are adding content from an untrusted source, such as from a user, to avoid accidentally allowing a cross site scripting (XSS) bug where content or markup that you append causes unexpected code execution.

// Log "Hello, world!<p>Hello again, world.</p>"
const output = HtmlService.createHtmlOutput('Hello, world!');
output.appendUntrusted('
Hello again, world.
');
Logger.log(output.getContent());

Parameters

Return

HtmlOutput — This output, for chaining.

Throws

Error — if the HTML is very malformed

See also

• append(addedContent)

Returns an HtmlTemplate backed by this HtmlOutput. This method can be used to build up a template incrementally. Future changes to HtmlOutput affect the contents of the HtmlTemplate as well.

const output = HtmlService.createHtmlOutput('Hello, world!');
const template = output.asTemplate();

Return

HtmlTemplate — The new HtmlTemplate.

Clears the current content.

const output = HtmlService.createHtmlOutput('Hello, world!');
output.clear();

Return

HtmlOutput — This output, for chaining.

Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes "ShoppingList.12.25.pdf".

To view the daily quotas for conversions, see Quotas for Google Services. Newly created Google Workspace domains might be temporarily subject to stricter quotas.

Parameters

Return

Blob — The data as a blob.

Return the data inside this object as a blob.

Return

Blob — The data as a blob.

Gets the content of this HtmlOutput.

// Log "Hello, world!"
const output = HtmlService.createHtmlOutput('Hello, world!');
Logger.log(output.getContent());

Return

String — The content that is served.

Gets the URL for a favicon link tag added to the page by calling setFaviconUrl(iconUrl). Favicon link tags included directly in an Apps Script HTML file are ignored.

const output = HtmlService.createHtmlOutput('Hello, world!');
output.setFaviconUrl('http://www.example.com/image.png');
Logger.log(output.getFaviconUrl());

Return

String — The URL of the favicon image.

Gets the initial height of the custom dialog in Google Docs, Sheets, or Forms. If the HtmlOutput is published as a web app instead, this method returns null. To resize a dialog that is already open, call google.script.host.setHeight(height) in client-side code.

const output = HtmlService.createHtmlOutput('Hello, world!');
output.setHeight(200);
Logger.log(output.getHeight());

Return

Integer — The height, in pixels.

Gets an array of objects that represent meta tags added to the page by calling addMetaTag(name, content). Meta tags included directly in an Apps Script HTML file are ignored.

const output = HtmlService.createHtmlOutput('Hello, world!');
output.addMetaTag('viewport', 'width=device-width, initial-scale=1');

const tags = output.getMetaTags();
Logger.log(
    '',
    tags[0].getName(),
    tags[0].getContent(),
);

Return

HtmlOutputMetaTag[] — An array of objects that represent meta tags added to the page by calling addMetaTag(name, content).

Gets the title of the output page. Note that the