Class Blob

AI-generated Key Takeaways

A Blob is a data interchange object used in Apps Script services.
Blobs have methods for copying, converting, and retrieving data in various formats.
You can get and set the byte data, content type, and name of a Blob.
There are methods to handle data as strings with specified encoding and check if the Blob is a Google Workspace file.

Blob

A data interchange object for Apps Script services.

Methods

Method	Return type	Brief description
`copy Blob()`	`Blob`	Returns a copy of this blob.
`get As(contentType)`	`Blob`	Return the data inside this object as a blob converted to the specified content type.
`get Bytes()`	`Byte[]`	Gets the data stored in this blob.
`get Content Type()`	`String`	Gets the content type of the bytes in this blob.
`get Data As String()`	`String`	Gets the data of this blob as a String with UTF-8 encoding.
`get Data As String(charset)`	`String`	Gets the data of this blob as a string with the specified encoding.
`get Name()`	`String`	Gets the name of this blob.
`is Google Type()`	`Boolean`	Returns whether this blob is a Google Workspace file (Sheets, Docs, etc.).
`set Bytes(data)`	`Blob`	Sets the data stored in this blob.
`set Content Type(contentType)`	`Blob`	Sets the content type of the bytes in this blob.
`set Content Type From Extension()`	`Blob`	Sets the content type of the bytes in this blob based on the file extension.
`set Data From String(string)`	`Blob`	Sets the data of this blob from a string with UTF-8 encoding.
`set Data From String(string, charset)`	`Blob`	Sets the data of this blob from a string with the specified encoding.
`set Name(name)`	`Blob`	Sets the name of this blob.

Deprecated methods

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

Detailed documentation

`copy Blob()`

Returns a copy of this blob.

Return

Blob — The new copy.

`get As(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
`content Type`	`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.

`get Bytes()`

Gets the data stored in this blob.

Return

Byte[] — The stored bytes.

`get Content Type()`

Gets the content type of the bytes in this blob.

Return

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

`get Data As String()`

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

Return

String — The data as a string.

`get Data As String(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.

`get Name()`

Gets the name of this blob.

Return

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

`is Google Type()`

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.

`set Bytes(data)`

Sets the data stored in this blob.