Class Blob | Apps Script | Google for Developers (original) (raw)

Class Blob

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

Blob

A data interchange object for Apps Script services.

Methods

Method	Return type	Brief description
copyBlob()	Blob	Returns a copy of this blob.
getAs(contentType)	Blob	Return the data inside this object as a blob converted to the specified content type.
getBytes()	Byte[]	Gets the data stored in this blob.
getContentType()	String	Gets the content type of the bytes in this blob.
getDataAsString()	String	Gets the data of this blob as a String with UTF-8 encoding.
getDataAsString(charset)	String	Gets the data of this blob as a string with the specified encoding.
getName()	String	Gets the name of this blob.
isGoogleType()	Boolean	Returns whether this blob is a Google Workspace file (Sheets, Docs, etc.).
setBytes(data)	Blob	Sets the data stored in this blob.
setContentType(contentType)	Blob	Sets the content type of the bytes in this blob.
setContentTypeFromExtension()	Blob	Sets the content type of the bytes in this blob based on the file extension.
setDataFromString(string)	Blob	Sets the data of this blob from a string with UTF-8 encoding.
setDataFromString(string, charset)	Blob	Sets the data of this blob from a string with the specified encoding.
setName(name)	Blob	Sets the name of this blob.

Deprecated methods

Method	Return type	Brief description
~~getAllBlobs()~~	Blob[]	Gets all the blobs that are contained within this (possibly composite) blob.

Detailed documentation

`copyBlob()`

Returns a copy of this blob.

Return

[Blob](#) — The new copy.

`getAs(contentType)`

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

Name	Type	Description
contentType	String	The MIME type to convert to. For most blobs, 'application/pdf' is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also valid. For a Google Docs document, 'text/markdown' is also valid.

Return

[Blob](#) — The data as a blob.

`getBytes()`

Gets the data stored in this blob.

Return

Byte[] — The stored bytes.

`getContentType()`

Gets the content type of the bytes in this blob.

Return

String — The content type of this data, if known, or null.

`getDataAsString()`

Gets the data of this blob as a String with UTF-8 encoding.

Return

String — The data as a string.

`getDataAsString(charset)`

Gets the data of this blob as a string with the specified encoding.

Parameters

Name	Type	Description
charset	String	The charset to use in encoding the data in this blob as a string.

Return

String — The data as a string.

`getName()`

Gets the name of this blob.

Return

String — The name of this data, if known, or null.

`isGoogleType()`

Returns whether this blob is a Google Workspace file (Sheets, Docs, etc.).

Return

Boolean — true if this blob is a Google Workspace file; false if not.

`setBytes(data)`

Sets the data stored in this blob.