Google Apps Script

Class 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.createPlainTextOutput("hello world!");
 }
 
There are also methods to serve JSON, RSS, and XML as TextOutputs; see the corresponding methods on ContentService.

Methods

MethodReturn typeBrief description
append(addedContent)TextOutputAppends new content to the content that will be served.
clear()TextOutputClears the current content.
downloadAsFile(filename)TextOutputTells browsers to download rather than display this content.
getContent()StringGets the content that will be served.
getFileName()StringReturns the file name to download this file as, or null if it should be displayed rather than downloaded.
getMimeType()MimeTypeGet the mime type this content will be served with.
setContent(content)TextOutputSets the content that will be served.
setMimeType(mimeType)TextOutputSets the mime type for content that will be served.

Detailed documentation

append(addedContent)

Appends new content to the content that will be served.

Parameters

NameTypeDescription
addedContentStringthe 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

NameTypeDescription
filenameStringthe filename to tell the browser to use

Return

TextOutput — the TextOutput object, useful for chaining


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 — the mime type this will be served with


setContent(content)

Sets the content that will be served.

Parameters

NameTypeDescription
contentStringthe 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

NameTypeDescription
mimeTypeMimeTypethe mime type

Return

TextOutput — this TextOutput itself, useful for chaining

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.