此页面由 Cloud Translation API 翻译。

Class Utilities

此服务提供字符串编码/解码、日期格式设置、JSON 操作和其他杂项任务的实用程序。

属性

属性	类型	说明
`Charset`	`Charset`
`DigestAlgorithm`	`DigestAlgorithm`
`MacAlgorithm`	`MacAlgorithm`
`RsaAlgorithm`	`RsaAlgorithm`

方法

方法	返回类型	简介
`base64Decode(encoded)`	`Byte[]`	将 base-64 编码的字符串解码为 UTF-8 字节数组。
`base64Decode(encoded, charset)`	`Byte[]`	将 base-64 编码的字符串解码为特定字符集的字节数组。
`base64DecodeWebSafe(encoded)`	`Byte[]`	将 base-64 网络安全编码的字符串解码为 UTF-8 字节数组。
`base64DecodeWebSafe(encoded, charset)`	`Byte[]`	将 base-64 网络安全编码的字符串解码为特定字符集的字节数组。
`base64Encode(data)`	`String`	根据给定的字节数组生成 base-64 编码的字符串。
`base64Encode(data)`	`String`	根据给定字符串生成 base-64 编码字符串。
`base64Encode(data, charset)`	`String`	根据特定字符集中的指定字符串生成 base-64 编码字符串。
`base64EncodeWebSafe(data)`	`String`	根据给定的字节数组生成 base-64 网络安全编码字符串。
`base64EncodeWebSafe(data)`	`String`	根据给定字符串生成可在 Web 环境中安全使用的 base-64 编码字符串。
`base64EncodeWebSafe(data, charset)`	`String`	根据特定字符集中的指定字符串生成可在 Web 环境中安全使用的 base-64 编码字符串。
`computeDigest(algorithm, value)`	`Byte[]`	对指定的 `Byte[]` 值使用指定的算法计算摘要。
`computeDigest(algorithm, value)`	`Byte[]`	对指定的 `String` 值使用指定的算法计算摘要。
`computeDigest(algorithm, value, charset)`	`Byte[]`	使用指定的算法对指定的 `String` 值（采用给定字符集）计算摘要。
`computeHmacSha256Signature(value, key)`	`Byte[]`	使用给定密钥通过 HMAC-SHA256 对所提供的值进行签名。
`computeHmacSha256Signature(value, key)`	`Byte[]`	使用给定密钥通过 HMAC-SHA256 对所提供的值进行签名。
`computeHmacSha256Signature(value, key, charset)`	`Byte[]`	使用给定密钥和字符集通过 HMAC-SHA256 对所提供的值进行签名。
`computeHmacSignature(algorithm, value, key)`	`Byte[]`	对指定的键和值使用指定的算法计算消息认证代码。
`computeHmacSignature(algorithm, value, key)`	`Byte[]`	对指定的键和值使用指定的算法计算消息认证代码。
`computeHmacSignature(algorithm, value, key, charset)`	`Byte[]`	对指定的键和值使用指定的算法计算消息认证代码。
`computeRsaSha1Signature(value, key)`	`Byte[]`	使用给定密钥通过 RSA-SHA1 对所提供的值进行签名。
`computeRsaSha1Signature(value, key, charset)`	`Byte[]`	使用给定密钥和字符集通过 RSA-SHA1 对所提供的值进行签名。
`computeRsaSha256Signature(value, key)`	`Byte[]`	使用给定密钥通过 RSA-SHA256 对所提供的值进行签名。
`computeRsaSha256Signature(value, key, charset)`	`Byte[]`	使用给定密钥通过 RSA-SHA256 对所提供的值进行签名。
`computeRsaSignature(algorithm, value, key)`	`Byte[]`	使用指定的 RSA 算法和给定密钥对提供的值进行签名。
`computeRsaSignature(algorithm, value, key, charset)`	`Byte[]`	使用指定的 RSA 算法、给定密钥和字符集对所提供的值进行签名。
`formatDate(date, timeZone, format)`	`String`	根据 Java SE SimpleDateFormat 类中所述的规范设置日期格式。
`formatString(template, args)`	`String`	使用“%”格式的格式字符串执行类似 `sprintf` 的字符串格式设置。
`getUuid()`	`String`	以字符串形式获取 UUID（相当于使用 `java.util.UUID.randomUUID()` 方法）。
`gzip(blob)`	`Blob`	`gzip`-压缩所提供的 `Blob` 数据，并将其返回到新的 `Blob` 对象中。
`gzip(blob, name)`	`Blob`	`gzip`-压缩所提供的 `Blob` 数据，并将其返回到新的 `Blob` 对象中。
`newBlob(data)`	`Blob`	通过字节数组创建新的 Blob 对象。
`newBlob(data, contentType)`	`Blob`	使用字节数组和内容类型创建新的 Blob 对象。
`newBlob(data, contentType, name)`	`Blob`	使用字节数组、内容类型和名称创建新的 Blob 对象。
`newBlob(data)`	`Blob`	从字符串创建新的 Blob 对象。
`newBlob(data, contentType)`	`Blob`	使用字符串和内容类型创建新的 Blob 对象。
`newBlob(data, contentType, name)`	`Blob`	使用字符串、内容类型和名称创建新的 Blob 对象。
`parseCsv(csv)`	`String[][]`	返回 CSV 字符串的表格化二维数组表示法。
`parseCsv(csv, delimiter)`	`String[][]`	使用自定义分隔符返回 CSV 字符串的表格化二维数组表示法。
`parseDate(date, timeZone, format)`	`Date`	根据 Java 标准版 `SimpleDateFormat` 类中所述的规范解析所提供的字符串日期。
`sleep(milliseconds)`	`void`	休眠指定毫秒数。
`ungzip(blob)`	`Blob`	解压缩 `Blob` 对象，并返回包含未压缩数据的 `Blob`。
`unzip(blob)`	`Blob[]`	接受表示 ZIP 文件的 Blob，并返回其组件文件。
`zip(blobs)`	`Blob`	创建一个新的 Blob 对象，该对象是一个 zip 文件，其中包含传入的 Blob 中的数据。
`zip(blobs, name)`	`Blob`	创建一个新的 Blob 对象，该对象是一个 zip 文件，其中包含传入的 Blob 中的数据。

已弃用的方法

方法	返回类型	简介
`jsonParse(jsonString)`	`Object`	返回与传入的 JSON 字符串对应的对象。
`jsonStringify(obj)`	`String`	返回传入对象的 JSON 字符串。

详细文档

`base64Decode(encoded)`

将 base-64 编码的字符串解码为 UTF-8 字节数组。

// This is the base64 encoded form of "Google グループ"
const base64data = 'R29vZ2xlIOOCsOODq+ODvOODlw==';

// This logs:
//     [71, 111, 111, 103, 108, 101, 32, -29, -126, -80,
//      -29, -125, -85, -29, -125, -68, -29, -125, -105]
const decoded = Utilities.base64Decode(base64data);
Logger.log(decoded);

// If we want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

参数

名称	类型	说明
`encoded`	`String`	要解码的数据字节数组。

Byte[] - 以字节数组形式由 base-64 编码参数表示的原始数据。

`base64Decode(encoded, charset)`

将 base-64 编码的字符串解码为特定字符集的字节数组。

// This is the base64 encoded form of "Google グループ"
const base64data = 'R29vZ2xlIOOCsOODq+ODvOODlw==';

const decoded = Utilities.base64Decode(base64data, Utilities.Charset.UTF_8);

// This logs:
//     [71, 111, 111, 103, 108, 101, 32, -29, -126, -80,
//      -29, -125, -85, -29, -125, -68, -29, -125, -105]
Logger.log(decoded);

// If we want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

参数

名称	类型	说明
`encoded`	`String`	要解码的数据字符串。
`charset`	`Charset`	用于指定输入字符集的 `Charset`。

Byte[] - 以字节数组形式由 base-64 编码参数表示的原始数据。

`base64DecodeWebSafe(encoded)`

将 base-64 网络安全编码的字符串解码为 UTF-8 字节数组。

// This is the base64 web-safe encoded form of "Google グループ"
const base64data = 'R29vZ2xlIOOCsOODq-ODvOODlw==';

const decoded = Utilities.base64DecodeWebSafe(base64data);

// This logs:
//     [71, 111, 111, 103, 108, 101, 32, -29, -126, -80,
//      -29, -125, -85, -29, -125, -68, -29, -125, -105]
Logger.log(decoded);

// If we want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

参数

名称	类型	说明
`encoded`	`String`	要解码的网络安全数据的字节数组。

Byte[] - 以字节数组的形式由 base-64 网络安全编码参数表示的原始数据。

`base64DecodeWebSafe(encoded, charset)`

将 base-64 网络安全编码的字符串解码为特定字符集的字节数组。

// This is the base64 web-safe encoded form of "Google グループ"
const base64data = 'R29vZ2xlIOOCsOODq-ODvOODlw==';

const decoded = Utilities.base64DecodeWebSafe(
    base64data,
    Utilities.Charset.UTF_8,
);

// This logs:
//     [71, 111, 111, 103, 108, 101, 32, -29, -126, -80,
//      -29, -125, -85, -29, -125, -68, -29, -125, -105]
Logger.log(decoded);

// If we want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

参数

名称	类型	说明
`encoded`	`String`	要解码的网络安全数据字符串。
`charset`	`Charset`	用于指定输入字符集的 `Charset`。

Byte[] - 以字节数组的形式由 base-64 网络安全编码参数表示的原始数据。

`base64Encode(data)`

根据给定的字节数组生成 base-64 编码的字符串。Base 64 是一种常见的编码，许多无法接受二进制数据的工具都接受这种编码。Base 64 通常用于电子邮件、HTTP 等互联网协议或 XML 文档中。

// Instantiates a blob here for clarity
const blob = Utilities.newBlob('A string here');

// Writes 'QSBzdHJpbmcgaGVyZQ==' to the log.
const encoded = Utilities.base64Encode(blob.getBytes());
Logger.log(encoded);

参数

名称	类型	说明
`data`	`Byte[]`	要编码的字节数组数据。

String - 传入数据的 base-64 编码表示法。

`base64Encode(data)`

根据给定字符串生成 base-64 编码字符串。Base 64 是一种常见的编码，许多无法接受二进制数据的工具都接受这种编码。Base 64 通常用于电子邮件、HTTP 等互联网协议或 XML 文档中。

// Writes 'QSBzdHJpbmcgaGVyZQ==' to the log.
const encoded = Utilities.base64Encode('A string here');
Logger.log(encoded);

参数

名称	类型	说明
`data`	`String`	要编码的字符串。

String - 输入字符串的 base-64 编码表示法。

`base64Encode(data, charset)`

使用特定字符集从指定字符串生成 base-64 编码字符串。字符集是一种字符编码方式，可用于编码字符。这些操作通常采用二进制格式，通常与某些数据传输协议不兼容。为了使数据兼容，通常会将其编码为 base 64，这是许多无法接受二进制数据的工具接受的常见编码。Base 64 通常用于电子邮件、HTTP 等互联网协议或 XML 文档中。

// "Google Groups" in Katakana (Japanese)
const input = 'Google グループ';

// Writes "R29vZ2xlIOOCsOODq+ODvOODlw==" to the log
const encoded = Utilities.base64Encode(input, Utilities.Charset.UTF_8);
Logger.log(encoded);

参数

名称	类型	说明
`data`	`String`	要编码的数据字符串。
`charset`	`Charset`	用于指定输入字符集的 `Charset`。

String - 使用给定 Charset 的输入字符串的 base-64 编码表示法。

`base64EncodeWebSafe(data)`

根据给定的字节数组生成 base-64 网络安全编码字符串。Base 64 是一种常见的编码，许多无法接受二进制数据的工具都接受这种编码。网页安全的 Base 64 通常用于电子邮件、HTTP 等互联网协议或 XML 文档中。

// Instantiates a blob here for clarity
const blob = Utilities.newBlob('A string here');

// Writes 'QSBzdHJpbmcgaGVyZQ==' to the log.
const encoded = Utilities.base64EncodeWebSafe(blob.getBytes());
Logger.log(encoded);

参数

名称	类型	说明
`data`	`Byte[]`	要编码的数据字节数组。

String - 传入数据的 base-64 网络安全编码表示法。

`base64EncodeWebSafe(data)`

根据给定字符串生成可在 Web 环境中安全使用的 base-64 编码字符串。Base 64 是一种常见的编码，许多无法接受二进制数据的工具都接受这种编码。网络安全的 Base 64 通常用于电子邮件、HTTP 等互联网协议或 XML 文档中。

// Writes 'QSBzdHJpbmcgaGVyZQ==' to the log.
const encoded = Utilities.base64EncodeWebSafe('A string here');
Logger.log(encoded);

参数

名称	类型	说明
`data`	`String`	要编码的字符串。

String - 输入字符串的 base-64 网络安全编码表示法。

`base64EncodeWebSafe(data, charset)`

根据特定字符集中的指定字符串生成可在 Web 环境中安全使用的 base-64 编码字符串。字符集是一种字符编码方式，可用于编码字符。这些操作通常采用二进制格式，通常与某些数据传输协议不兼容。为了使数据兼容，通常会将其编码为 base 64，这是许多无法接受二进制数据的工具接受的常见编码。网络安全的 Base 64 通常用于电子邮件、HTTP 等互联网协议或 XML 文档中。

// "Google Groups" in Katakana (Japanese)
const input = 'Google グループ';

// Writes "R29vZ2xlIOOCsOODq-ODvOODlw==" to the log
const encoded = Utilities.base64EncodeWebSafe(input, Utilities.Charset.UTF_8);
Logger.log(encoded);

参数

名称	类型	说明
`data`	`String`	要编码的数据字符串。
`charset`	`Charset`	用于指定输入字符集的 `Charset`。

String - 使用给定 Charset 对输入字符串进行 base-64 编码的 Web 安全表示形式。

`computeDigest(algorithm, value)`

对指定的 Byte[] 值使用指定的算法计算摘要。

const input = Utilities.base64Decode(
    'aW5wdXQgdG8gaGFzaA0K');  // == base64encode("input to hash")
const digest = Utilities.computeDigest(Utilities.DigestAlgorithm.MD5, input);
Logger.log(digest);

参数

名称	类型	说明
`algorithm`	`DigestAlgorithm`	要使用的 `DigestAlgorithm`。
`value`	`Byte[]`	要计算摘要的输入字符串值。

Byte[] - 表示输出摘要的 byte[]。

`computeDigest(algorithm, value)`

对指定的 String 值使用指定的算法计算摘要。

const digest = Utilities.computeDigest(
    Utilities.DigestAlgorithm.MD5,
    'input to hash',
);
Logger.log(digest);

参数

名称	类型	说明
`algorithm`	`DigestAlgorithm`	要使用的 `DigestAlgorithm`。
`value`	`String`	要计算摘要的输入字符串值。

Byte[] - 表示输出摘要的 byte[]。

`computeDigest(algorithm, value, charset)`

使用指定的字符集对指定的 String 值使用指定的算法计算摘要。

const digest = Utilities.computeDigest(
    Utilities.DigestAlgorithm.MD5,
    'input to hash',
    Utilities.Charset.US_ASCII,
);
Logger.log(digest);

参数

名称	类型	说明
`algorithm`	`DigestAlgorithm`	要使用的 `DigestAlgorithm`。
`value`	`String`	要计算摘要的输入字符串值。
`charset`	`Charset`	表示输入字符集的 `Charset`。

Byte[] - 表示输出摘要的 byte[]。

`computeHmacSha256Signature(value, key)`

使用给定密钥通过 HMAC-SHA256 对所提供的值进行签名。

// This writes an array of bytes to the log.
const input = Utilities.base64Decode(
    'aW5wdXQgdG8gaGFzaA0K');                 // == base64encode("input to hash")
const key = Utilities.base64Decode('a2V5');  // == base64encode("key")
const signature = Utilities.computeHmacSha256Signature(input, key);
Logger.log(signature);

参数

名称	类型	说明
`value`	`Byte[]`	要为其生成哈希的输入值。
`key`	`Byte[]`	用于生成哈希的密钥。

Byte[] - 表示输出签名的 byte[]。

`computeHmacSha256Signature(value, key)`

使用给定密钥通过 HMAC-SHA256 对所提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeHmacSha256Signature(
    'this is my input',
    'my key - use a stronger one',
);
Logger.log(signature);

参数

名称	类型	说明
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成哈希的密钥。

Byte[] - 表示输出签名的 byte[]。

`computeHmacSha256Signature(value, key, charset)`

使用给定密钥和字符集通过 HMAC-SHA256 对所提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeHmacSha256Signature(
    'this is my input',
    'my key - use a stronger one',
    Utilities.Charset.US_ASCII,
);
Logger.log(signature);

参数

名称	类型	说明
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成哈希的密钥。
`charset`	`Charset`	表示输入字符集的 `Charset`。

Byte[] - 表示输出签名的 byte[]。

`computeHmacSignature(algorithm, value, key)`

对指定的键和值使用指定的算法计算消息认证码。

// This writes an array of bytes to the log.
const input = Utilities.base64Decode(
    'aW5wdXQgdG8gaGFzaA0K');                 // == base64encode("input to hash")
const key = Utilities.base64Decode('a2V5');  // == base64encode("key")
const signature = Utilities.computeHmacSignature(
    Utilities.MacAlgorithm.HMAC_MD5,
    input,
    key,
);
Logger.log(signature);

参数

名称	类型	说明
`algorithm`	`MacAlgorithm`	用于对输入值进行哈希处理的 `MacAlgorithm` 算法。
`value`	`Byte[]`	要为其生成哈希的输入值。
`key`	`Byte[]`	用于生成哈希的密钥。

Byte[] - 表示输出签名的 byte[]。

`computeHmacSignature(algorithm, value, key)`

对指定的键和值使用指定的算法计算消息认证码。

// This writes an array of bytes to the log.
const signature = Utilities.computeHmacSignature(
    Utilities.MacAlgorithm.HMAC_MD5,
    'input to hash',
    'key',
);
Logger.log(signature);

参数

名称	类型	说明
`algorithm`	`MacAlgorithm`	用于对输入值进行哈希处理的 `MacAlgorithm` 算法。
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成哈希的密钥。

Byte[] - 表示输出签名的 byte[]。

`computeHmacSignature(algorithm, value, key, charset)`

对指定的键和值使用指定的算法计算消息认证码。

// This writes an array of bytes to the log.
const signature = Utilities.computeHmacSignature(
    Utilities.MacAlgorithm.HMAC_MD5,
    'input to hash',
    'key',
    Utilities.Charset.US_ASCII,
);
Logger.log(signature);

参数

名称	类型	说明
`algorithm`	`MacAlgorithm`	用于对输入值进行哈希处理的 `MacAlgorithm` 算法。
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成哈希的密钥。
`charset`	`Charset`	表示输入字符集的 `Charset`。

Byte[] - 表示输出签名的 byte[]。

`computeRsaSha1Signature(value, key)`

使用给定密钥通过 RSA-SHA1 对所提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeRsaSha1Signature(
    'this is my input',
    PropertiesService.getScriptProperties().getProperty('YOUR_PRIVATE_KEY'),
);
Logger.log(signature);

参数

名称	类型	说明
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成签名的 PEM 格式密钥。

Byte[] - 表示输出签名的 byte[]。

`computeRsaSha1Signature(value, key, charset)`

使用给定密钥和字符集通过 RSA-SHA1 对所提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeRsaSha1Signature(
    'this is my input',
    PropertiesService.getScriptProperties().getProperty('YOUR_PRIVATE_KEY'),
    Utilities.Charset.US_ASCII,
);
Logger.log(signature);

参数

名称	类型	说明
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成签名的 PEM 格式密钥。
`charset`	`Charset`	表示输入字符集的 `Charset`。

Byte[] - 表示输出签名的 byte[]。

`computeRsaSha256Signature(value, key)`

使用给定密钥通过 RSA-SHA256 对所提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeRsaSha256Signature(
    'this is my input',
    PropertiesService.getScriptProperties().getProperty('YOUR_PRIVATE_KEY'),
);
Logger.log(signature);

参数

名称	类型	说明
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成签名的 PEM 格式密钥。

Byte[] - 表示输出签名的 byte[]。

`computeRsaSha256Signature(value, key, charset)`

使用给定密钥通过 RSA-SHA256 对所提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeRsaSha256Signature(
    'this is my input',
    PropertiesService.getScriptProperties().getProperty('YOUR_PRIVATE_KEY'),
);
Logger.log(signature);

参数

名称	类型	说明
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成签名的 PEM 格式密钥。
`charset`	`Charset`	表示输入字符集的 `Charset`。

Byte[] - 表示输出签名的 byte[]。

`computeRsaSignature(algorithm, value, key)`

使用指定的 RSA 算法和给定密钥对提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeRsaSignature(
    Utilities.RsaAlgorithm.RSA_SHA_256,
    'this is my input',
    PropertiesService.getScriptProperties().getProperty('YOUR_PRIVATE_KEY'),
);
Logger.log(signature);

参数

名称	类型	说明
`algorithm`	`RsaAlgorithm`	用于对输入值进行哈希处理的 `RsaAlgorithm` 算法。
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成签名的 PEM 格式密钥。

Byte[] - 表示输出签名的 byte[]。

`computeRsaSignature(algorithm, value, key, charset)`

使用指定的 RSA 算法、给定密钥和字符集对所提供的值进行签名。

// This writes an array of bytes to the log.
const signature = Utilities.computeRsaSignature(
    Utilities.RsaAlgorithm.RSA_SHA_256,
    'this is my input',
    PropertiesService.getScriptProperties().getProperty('YOUR_PRIVATE_KEY'),
    Utilities.Charset.US_ASCII,
);
Logger.log(signature);

参数

名称	类型	说明
`algorithm`	`RsaAlgorithm`	用于对输入值进行哈希处理的 `RsaAlgorithm` 算法。
`value`	`String`	要为其生成哈希的输入值。
`key`	`String`	用于生成签名的 PEM 格式密钥。
`charset`	`Charset`	表示输入字符集的 `Charset`。

Byte[] - 表示输出签名的 byte[]。

`formatDate(date, timeZone, format)`

根据 Java SE SimpleDateFormat 类中所述的规范设置日期格式。请访问 http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html 查看规范

// This formats the date as Greenwich Mean Time in the format
// year-month-dateThour-minute-second.
const formattedDate = Utilities.formatDate(
    new Date(),
    'GMT',
    'yyyy-MM-dd\'T\'HH:mm:ss\'Z\'',
);
Logger.log(formattedDate);

参数

名称	类型	说明
`date`	`Date`	要设置为字符串格式的 `Date`。
`timeZone`	`String`	结果的输出时区。
`format`	`String`	符合 `SimpleDateFormat` 规范的格式。

String - 输入日期（采用格式化字符串）。

`formatString(template, args)`

使用“%”格式的格式字符串执行类似 sprintf 的字符串格式设置。

// " 123.456000"
Utilities.formatString('%11.6f', 123.456);

// "   abc"
Utilities.formatString('%6s', 'abc');

参数

名称	类型	说明
`template`	`String`	用于控制返回内容的格式字符串。
`args`	`Object...`	用于填充模板中“%”占位符的对象。

String - 格式化字符串。

`getUuid()`

以字符串形式获取 UUID（相当于使用 java.util.UUID.randomUUID() 方法）。此标识符不能保证在任何时间和空间都是唯一的。因此，请勿在需要保证唯一性的情况下使用。

// This assigns a UUID as a temporary ID for a data object you are creating in
// your script.
const myDataObject = {
  tempId: Utilities.getUuid(),
};

String - UUID 的字符串表示法。

`gzip(blob)`

gzip-压缩所提供的 Blob 数据，并将其返回到新的 Blob 对象中。

const textBlob = Utilities.newBlob(
    'Some text to compress using gzip compression',
);

// Create the compressed blob.
const gzipBlob = Utilities.gzip(textBlob);

参数

名称	类型	说明
`blob`	`BlobSource`	要使用 `gzip` 压缩的 `Blob` 对象。

Blob - 包含压缩数据的新 Blob。

`gzip(blob, name)`

gzip-压缩所提供的 Blob 数据，并将其返回到新的 Blob 对象中。此版本的方法允许指定文件名。

const textBlob = Utilities.newBlob(
    'Some text to compress using gzip compression',
);

// Create the compressed blob.
const gzipBlob = Utilities.gzip(textBlob, 'text.gz');

参数

名称	类型	说明
`blob`	`BlobSource`	要使用 `gzip` 压缩的 `Blob` 对象。
`name`	`String`	要创建的 `gzip` 文件的名称。

Blob - 包含压缩数据的新 Blob。

`newBlob(data)`

通过字节数组创建新的 Blob 对象。许多以二进制数据为输入的 Apps Script API 中都使用了 Blob。

// Creates a blob object from a byte array.
const data = [71, 79, 79, 71, 76, 69];
const blob = Utilities.newBlob(data);

// Logs the blob data as a string to the console.
console.log(blob.getDataAsString());

参数

名称	类型	说明
`data`	`Byte[]`	blob 的字节。

Blob - 新创建的 Blob。

`newBlob(data, contentType)`

使用字节数组和内容类型创建新的 Blob 对象。许多以二进制数据为输入的 Apps Script API 都使用了 Blob。

// Declares a byte array.
const data = [71, 79, 79, 71, 76, 69];

// Declares the content type of the blob.
const contentType = 'application/json';

// Creates a blob object from the byte array and content type.
const blob = Utilities.newBlob(data, contentType);

// Logs the blob data as a string to the console.
console.log(blob.getDataAsString());

// Logs the content type of the blob to the console.
console.log(blob.getContentType());

参数

名称	类型	说明
`data`	`Byte[]`	blob 的字节。
`contentType`	`String`	blob 的内容类型 - 可以是 `null`。

Blob - 新创建的 Blob。

`newBlob(data, contentType, name)`

使用字节数组、内容类型和名称创建新的 Blob 对象。许多以二进制数据为输入的 Apps Script API 中都使用了 Blob。

// Declares a byte array.
const data = [71, 79, 79, 71, 76, 69];

// Declares the content type of the blob.
const contentType = 'application/json';

// Declares the name of the blob.
const name = 'Example blob';

// Creates a blob object from the byte array, content type, and name.
const blob = Utilities.newBlob(data, contentType, name);

// Logs the blob data as a string to the console.
console.log('Blob data:', blob.getDataAsString());

// Logs the content type of the blob to the console.
console.log('Blob content type:', blob.getContentType());

// Logs the name of the blob to the console.
console.log('Blob name:', blob.getName());

参数

名称	类型	说明
`data`	`Byte[]`	blob 的字节。
`contentType`	`String`	- blob 的内容类型 - 可以是 `null`。
`name`	`String`	blob 的名称 - 可以是 `null`。

Blob - 新创建的 Blob。

`newBlob(data)`

从字符串创建新的 Blob 对象。许多以二进制数据为输入的 Apps Script API 中都使用了 Blob。

// Declares a string for the blob.
const data = 'GOOGLE';

// Creates a blob object from a string.
const blob = Utilities.newBlob(data);

// Logs the blob data in byte array to the console.
console.log('Blob Data:', blob.getBytes());

参数

名称	类型	说明
`data`	`String`	该 blob 的字符串，假定为 UTF-8。

Blob - 新创建的 Blob。

`newBlob(data, contentType)`

使用字符串和内容类型创建新的 Blob 对象。许多以二进制数据为输入的 Apps Script API 都使用了 Blob。

// Declares a string for the blob.
const data = 'GOOGLE';

// Declares the content type of blob.
const contentType = 'application/json';

// Creates a blob object from the string and content type.
const blob = Utilities.newBlob(data, contentType);

// Logs the blob data in byte array to the console.
console.log('Blob data:', blob.getBytes());

// Logs the content type of the blob to the console.
console.log(blob.getContentType());

参数

名称	类型	说明
`data`	`String`	该 blob 的字符串，假定为 UTF-8。
`contentType`	`String`	blob 的内容类型 - 可以是 `null`。

Blob - 新创建的 Blob。

`newBlob(data, contentType, name)`

使用字符串、内容类型和名称创建新的 Blob 对象。许多以二进制数据为输入的 Apps Script API 中都使用了 Blob。

// Declares a string for the blob.
const data = 'GOOGLE';

// Declares the content type of the blob.
const contentType = 'application/json';

// Declares the name of the blob.
const name = 'Example blob';

// Create a blob object from the string, content type, and name.
const blob = Utilities.newBlob(data, contentType, name);

// Logs the blob data in byte array to the console.
console.log('Blob data:', blob.getBytes());

// Logs the content type of the blob to the console.
console.log('Blob content type:', blob.getContentType());

// Logs the name of the blob to the console.
console.log('Blob name:', blob.getName());

参数

名称	类型	说明
`data`	`String`	该 blob 的字符串，假定为 UTF-8。
`contentType`	`String`	blob 的内容类型 - 可以是 `null`。
`name`	`String`	blob 的名称 - 可以是 `null`。

Blob - 新创建的 Blob。

`parseCsv(csv)`

返回 CSV 字符串的表格化二维数组表示法。

// This creates a two-dimensional array of the format [[a, b, c], [d, e, f]]
const csvString = 'a,b,c\nd,e,f';
const data = Utilities.parseCsv(csvString);

参数

名称	类型	说明
`csv`	`String`	一个字符串，其中包含以逗号分隔值 (CSV) 格式表示的单行或多行数据。

String[][] - 一个二维数组，其中包含 CSV 字符串中的值。

`parseCsv(csv, delimiter)`

使用自定义分隔符返回 CSV 字符串的表格化二维数组表示法。

// This creates a two-dimensional array of the format [[a, b, c], [d, e, f]]
const csvString = 'a\tb\tc\nd\te\tf';
const data = Utilities.parseCsv(csvString, '\t');

参数

名称	类型	说明
`csv`	`String`	一个字符串，其中包含以逗号分隔值 (CSV) 格式表示的单行或多行数据。
`delimiter`	`Char`	在值之间。

String[][] - 一个二维数组，其中包含 CSV 字符串中的值。

`parseDate(date, timeZone, format)`

根据 Java 标准版 SimpleDateFormat 类中所述的规范解析所提供的字符串日期。如需了解详情，请参阅 Java SimpleDateFormat 类。

// This set of parameters parses the given string as a date in Greenwich Mean
// Time, formatted as year-month-dateThour-minute-second.
const date = Utilities.parseDate(
    '1970-01-01 00:00:00',
    'GMT',
    'yyyy-MM-dd\' \'HH:mm:ss',
);
Logger.log(date);

参数

名称	类型	说明
`date`	`String`	要解析为日期的字符串值。
`timeZone`	`String`	输出时区。
`format`	`String`	符合 `SimpleDateFormat` 规范的日期格式。

Date - 以日期形式的输入字符串。

`sleep(milliseconds)`

休眠指定毫秒数。立即让脚本进入休眠状态，持续指定的毫秒数。允许的最大值为 300000（或 5 分钟）。

// Creates a blob object from a string.
const data = 'GOOGLE';
const blob = Utilities.newBlob(data);

// Puts the script to sleep for 10,000 milliseconds (10 seconds).
Utilities.sleep(10000);

// Logs the blob data in byte array to the console.
console.log(blob.getBytes());

参数

名称	类型	说明
`milliseconds`	`Integer`	要休眠的毫秒数。

`ungzip(blob)`

解压缩 Blob 对象，并返回包含未压缩数据的 Blob。

const textBlob = Utilities.newBlob(
    'Some text to compress using gzip compression',
);

// Create the compressed blob.
const gzipBlob = Utilities.gzip(textBlob, 'text.gz');

// Uncompress the data.
const uncompressedBlob = Utilities.ungzip(gzipBlob);

参数

名称	类型	说明
`blob`	`BlobSource`	压缩数据的 `Blob`。

Blob - 表示解压缩数据的 Blob。

`unzip(blob)`

接受表示 ZIP 文件的 Blob，并返回其组件文件。

const googleFavIconUrl = 'https://www.google.com/favicon.ico';
const googleLogoUrl = 'https://www.google.com/images/srpr/logo3w.png';

// Fetch the Google favicon.ico file and get the Blob data
const faviconBlob = UrlFetchApp.fetch(googleFavIconUrl).getBlob();
const logoBlob = UrlFetchApp.fetch(googleLogoUrl).getBlob();

// zip now references a blob containing an archive of both faviconBlob and
// logoBlob
const zip = Utilities.zip([faviconBlob, logoBlob], 'google_images.zip');

// This now unzips the blobs
const files = Utilities.unzip(zip);

参数

名称	类型	说明
`blob`	`BlobSource`	ZIP 文件 blob。

Blob[] - 表示组件 Blob 的 Blob[]，每个 Blob 都使用 ZIP 中的完整路径进行命名。

`zip(blobs)`

创建一个新的 Blob 对象，该对象是一个 zip 文件，其中包含传入的 Blob 中的数据。

const googleFavIconUrl = 'https://www.google.com/favicon.ico';
const googleLogoUrl = 'https://www.google.com/images/srpr/logo3w.png';

// Fetch the Google favicon.ico file and get the Blob data
const faviconBlob = UrlFetchApp.fetch(googleFavIconUrl).getBlob();
const logoBlob = UrlFetchApp.fetch(googleLogoUrl).getBlob();

// zip now references a blob containing an archive of both faviconBlob and
// logoBlob
const zip = Utilities.zip([faviconBlob, logoBlob]);

参数

名称	类型	说明
`blobs`	`BlobSource[]`	要压缩的 blob 的数组。

Blob - 一个包含归档形式输入的新 blob。

`zip(blobs, name)`

创建一个新的 Blob 对象，该对象是一个 zip 文件，其中包含传入的 Blob 中的数据。此版本的方法允许指定文件名。

const googleFavIconUrl = 'https://www.google.com/favicon.ico';
const googleLogoUrl = 'https://www.google.com/images/srpr/logo3w.png';

// Fetch the Google favicon.ico file and get the Blob data
const faviconBlob = UrlFetchApp.fetch(googleFavIconUrl).getBlob();
const logoBlob = UrlFetchApp.fetch(googleLogoUrl).getBlob();

// zip now references a blob containing an archive of both faviconBlob and
// logoBlob
const zip = Utilities.zip([faviconBlob, logoBlob], 'google_images.zip');

参数

名称	类型	说明
`blobs`	`BlobSource[]`	要压缩的 blob 的数组。
`name`	`String`	要创建的 ZIP 文件的名称。

Blob - 一个包含归档形式输入的新 blob。

已弃用的方法

`jsonParse(jsonString)`

已弃用。自 2013 年 11 月起，已被 JSON.parse() 替代

返回与传入的 JSON 字符串对应的对象。

// Returns the object { name: "John Smith", company: "Virginia Company"}
const obj = Utilities.jsonParse(
    '{"name":"John Smith","company":"Virginia Company"}',
);

参数

名称	类型	说明
`jsonString`	`String`	要进行反序列化的 JavaScript 对象的字符串表示形式。

Object - 输入的 JavaScript 对象表示法。

`jsonStringify(obj)`

已弃用。自 2013 年 11 月起，已被 JSON.stringify() 替代

返回传入对象的 JSON 字符串。

// Logs: {"name":"John Smith","company":"Virginia Company"}
const person = {
  name: 'John Smith',
  company: 'Virginia Company',
};
const json = Utilities.jsonStringify(person);
Logger.log(json);

参数

名称	类型	说明
`obj`	`Object`	要序列化为 JSON 的 JavaScript 对象

String - JSON 序列化 JavaScript 对象