Class TextOutput | Apps Script | Google for Developers (original) (raw)
Class TextOutput
Stay organized with collections Save and categorize content based on your preferences.
TextOutput
A TextOutput object that can be served from a script.
Due to security considerations, scripts cannot directly return text content to a browser. Instead, the browser is redirected to googleusercontent.com, which will display it without any further sanitization or manipulation.
You can return text content like this:
function doGet() { return ContentService.createTextOutput('hello world!'); }
There are also methods to serve JSON, RSS, and XML as TextOutputs; see the corresponding methods on [ContentService](/apps-script/reference/content/content-service).
Methods
| Method | Return type | Brief description |
|---|---|---|
| append(addedContent) | TextOutput | Appends new content to the content that will be served. |
| clear() | TextOutput | Clears the current content. |
| downloadAsFile(filename) | TextOutput | Tells browsers to download rather than display this content. |
| getContent() | String | Gets the content that will be served. |
| getFileName() | String | Returns the file name to download this file as, or null if it should be displayed rather than downloaded. |
| getMimeType() | MimeType | Get the mime type this content will be served with. |
| setContent(content) | TextOutput | Sets the content that will be served. |
| setMimeType(mimeType) | TextOutput | Sets the mime type for content that will be served. |
Detailed documentation
append(addedContent)
Appends new content to the content that will be served.
Parameters
| Name | Type | Description |
|---|---|---|
| addedContent | String | the content to append |
Return
[TextOutput](#) — this TextOutput itself, useful for chaining
clear()
Clears the current content.
Return
[TextOutput](#) — this TextOutput itself, useful for chaining
downloadAsFile(filename)
Tells browsers to download rather than display this content.
Some browsers will ignore this setting. Setting this to null will clear it back to the default behavior of displaying rather than downloading.
Parameters
| Name | Type | Description |
|---|---|---|
| filename | String | the filename to tell the browser to use |
Return
[TextOutput](#) — the TextOutput object, useful for chaining
Throws
Error — if the filename contains illegal characters
getContent()
Gets the content that will be served.
Return
String — the content that will be served
getFileName()
Returns the file name to download this file as, or null if it should be displayed rather than downloaded.
Return
String — the file name
getMimeType()
Get the mime type this content will be served with.
Return
[MimeType](/apps-script/reference/content/mime-type) — the mime type this will be served with
setContent(content)
Sets the content that will be served.
Parameters
| Name | Type | Description |
|---|---|---|
| content | String | the content to serve |
Return
[TextOutput](#) — this TextOutput itself, useful for chaining
setMimeType(mimeType)
Sets the mime type for content that will be served. The default is plain text.
Parameters
| Name | Type | Description |
|---|---|---|
| mimeType | MimeType | the mime type |
Return
[TextOutput](#) — this TextOutput itself, useful for chaining
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 2024-12-02 UTC.