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	根据给定的字符串生成 base-64 网络安全编码字符串。
base64EncodeWebSafe(data, charset)	String	该函数根据特定字符集中的指定字符串生成 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 グループ"
var base64data = "R29vZ2xlIOOCsOODq+ODvOODlw==";

// This logs:
//     [71, 111, 111, 103, 108, 101, 32, -29, -126, -80,
//      -29, -125, -85, -29, -125, -68, -29, -125, -105]
var 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 グループ"
var base64data = "R29vZ2xlIOOCsOODq+ODvOODlw==";

var 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 グループ"
var base64data = "R29vZ2xlIOOCsOODq-ODvOODlw==";

var 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 グループ"
var base64data = "R29vZ2xlIOOCsOODq-ODvOODlw==";

var 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
var blob = Utilities.newBlob("A string here");

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

参数

名称	类型	说明
data	Byte[]	要编码的数据的 byte[]。

返回

String - 所传入数据的 base-64 编码表示形式。

---

base64Encode(data)

根据给定的字符串生成 base-64 编码的字符串。Base 64 是可接受的常用编码格式， 各种不可接受二进制数据的工具。Base 64 通常用于互联网 协议（例如电子邮件、HTTP）或 XML 文档中。

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

参数

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

返回

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

---

base64Encode(data, charset)

该函数根据特定字符集中的指定字符串生成 base-64 编码字符串。字符集 是一种对字符进行编码以便对其进行编码的方法。这些通常是在 二进制格式，这种格式通常与某些数据传输协议不兼容。接收者 它们通常采用 Base64 编码， 被各种无法接受二进制数据的工具所接受。Base 64 通常用于 例如电子邮件、HTTP 或 XML 文档。

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

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

参数

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

返回

String - 具有指定 Charset 的输入字符串的 base-64 编码表示法。

---

base64EncodeWebSafe(data)

根据给定的字节数组生成 base-64 网络安全编码字符串。Base64 是一种常见的 无法接受二进制数据的各类工具所接受的编码。Base 64 网络安全 通常用于互联网协议（如电子邮件、HTTP）或 XML 文档。

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

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

参数

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

返回

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

---

base64EncodeWebSafe(data)

根据给定的字符串生成 base-64 网络安全编码字符串。Base 64 是一种常见的编码格式， 被各种无法接受二进制数据的工具所接受。Base 64 通常可让网络安全 使用电子邮件、HTTP 等互联网协议或 XML 文档。

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

参数

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

返回

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

---

base64EncodeWebSafe(data, charset)

该函数根据特定字符集中的指定字符串生成 base-64 网络安全编码字符串。 字符集是一种对字符进行编码以便对其进行编码的方式。这些通常是 以二进制格式完成，该格式通常与某些数据传输格式不兼容 协议为使数据兼容，它们通常会以 base 64 编码， 各种不能接受二进制数据的工具所接受的通用编码。Base 64 网络安全 通常用于互联网协议（例如电子邮件、HTTP）或 XML 文档中。

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

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

参数

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

返回

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

---

computeDigest(algorithm, value)

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

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

参数

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

返回

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

---

computeDigest(algorithm, value)

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

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

参数

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

返回

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

---

computeDigest(algorithm, value, charset)

使用指定算法根据指定的 String 值和 给定字符集。

var 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.
var input = Utilities.base64Decode("aW5wdXQgdG8gaGFzaA0K") // == base64encode("input to hash")
var key = Utilities.base64Decode("a2V5"); // == base64encode("key")
var 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.
var 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.
var 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.
var input = Utilities.base64Decode("aW5wdXQgdG8gaGFzaA0K") // == base64encode("input to hash")
var key = Utilities.base64Decode("a2V5"); // == base64encode("key")
var 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.
var 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.
var 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.
var signature = Utilities.computeRsaSha1Signature("this is my input",
    "-----BEGIN PRIVATE KEY-----\nprivatekeyhere\n-----END PRIVATE KEY-----\n");
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.
var signature = Utilities.computeRsaSha1Signature("this is my input",
    "-----BEGIN PRIVATE KEY-----\nprivatekeyhere\n-----END PRIVATE KEY-----\n"
    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.
var signature = Utilities.computeRsaSha256Signature("this is my input",
    "-----BEGIN PRIVATE KEY-----\nprivatekeyhere\n-----END PRIVATE KEY-----\n");
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.
var signature = Utilities.computeRsaSha256Signature("this is my input",
    "-----BEGIN PRIVATE KEY-----\nprivatekeyhere\n-----END PRIVATE KEY-----\n");
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.
var signature = Utilities.computeRsaSignature(Utilities.RsaAlgorithm.RSA_SHA_256,
    "this is my input",
    "-----BEGIN PRIVATE KEY-----\nprivatekeyhere\n-----END PRIVATE KEY-----\n");
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.
var signature = Utilities.computeRsaSignature(Utilities.RsaAlgorithm.RSA_SHA_256,
    "this is my input",
    "-----BEGIN PRIVATE KEY-----\nprivatekeyhere\n-----END PRIVATE KEY-----\n",
    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.
var 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.
var myDataObject = {
   tempId: Utilities.getUuid();
};

返回

String - UUID 的字符串表示。

---

gzip(blob)

gzip 会压缩提供的 Blob 数据，并在新的 Blob 对象中返回该数据。

var textBlob = Utilities.newBlob("Some text to compress using gzip compression");

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

参数

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

返回

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

---

gzip(blob, name)

gzip 会压缩提供的 Blob 数据，并在新的 Blob 对象中返回该数据。此版本的方法允许指定文件名。

var textBlob = Utilities.newBlob("Some text to compress using gzip compression");

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

参数

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

返回

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

---

newBlob(data)

从字节数组创建新的 Blob 对象。Blob 用在许多 Apps Script API 中， 作为输入。

// 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 对象。Blob 用在许多 Apps 脚本中 将二进制数据作为输入的 API。

// 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 对象。Blob 用于许多应用 将二进制数据作为输入的脚本 API。

// 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 对象。Blob 用在许多 Apps Script API 中， 作为输入。

// 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 对象。Blob 用在许多 Apps 脚本中 将二进制数据作为输入的 API。

// 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 对象。Blob 用于许多应用 将二进制数据作为输入的脚本 API。

// 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]]
var csvString = "a,b,c\nd,e,f";
var 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]]
var csvString = "a\tb\tc\nd\te\tf";
var 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.
var 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 数据。

var textBlob = Utilities.newBlob("Some text to compress using gzip compression");

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

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

参数

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

返回

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

---

unzip(blob)

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

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

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

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

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

参数

名称	类型	说明
blob	BlobSource	zip 文件 blob。

返回

Blob[] - 一个 Blob[]，表示组件 Blob，每个 Blob 均使用 zip。

---

zip(blobs)

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

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

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

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

参数

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

返回

Blob - 包含输入作为归档的新 blob。

---

zip(blobs, name)

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

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

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

// zip now references a blob containing an archive of both faviconBlob and logoBlob
var 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"}
var 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"}
var person = { name: "John Smith", company: "Virginia Company" };
var json = Utilities.jsonStringify(person);
Logger.log(json);

参数

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

返回

String - JSON 序列化 JavaScript 对象