Interface BlobSource
Stay organized with collections
Save and categorize content based on your preferences.
BlobSource
Interface for objects that can export their data as a Blob.
Implementing classes
| Name | Brief description |
Blob | A data interchange object for Apps Script services. |
Chart | A Chart object, which can be converted to a static image. |
Document | A document, containing one or more Tab objects, each of which contains rich text and
elements such as tables and lists. |
EmbeddedChart | Represents a chart that has been embedded into a spreadsheet. |
File | A file in Google Drive. |
GmailAttachment | An attachment from Gmail. |
HTTPResponse | This class allows users to access specific information on HTTP responses. |
HtmlOutput | An HtmlOutput object that can be served from a script. |
Image | A PageElement representing an image. |
InlineImage | An element representing an embedded image. |
JdbcBlob | A JDBC Blob. |
JdbcClob | A JDBC Clob. |
PictureFill | A fill that renders an image that's stretched to the dimensions of its container. |
PositionedImage | Fixed position image anchored to a Paragraph. |
Spreadsheet | Access and modify Google Sheets files. |
StaticMap | Allows for the creation and decoration of static map images. |
Methods
| Method | Return type | Brief description |
getAs(contentType) | Blob | Return the data inside this object as a blob converted to the specified content type. |
getBlob() | Blob | Return the data inside this object as a blob. |
Detailed documentation
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.
getBlob()
Return the data inside this object as a blob.
Return
Blob — The data as a blob.
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.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eBlobSource\u003c/code\u003e is an interface allowing objects to export their data as a Blob.\u003c/p\u003e\n"],["\u003cp\u003eIt offers two primary methods: \u003ccode\u003egetAs()\u003c/code\u003e to retrieve data as a Blob with a specific content type and \u003ccode\u003egetBlob()\u003c/code\u003e for getting data as a raw Blob.\u003c/p\u003e\n"],["\u003cp\u003eVarious Apps Script objects, including Documents, Spreadsheets, and Images, implement this interface.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetAs()\u003c/code\u003e can convert data to formats like PDF, common image types, and Markdown for Google Docs, but is subject to usage quotas.\u003c/p\u003e\n"]]],[],null,["# Interface BlobSource\n\nBlobSource\n\nInterface for objects that can export their data as a [Blob](/apps-script/reference/base/blob).\n\n### Implementing classes\n\n| Name | Brief description |\n|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Blob](/apps-script/reference/base/blob) | A data interchange object for Apps Script services. |\n| [Chart](../charts/chart.html) | A Chart object, which can be converted to a static image. |\n| [Document](../document/document.html) | A document, containing one or more [Tab](../document/tab.html) objects, each of which contains rich text and elements such as tables and lists. |\n| [EmbeddedChart](../spreadsheet/embedded-chart.html) | Represents a chart that has been embedded into a spreadsheet. |\n| [File](../drive/file.html) | A file in Google Drive. |\n| [GmailAttachment](../gmail/gmail-attachment.html) | An attachment from Gmail. |\n| [HTTPResponse](../url-fetch/http-response.html) | This class allows users to access specific information on HTTP responses. |\n| [HtmlOutput](../html/html-output.html) | An `Html``Output` object that can be served from a script. |\n| [Image](../slides/image.html) | A [PageElement](../slides/page-element.html) representing an image. |\n| [InlineImage](../document/inline-image.html) | An element representing an embedded image. |\n| [JdbcBlob](../jdbc/jdbc-blob.html) | A JDBC `Blob`. |\n| [JdbcClob](../jdbc/jdbc-clob.html) | A JDBC `Clob`. |\n| [PictureFill](../slides/picture-fill.html) | A fill that renders an image that's stretched to the dimensions of its container. |\n| [PositionedImage](../document/positioned-image.html) | Fixed position image anchored to a [Paragraph](../document/paragraph.html). |\n| [Spreadsheet](../spreadsheet/spreadsheet.html) | Access and modify Google Sheets files. |\n| [StaticMap](../maps/static-map.html) | Allows for the creation and decoration of static map images. |\n\n### Methods\n\n| Method | Return type | Brief description |\n|--------------------------------------|------------------------------------------|---------------------------------------------------------------------------------------|\n| [getAs(contentType)](#getAs(String)) | [Blob](/apps-script/reference/base/blob) | Return the data inside this object as a blob converted to the specified content type. |\n| [getBlob()](#getBlob()) | [Blob](/apps-script/reference/base/blob) | Return the data inside this object as a blob. |\n\nDetailed documentation\n----------------------\n\n### `get``As(contentType)`\n\nReturn the data inside this object as a blob converted to the specified content type. This\nmethod adds the appropriate extension to the filename---for example, \"myfile.pdf\". However, it\nassumes that the part of the filename that follows the last period (if any) is an existing\nextension that should be replaced. Consequently, \"ShoppingList.12.25.2014\" becomes\n\"ShoppingList.12.25.pdf\".\n\nTo view the daily quotas for conversions, see [Quotas for Google\nServices](https://developers.google.com/apps-script/guides/services/quotas). Newly created Google Workspace domains might be temporarily subject to stricter\nquotas.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n#### Return\n\n\n[Blob](/apps-script/reference/base/blob) --- The data as a blob.\n\n*** ** * ** ***\n\n### `get``Blob()`\n\nReturn the data inside this object as a blob.\n\n#### Return\n\n\n[Blob](/apps-script/reference/base/blob) --- The data as a blob."]]
