此页面由 Cloud Translation API 翻译。

Class Blob

适用于 Apps Script 服务的数据交换对象。

方法

方法	返回类型	简介
`copyBlob()`	`Blob`	返回此 blob 的副本。
`getAs(contentType)`	`Blob`	将此对象内的数据作为转换为指定内容类型的 blob 返回。
`getBytes()`	`Byte[]`	获取存储在此 blob 中的数据。
`getContentType()`	`String`	获取此 blob 中字节的内容类型。
`getDataAsString()`	`String`	以 UTF-8 编码的字符串形式获取此 Blob 的数据。
`getDataAsString(charset)`	`String`	以指定编码的字符串形式获取此 Blob 的数据。
`getName()`	`String`	获取此 blob 的名称。
`isGoogleType()`	`Boolean`	返回此 Blob 是否为 Google Workspace 文件（表格、文档等）。
`setBytes(data)`	`Blob`	设置在此 blob 中存储的数据。
`setContentType(contentType)`	`Blob`	设置此 blob 中字节的内容类型。
`setContentTypeFromExtension()`	`Blob`	根据文件扩展名设置此 blob 中字节的内容类型。
`setDataFromString(string)`	`Blob`	使用 UTF-8 编码的字符串设置此 Blob 的数据。
`setDataFromString(string, charset)`	`Blob`	使用指定编码的字符串设置此 blob 的数据。
`setName(name)`	`Blob`	设置此 blob 的名称。

已弃用的方法

方法	返回类型	简介
`getAllBlobs()`	`Blob[]`	获取此（可能复合）blob 中包含的所有 blob。

详细文档

`copyBlob()`

返回此 blob 的副本。

Blob - 新副本。

`getAs(contentType)`

将此对象内的数据作为转换为指定内容类型的 blob 返回。此方法会向文件名添加相应的扩展名，例如“myfile.pdf”。不过，它假定文件名最后一个英文句点（如果有）后面的部分是应替换的现有扩展名。因此，“ShoppingList.12.25.2014”会变为“ShoppingList.12.25.pdf”。

如需查看转化每日配额，请参阅 Google 服务的配额。新创建的 Google Workspace 网域可能会暂时受到更严格的配额限制。

参数

名称	类型	说明
`contentType`	`String`	要转换到的 MIME 类型。对于大多数 blob，`'application/pdf'` 是唯一有效的选项。对于 BMP、GIF、JPEG 或 PNG 格式的图片，`'image/bmp'`、`'image/gif'`、`'image/jpeg'` 或 `'image/png'` 中的任何一种也有效。对于 Google 文档，`'text/markdown'` 也有效。

Blob - 数据（以 blob 的形式）。

`getBytes()`

获取存储在此 blob 中的数据。

Byte[] - 存储的字节。

`getContentType()`

获取此 blob 中字节的内容类型。

String - 此数据的内容类型（如果已知），或 null。

`getDataAsString()`

以 UTF-8 编码的字符串形式获取此 Blob 的数据。

String - 数据（以字符串形式）。

`getDataAsString(charset)`

以指定编码的字符串形式获取此 Blob 的数据。

参数

名称	类型	说明
`charset`	`String`	用于将此 blob 中的数据编码为字符串的字符集。

String - 数据（以字符串形式）。

`getName()`

获取此 blob 的名称。

String - 此数据的名称（如果已知），或 null。

`isGoogleType()`

返回此 Blob 是否为 Google Workspace 文件（表格、文档等）。

Boolean - 如果此 blob 是 Google Workspace 文件，则为 true；否则为 false。

`setBytes(data)`

设置在此 blob 中存储的数据。

参数

名称	类型	说明
`data`	`Byte[]`	新数据。

Blob - 此 blob，用于链式调用。

`setContentType(contentType)`

设置此 blob 中字节的内容类型。

参数

名称	类型	说明
`contentType`	`String`	新的 contentType。

Blob - 此 blob，用于链式调用。

`setContentTypeFromExtension()`

根据文件扩展名设置此 blob 中字节的内容类型。如果无法通过扩展名猜出 contentType，则将其设为 null。

Blob - 此 blob，用于链式调用。

`setDataFromString(string)`

使用 UTF-8 编码的字符串设置此 Blob 的数据。

参数

名称	类型	说明
`string`	`String`	字符串数据。

Blob - 此 blob，用于链式调用。

`setDataFromString(string, charset)`

使用指定编码的字符串设置此 blob 的数据。

参数

名称	类型	说明
`string`	`String`	字符串数据。
`charset`	`String`	用于将字符串解读为字节的字符集。

Blob - 此 blob，用于链式调用。

`setName(name)`

设置此 blob 的名称。

参数

名称	类型	说明
`name`	`String`	新名称。

Blob - 此 blob，用于链式调用。

已弃用的方法

`getAllBlobs()`

已弃用。此函数已废弃，不应在新脚本中使用。

获取此（可能复合）blob 中包含的所有 blob。

Blob[] - 该 blob 中包含的 blob。