Class Utilities

Утилиты

Этот сервис предоставляет утилиты для кодирования/декодирования строк, форматирования даты, манипулирования JSON и других задач.

Характеристики

Свойство Тип Описание
Charset Charset
Digest Algorithm Digest Algorithm
Mac Algorithm Mac Algorithm
Rsa Algorithm Rsa Algorithm

Методы

Метод Тип возврата Краткое описание
base64Decode(encoded) Byte[] Декодирует строку в кодировке Base64 в массив байтов UTF-8.
base64Decode(encoded, charset) Byte[] Декодирует строку в кодировке Base64 в массив байтов в определенном наборе символов.
base64DecodeWebSafe(encoded) Byte[] Декодирует строку, закодированную в веб-безопасном формате Base64, в массив байтов UTF-8.
base64DecodeWebSafe(encoded, charset) Byte[] Декодирует строку, закодированную в веб-безопасном формате Base64, в массив байтов в определенном наборе символов.
base64Encode(data) String Генерирует строку в кодировке Base64 из заданного массива байтов.
base64Encode(data) String Генерирует строку в кодировке Base64 из заданной строки.
base64Encode(data, charset) String Генерирует строку в кодировке Base64 из заданной строки в определенном наборе символов.
base64EncodeWebSafe(data) String Генерирует строку в веб-кодировке Base64 из заданного массива байтов.
base64EncodeWebSafe(data) String Генерирует строку в веб-кодировке Base64 из заданной строки.
base64EncodeWebSafe(data, charset) String Генерирует строку в веб-кодировке Base64 из заданной строки в определенном наборе символов.
compute Digest(algorithm, value) Byte[] Вычислите дайджест, используя указанный алгоритм для указанного значения Byte[] .
compute Digest(algorithm, value) Byte[] Вычислите дайджест, используя указанный алгоритм для указанного String значения.
compute Digest(algorithm, value, charset) Byte[] Вычислите дайджест, используя указанный алгоритм для указанного значения String с заданным набором символов.
compute Hmac Sha256Signature(value, key) Byte[] Подписывает предоставленное значение с помощью HMAC-SHA256 с заданным ключом.
compute Hmac Sha256Signature(value, key) Byte[] Подписывает предоставленное значение с помощью HMAC-SHA256 с заданным ключом.
compute Hmac Sha256Signature(value, key, charset) Byte[] Подписывает предоставленное значение с помощью HMAC-SHA256 с заданным ключом и набором символов.
compute Hmac Signature(algorithm, value, key) Byte[] Вычислите код аутентификации сообщения, используя указанный алгоритм для указанного ключа и значения.
compute Hmac Signature(algorithm, value, key) Byte[] Вычислите код аутентификации сообщения, используя указанный алгоритм для указанного ключа и значения.
compute Hmac Signature(algorithm, value, key, charset) Byte[] Вычислите код аутентификации сообщения, используя указанный алгоритм для указанного ключа и значения.
compute Rsa Sha1Signature(value, key) Byte[] Подписывает предоставленное значение с помощью RSA-SHA1 с заданным ключом.
compute Rsa Sha1Signature(value, key, charset) Byte[] Подписывает предоставленное значение с помощью RSA-SHA1 с заданным ключом и кодировкой.
compute Rsa Sha256Signature(value, key) Byte[] Подписывает предоставленное значение с помощью RSA-SHA256 с заданным ключом.
compute Rsa Sha256Signature(value, key, charset) Byte[] Подписывает предоставленное значение с помощью RSA-SHA256 с заданным ключом.
compute Rsa Signature(algorithm, value, key) Byte[] Подписывает предоставленное значение, используя указанный алгоритм RSA с заданным ключом.
compute Rsa Signature(algorithm, value, key, charset) Byte[] Подписывает предоставленное значение, используя указанный алгоритм RSA с заданным ключом и кодировкой.
format Date(date, timeZone, format) String Форматирует дату в соответствии со спецификацией, описанной в классе Java SE SimpleDateFormat.
format String(template, args) String Выполняет форматирование строк в стиле sprintf с использованием строк формата '%'.
get Uuid() String Получите UUID в виде строки (эквивалентно использованию метода java.util.UUID.randomUUID() ).
gzip(blob) Blob gzip — сжимает предоставленные данные Blob и возвращает их в новом объекте Blob .
gzip(blob, name) Blob gzip — сжимает предоставленные данные Blob и возвращает их в новом объекте Blob .
new Blob(data) Blob Создайте новый объект Blob из массива байтов.
new Blob(data, contentType) Blob Создайте новый объект Blob на основе байтового массива и типа контента.
new Blob(data, contentType, name) Blob Создайте новый объект Blob на основе массива байтов, типа контента и имени.
new Blob(data) Blob Создайте новый объект Blob из строки.
new Blob(data, contentType) Blob Создайте новый объект Blob на основе строки и типа контента.
new Blob(data, contentType, name) Blob Создайте новый объект Blob на основе строки, типа контента и имени.
parse Csv(csv) String[][] Возвращает табличное представление двумерного массива строки CSV.
parse Csv(csv, delimiter) String[][] Возвращает табличное представление 2D-массива строки CSV с использованием настраиваемого разделителя.
parse Date(date, timeZone, format) Date Анализирует предоставленную строку даты в соответствии со спецификацией, описанной в классе Simple Date Format Java Standard Edition.
sleep(milliseconds) void Спит в течение указанного количества миллисекунд.
ungzip(blob) Blob Распаковывает объект Blob и возвращает Blob содержащий несжатые данные.
unzip(blob) Blob[] Принимает большой двоичный объект, представляющий zip-файл, и возвращает файлы его компонентов.
zip(blobs) Blob Создает новый объект Blob, который представляет собой ZIP-файл, содержащий данные из переданных Blob.
zip(blobs, name) Blob Создает новый объект Blob, который представляет собой ZIP-файл, содержащий данные из переданных Blob.

Подробная документация

base64Decode(encoded)

Декодирует строку в кодировке Base64 в массив байтов 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[] — необработанные данные, представленные аргументом в кодировке Base64 в виде массива байтов.

base64Decode(encoded, charset)

Декодирует строку в кодировке Base64 в массив байтов в определенном наборе символов.

// 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[] — необработанные данные, представленные аргументом в кодировке Base64 в виде массива байтов.

base64DecodeWebSafe(encoded)

Декодирует строку, закодированную в веб-безопасном формате Base64, в массив байтов 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)

Декодирует строку, закодированную в веб-безопасном формате Base64, в массив байтов в определенном наборе символов.

// 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)

Генерирует строку в кодировке Base64 из заданного массива байтов. 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 — представление переданных данных в кодировке Base64.

base64Encode(data)

Генерирует строку в кодировке Base64 из заданной строки. Base 64 — это распространенная кодировка, принимаемая различными инструментами, которые не могут принимать двоичные данные. Base 64 обычно используется в интернет-протоколах, таких как электронная почта, HTTP или в документах XML.

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

Параметры

Имя Тип Описание
data String Строка для кодирования.

Возвращаться

String — Представление входной строки в кодировке Base64.

base64Encode(data, charset)

Генерирует строку в кодировке Base64 из заданной строки в определенном наборе символов. Кодировка — это способ кодирования символов, позволяющий их кодировать. Обычно они выполняются в двоичном формате, который обычно может быть несовместим с некоторыми протоколами передачи данных. Чтобы сделать данные совместимыми, их обычно кодируют в кодировке 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 — Представление входной строки в кодировке Base-64 с заданным Charset .

base64EncodeWebSafe(data)

Генерирует строку в веб-кодировке Base64 из заданного массива байтов. 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 — веб-безопасное представление передаваемых данных в формате Base64.

base64EncodeWebSafe(data)

Генерирует строку в веб-кодировке Base64 из заданной строки. Base 64 — это распространенная кодировка, принимаемая различными инструментами, которые не могут принимать двоичные данные. Веб-безопасность Base 64 обычно используется в интернет-протоколах, таких как электронная почта, HTTP или в XML-документах.

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

Параметры

Имя Тип Описание
data String Строка для кодирования.

Возвращаться

String — представление входной строки в веб-коде Base64.

base64EncodeWebSafe(data, charset)

Генерирует строку в веб-кодировке Base64 из заданной строки в определенном наборе символов. Кодировка — это способ кодирования символов, позволяющий их кодировать. Обычно они выполняются в двоичном формате, который обычно может быть несовместим с некоторыми протоколами передачи данных. Чтобы сделать данные совместимыми, их обычно кодируют в кодировке 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 — представление входной строки в веб-коде Base64 с заданным Charset .

compute Digest(algorithm, value)

Вычислите дайджест, используя указанный алгоритм для указанного значения Byte[] . 

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

Параметры

Имя Тип Описание
algorithm Digest Algorithm Используемый Digest Algorithm .
value Byte[] Значение входной строки, для которого нужно вычислить дайджест.

Возвращаться

Byte[] — Байт[], представляющий выходной дайджест.

compute Digest(algorithm, value)

Вычислите дайджест, используя указанный алгоритм для указанного String значения. 

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

Параметры

Имя Тип Описание
algorithm Digest Algorithm Используемый Digest Algorithm .
value String Значение входной строки, для которого нужно вычислить дайджест.

Возвращаться

Byte[] — Байт[], представляющий выходной дайджест.

compute Digest(algorithm, value, charset)

Вычислите дайджест, используя указанный алгоритм для указанного значения String с заданным набором символов. 

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

Параметры

Имя Тип Описание
algorithm Digest Algorithm Используемый Digest Algorithm .
value String Значение входной строки, для которого нужно вычислить дайджест.
charset Charset Charset представляющий входной набор символов.

Возвращаться

Byte[] — Байт[], представляющий выходной дайджест.

compute Hmac Sha256Signature(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[] — Байт[], представляющий выходную подпись.

compute Hmac Sha256Signature(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[] — Байт[], представляющий выходную подпись.

compute Hmac Sha256Signature(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[] — Байт[], представляющий выходную подпись.

compute Hmac Signature(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 Mac Algorithm Алгоритм Mac Algorithm используемый для хеширования входного значения.
value Byte[] Входное значение, для которого создается хэш.
key Byte[] Ключ, используемый для генерации хеша.

Возвращаться

Byte[] — Байт[], представляющий выходную подпись.

compute Hmac Signature(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 Mac Algorithm Алгоритм Mac Algorithm используемый для хеширования входного значения.
value String Входное значение, для которого создается хэш.
key String Ключ, используемый для генерации хеша.

Возвращаться

Byte[] — Байт[], представляющий выходную подпись.

compute Hmac Signature(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 Mac Algorithm Алгоритм Mac Algorithm используемый для хеширования входного значения.
value String Входное значение, для которого создается хэш.
key String Ключ, используемый для генерации хеша.
charset Charset Charset представляющий входной набор символов.

Возвращаться

Byte[] — Байт[], представляющий выходную подпись.

compute Rsa Sha1Signature(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[] — Байт[], представляющий выходную подпись.

compute Rsa Sha1Signature(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[] — Байт[], представляющий выходную подпись.

compute Rsa Sha256Signature(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[] — Байт[], представляющий выходную подпись.

compute Rsa Sha256Signature(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[] — Байт[], представляющий выходную подпись.

compute Rsa Signature(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 Rsa Algorithm Алгоритм Rsa Algorithm , используемый для хеширования входного значения.
value String Входное значение, для которого создается хэш.
key String Ключ в формате PEM, используемый для создания подписи.

Возвращаться

Byte[] — Байт[], представляющий выходную подпись.

compute Rsa Signature(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 Rsa Algorithm Алгоритм Rsa Algorithm , используемый для хеширования входного значения.
value String Входное значение, для которого создается хэш.
key String Ключ в формате PEM, используемый для создания подписи.
charset Charset Charset представляющий входной набор символов.

Возвращаться

Byte[] — Байт[], представляющий выходную подпись.

format Date(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 для форматирования как строка.
time Zone String Выходной часовой пояс результата.
format String Формат согласно спецификации Simple Date Format .

Возвращаться

String — Входная дата в виде форматированной строки.

format String(template, args)

Выполняет форматирование строк в стиле sprintf с использованием строк формата '%'. 

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

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

Параметры

Имя Тип Описание
template String Строка формата, определяющая возвращаемые данные.
args Object... Объекты, используемые для заполнения заполнителей «%» в шаблоне.

Возвращаться

String — форматированная строка.

get Uuid()

Получите 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 Blob Source Объект Blob для сжатия с помощью gzip .

Возвращаться

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 Blob Source Объект Blob для сжатия с помощью gzip .
name String Имя создаваемого файла gzip .

Возвращаться

Blob — новый объект Blob содержащий сжатые данные.

new Blob(data)

Создайте новый объект Blob из массива байтов. Большие двоичные объекты используются во многих API-интерфейсах Apps Script, которые принимают двоичные данные в качестве входных данных. 

// 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.

new Blob(data, contentType)

Создайте новый объект Blob на основе байтового массива и типа контента. Большие двоичные объекты используются во многих API-интерфейсах Apps Script, которые принимают двоичные данные в качестве входных данных. 

// 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[] Байты для большого двоичного объекта.
content Type String Тип содержимого большого двоичного объекта — может быть null .

Возвращаться

Blob — недавно созданный Blob.

new Blob(data, contentType, name)

Создайте новый объект Blob на основе массива байтов, типа контента и имени. Большие двоичные объекты используются во многих API-интерфейсах Apps Script, которые принимают двоичные данные в качестве входных данных. 

// 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[] Байты для большого двоичного объекта.
content Type String — Тип содержимого большого двоичного объекта — может быть null .
name String Имя большого двоичного объекта может иметь значение null .

Возвращаться

Blob — недавно созданный Blob.

new Blob(data)

Создайте новый объект Blob из строки. Большие двоичные объекты используются во многих API-интерфейсах Apps Script, которые принимают двоичные данные в качестве входных данных. 

// 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 Строка для большого двоичного объекта, предполагается UTF-8.

Возвращаться

Blob — недавно созданный Blob.

new Blob(data, contentType)

Создайте новый объект Blob на основе строки и типа контента. Большие двоичные объекты используются во многих API-интерфейсах Apps Script, которые принимают двоичные данные в качестве входных данных. 

// 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 Строка для большого двоичного объекта, предполагается UTF-8.
content Type String Тип содержимого большого двоичного объекта — может быть null .

Возвращаться

Blob — недавно созданный Blob.

new Blob(data, contentType, name)

Создайте новый объект Blob на основе строки, типа контента и имени. Большие двоичные объекты используются во многих API-интерфейсах Apps Script, которые принимают двоичные данные в качестве входных данных. 

// 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 Строка для большого двоичного объекта, предполагается UTF-8.
content Type String Тип содержимого большого двоичного объекта — может быть null .
name String Имя большого двоичного объекта может иметь значение null .

Возвращаться

Blob — недавно созданный Blob.

parse Csv(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.

parse Csv(csv, delimiter)

Возвращает табличное представление 2D-массива строки 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.

parse Date(date, timeZone, format)

Анализирует предоставленную строку даты в соответствии со спецификацией, описанной в классе Simple Date Format Java Standard Edition. Для получения дополнительной информации см. класс Java Simple Date Format . 

// 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 Строковое значение для анализа как даты.
time Zone String Выходной часовой пояс.
format String Формат даты согласно спецификации Simple Date Format .

Возвращаться

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 Blob Source Blob сжатых данных.

Возвращаться

Blob — Blob представляющий распакованные данные.

unzip(blob)

Принимает большой двоичный объект, представляющий zip-файл, и возвращает файлы его компонентов. 

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 Blob Source Большой двоичный файл zip-файла.

Возвращаться

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 Blob Source[] Массив капель, которые можно заархивировать.

Возвращаться

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 Blob Source[] Массив капель, которые можно заархивировать.
name String Имя создаваемого zip-файла.

Возвращаться

Blob — новый большой двоичный объект, содержащий входные данные в виде архива.

Устаревшие методы