Interface BlobSource

  • TheBlobSource interface is for objects that can export their data as aBlob.

  • Numerous Apps Script classes implement theBlobSource interface, includingBlob,Chart,File, andSpreadsheet.

  • TheBlobSource interface includes methods likegetAs(contentType) to get data as a blob with a specified content type andgetBlob() to get the data as a blob.

  • ThegetAs(contentType) method allows converting data to different MIME types, such asapplication/pdf or various image formats, with filename extension handling.

BlobSource

Interface for objects that can export their data as aBlob.

Implementing classes

NameBrief description
BlobA data interchange object for Apps Script services.
ChartA Chart object, which can be converted to a static image.
DocumentA document, containing one or moreTab objects, each of which contains rich text andelements such as tables and lists.
EmbeddedChartRepresents a chart that has been embedded into a spreadsheet.
FileA file in Google Drive.
GmailAttachmentAn attachment from Gmail.
HTTPResponseThis class allows users to access specific information on HTTP responses.
HtmlOutputAnHtmlOutput object that can be served from a script.
ImageAPageElement representing an image.
InlineImageAn element representing an embedded image.
JdbcBlobA JDBCBlob.
JdbcClobA JDBCClob.
PictureFillA fill that renders an image that's stretched to the dimensions of its container.
PositionedImageFixed position image anchored to aParagraph.
SpreadsheetAccess and modify Google Sheets files.
StaticMapAllows for the creation and decoration of static map images.

Methods

MethodReturn typeBrief description
getAs(contentType)BlobReturn the data inside this object as a blob converted to the specified content type.
getBlob()BlobReturn 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. Thismethod adds the appropriate extension to the filename—for example, "myfile.pdf". However, itassumes that the part of the filename that follows the last period (if any) is an existingextension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes"ShoppingList.12.25.pdf".

To view the daily quotas for conversions, seeQuotas for GoogleServices. Newly created Google Workspace domains might be temporarily subject to stricterquotas.

Parameters

NameTypeDescription
contentTypeStringThe 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 theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.