Esta página foi traduzida pela API Cloud Translation.

Class Utilities

Esse serviço oferece utilitários para codificação/decodificação de strings, formatação de data, manipulação de JSON e outras tarefas diversas.

Propriedades

Propriedade	Tipo	Descrição
`Charset`	`Charset`
`DigestAlgorithm`	`DigestAlgorithm`
`MacAlgorithm`	`MacAlgorithm`
`RsaAlgorithm`	`RsaAlgorithm`

Métodos

Método	Tipo de retorno	Breve descrição
`base64Decode(encoded)`	`Byte[]`	Decodifica uma string codificada em base 64 em uma matriz de bytes UTF-8.
`base64Decode(encoded, charset)`	`Byte[]`	Decodifica uma string codificada em base64 em uma matriz de bytes em um conjunto de caracteres específico.
`base64DecodeWebSafe(encoded)`	`Byte[]`	Decodifica uma string codificada em base64 para a Web em uma matriz de bytes UTF-8.
`base64DecodeWebSafe(encoded, charset)`	`Byte[]`	Decodifica uma string codificada em base64 para a Web em uma matriz de bytes em um conjunto de caracteres específico.
`base64Encode(data)`	`String`	Gera uma string codificada em base-64 a partir da matriz de bytes especificada.
`base64Encode(data)`	`String`	Gera uma string codificada em base64 com base na string especificada.
`base64Encode(data, charset)`	`String`	Gera uma string codificada em base64 a partir da string especificada em um conjunto de caracteres específico.
`base64EncodeWebSafe(data)`	`String`	Gera uma string codificada em base64 para a Web a partir da matriz de bytes especificada.
`base64EncodeWebSafe(data)`	`String`	Gera uma string codificada em base64 para a Web a partir da string especificada.
`base64EncodeWebSafe(data, charset)`	`String`	Gera uma string codificada em base-64 segura para a Web a partir da string especificada em um conjunto de caracteres específico.
`computeDigest(algorithm, value)`	`Byte[]`	Calcula um resumo usando o algoritmo especificado no valor `Byte[]` especificado.
`computeDigest(algorithm, value)`	`Byte[]`	Calcula um resumo usando o algoritmo especificado no valor `String` especificado.
`computeDigest(algorithm, value, charset)`	`Byte[]`	Calcule um resumo usando o algoritmo especificado no valor `String` especificado com o conjunto de caracteres fornecido.
`computeHmacSha256Signature(value, key)`	`Byte[]`	Assina o valor fornecido usando HMAC-SHA256 com a chave especificada.
`computeHmacSha256Signature(value, key)`	`Byte[]`	Assina o valor fornecido usando HMAC-SHA256 com a chave especificada.
`computeHmacSha256Signature(value, key, charset)`	`Byte[]`	Assina o valor fornecido usando HMAC-SHA256 com a chave e o conjunto de caracteres fornecidos.
`computeHmacSignature(algorithm, value, key)`	`Byte[]`	Calcule um código de autenticação de mensagem usando o algoritmo especificado na chave e no valor especificados.
`computeHmacSignature(algorithm, value, key)`	`Byte[]`	Calcule um código de autenticação de mensagem usando o algoritmo especificado na chave e no valor especificados.
`computeHmacSignature(algorithm, value, key, charset)`	`Byte[]`	Calcule um código de autenticação de mensagem usando o algoritmo especificado na chave e no valor especificados.
`computeRsaSha1Signature(value, key)`	`Byte[]`	Assina o valor fornecido usando RSA-SHA1 com a chave especificada.
`computeRsaSha1Signature(value, key, charset)`	`Byte[]`	Assina o valor fornecido usando RSA-SHA1 com a chave e o conjunto de caracteres fornecidos.
`computeRsaSha256Signature(value, key)`	`Byte[]`	Assina o valor fornecido usando RSA-SHA256 com a chave especificada.
`computeRsaSha256Signature(value, key, charset)`	`Byte[]`	Assina o valor fornecido usando RSA-SHA256 com a chave especificada.
`computeRsaSignature(algorithm, value, key)`	`Byte[]`	Assina o valor fornecido usando o algoritmo RSA especificado com a chave fornecida.
`computeRsaSignature(algorithm, value, key, charset)`	`Byte[]`	Assina o valor fornecido usando o algoritmo RSA especificado com a chave e o conjunto de caracteres fornecidos.
`formatDate(date, timeZone, format)`	`String`	Formata a data de acordo com a especificação descrita na classe SimpleDateFormat do Java SE.
`formatString(template, args)`	`String`	Realiza a formatação de string semelhante a `sprintf` usando strings de formato do tipo "%".
`getUuid()`	`String`	Receber um UUID como uma string (equivalente ao uso do método `java.util.UUID.randomUUID()`).
`gzip(blob)`	`Blob`	`gzip`: comprime os dados `Blob` fornecidos e os retorna em um novo objeto `Blob`.
`gzip(blob, name)`	`Blob`	`gzip`: comprime os dados `Blob` fornecidos e os retorna em um novo objeto `Blob`.
`newBlob(data)`	`Blob`	Crie um novo objeto Blob a partir de uma matriz de bytes.
`newBlob(data, contentType)`	`Blob`	Crie um novo objeto Blob a partir de uma matriz de bytes e um tipo de conteúdo.
`newBlob(data, contentType, name)`	`Blob`	Crie um novo objeto Blob usando uma matriz de bytes, um tipo de conteúdo e um nome.
`newBlob(data)`	`Blob`	Crie um novo objeto Blob a partir de uma string.
`newBlob(data, contentType)`	`Blob`	Crie um novo objeto Blob usando uma string e um tipo de conteúdo.
`newBlob(data, contentType, name)`	`Blob`	Crie um novo objeto Blob usando uma string, um tipo de conteúdo e um nome.
`parseCsv(csv)`	`String[][]`	Retorna uma representação de matriz 2D tabular de uma string CSV.
`parseCsv(csv, delimiter)`	`String[][]`	Retorna uma representação de matriz 2D tabular de uma string CSV usando um delimitador personalizado.
`parseDate(date, timeZone, format)`	`Date`	Analisa a data da string fornecida de acordo com a especificação descrita na classe `SimpleDateFormat` da edição padrão do Java.
`sleep(milliseconds)`	`void`	Entra em suspensão por um número especificado de milissegundos.
`ungzip(blob)`	`Blob`	Descompacta um objeto `Blob` e retorna um `Blob` que contém os dados descompactados.
`unzip(blob)`	`Blob[]`	Recebe um blob que representa um arquivo ZIP e retorna os arquivos de componentes.
`zip(blobs)`	`Blob`	Cria um novo objeto Blob, que é um arquivo ZIP contendo os dados dos Blobs transmitidos.
`zip(blobs, name)`	`Blob`	Cria um novo objeto Blob, que é um arquivo ZIP contendo os dados dos Blobs transmitidos.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`jsonParse(jsonString)`	`Object`	Retorna um objeto correspondente à string JSON transmitida.
`jsonStringify(obj)`	`String`	Retorna uma string JSON do objeto transmitido.

Documentação detalhada

`base64Decode(encoded)`

Decodifica uma string codificada em base 64 em uma matriz de bytes 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());

Parâmetros

Nome	Tipo	Descrição
`encoded`	`String`	Uma matriz de bytes de dados a serem decodificados.

Retornar

Byte[]: os dados brutos representados pelo argumento codificado em base-64 como uma matriz de bytes.

`base64Decode(encoded, charset)`

Decodifica uma string codificada em base64 em uma matriz de bytes em um conjunto de caracteres específico.

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

Parâmetros

Nome	Tipo	Descrição
`encoded`	`String`	A string de dados a ser decodificada.
`charset`	`Charset`	Um `Charset` que especifica o conjunto de caracteres da entrada.

Retornar

Byte[]: os dados brutos representados pelo argumento codificado em base-64 como uma matriz de bytes.

`base64DecodeWebSafe(encoded)`

Decodifica uma string codificada em base64 para a Web em uma matriz de bytes 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());

Parâmetros

Nome	Tipo	Descrição
`encoded`	`String`	Uma matriz de bytes de dados seguros para a Web a serem decodificados.

Retornar

Byte[]: os dados brutos representados pelo argumento codificado em base-64 para a Web como uma matriz de bytes.

`base64DecodeWebSafe(encoded, charset)`

Decodifica uma string codificada em base64 para a Web em uma matriz de bytes em um conjunto de caracteres específico.

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

Parâmetros

Nome	Tipo	Descrição
`encoded`	`String`	A string de dados seguros para a Web a ser decodificada.
`charset`	`Charset`	Um `Charset` que especifica o conjunto de caracteres da entrada.

Retornar

Byte[]: os dados brutos representados pelo argumento codificado em base-64 para a Web como uma matriz de bytes.

`base64Encode(data)`

Gera uma string codificada em base-64 a partir da matriz de bytes especificada. A Base64 é uma codificação comum aceita por várias ferramentas que não podem aceitar dados binários. A Base64 é comumente usada em protocolos da Internet, como e-mail, HTTP ou em documentos 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);

Parâmetros

Nome	Tipo	Descrição
`data`	`Byte[]`	Um byte[] de dados a serem codificados.

Retornar

String: a representação codificada em base64 dos dados transmitidos.

`base64Encode(data)`

Gera uma string codificada em base64 com base na string especificada. A Base64 é uma codificação comum aceita por várias ferramentas que não podem aceitar dados binários. A Base64 é comumente usada em protocolos da Internet, como e-mail, HTTP ou em documentos XML.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`String`	A string a ser codificada.

Retornar

String: a representação codificada em base64 da string de entrada.

`base64Encode(data, charset)`

Gera uma string codificada em base64 a partir da string especificada em um conjunto de caracteres específico. Um conjunto de caracteres é uma forma de codificar caracteres para que eles possam ser codificados. Elas geralmente são feitas em um formato binário, que geralmente pode ser incompatível com determinados protocolos de transmissão de dados. Para tornar os dados compatíveis, eles geralmente são codificados na base 64, que é uma codificação comum aceita por várias ferramentas que não podem aceitar dados binários. A Base64 é comumente usada em protocolos da Internet, como e-mail, HTTP ou em documentos 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);

Parâmetros

Nome	Tipo	Descrição
`data`	`String`	A string de dados a ser codificada.
`charset`	`Charset`	Um `Charset` que especifica o conjunto de caracteres da entrada.

Retornar

String: a representação codificada em base-64 da string de entrada com o Charset fornecido.

`base64EncodeWebSafe(data)`

Gera uma string codificada em base64 para a Web a partir da matriz de bytes especificada. A Base64 é uma codificação comum aceita por várias ferramentas que não podem aceitar dados binários. O Base 64 seguro para a Web é comumente usado em protocolos da Internet, como e-mail, HTTP ou em documentos 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);

Parâmetros

Nome	Tipo	Descrição
`data`	`Byte[]`	Uma matriz de bytes de dados a serem codificados.

Retornar

String: a representação codificada em base64 segura para a Web dos dados transmitidos.

`base64EncodeWebSafe(data)`

Gera uma string codificada em base64 para a Web a partir da string especificada. A Base64 é uma codificação comum aceita por várias ferramentas que não podem aceitar dados binários. O Base 64 seguro para a Web é comumente usado em protocolos da Internet, como e-mail, HTTP ou em documentos XML.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`String`	A string a ser codificada.

Retornar

String: a representação codificada em base64 e otimizada para a Web da string de entrada.

`base64EncodeWebSafe(data, charset)`

Gera uma string codificada em base-64 segura para a Web a partir da string especificada em um conjunto de caracteres específico. Um Charset é uma maneira de codificar caracteres para que eles possam ser codificados. Elas geralmente são feitas em um formato binário, que geralmente pode ser incompatível com determinados protocolos de transmissão de dados. Para tornar os dados compatíveis, eles geralmente são codificados em base 64, que é uma codificação comum aceita por várias ferramentas que não podem aceitar dados binários. O Base 64 seguro para a Web é usado com frequência em protocolos da Internet, como e-mail, HTTP ou em documentos 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);

Parâmetros

Nome	Tipo	Descrição
`data`	`String`	A string de dados a ser codificada.
`charset`	`Charset`	Um `Charset` que especifica o conjunto de caracteres da entrada.

Retornar

String: a representação codificada em base64 segura para a Web da string de entrada com o Charset fornecido.

`computeDigest(algorithm, value)`

Calcula um resumo usando o algoritmo especificado no valor Byte[] especificado.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`DigestAlgorithm`	Um `DigestAlgorithm` a ser usado.
`value`	`Byte[]`	Um valor de string de entrada para calcular um resumo.

Retornar

Byte[]: um byte[] que representa o resumo de saída.

`computeDigest(algorithm, value)`

Calcula um resumo usando o algoritmo especificado no valor String especificado.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`DigestAlgorithm`	Um `DigestAlgorithm` a ser usado.
`value`	`String`	Um valor de string de entrada para calcular um resumo.

Retornar

Byte[]: um byte[] que representa o resumo de saída.

`computeDigest(algorithm, value, charset)`

Calcule um resumo usando o algoritmo especificado no valor String especificado com o conjunto de caracteres fornecido.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`DigestAlgorithm`	Um `DigestAlgorithm` a ser usado.
`value`	`String`	Um valor de string de entrada para calcular um resumo.
`charset`	`Charset`	Um `Charset` que representa o conjunto de caracteres de entrada.

Retornar

Byte[]: um byte[] que representa o resumo de saída.

`computeHmacSha256Signature(value, key)`

Assina o valor fornecido usando HMAC-SHA256 com a chave especificada.

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

Parâmetros

Nome	Tipo	Descrição
`value`	`Byte[]`	O valor de entrada para gerar um hash.
`key`	`Byte[]`	Uma chave para gerar o hash.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeHmacSha256Signature(value, key)`

Assina o valor fornecido usando HMAC-SHA256 com a chave especificada.

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave para gerar o hash.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeHmacSha256Signature(value, key, charset)`

Assina o valor fornecido usando HMAC-SHA256 com a chave e o conjunto de caracteres fornecidos.

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave para gerar o hash.
`charset`	`Charset`	Um `Charset` que representa o conjunto de caracteres de entrada.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeHmacSignature(algorithm, value, key)`

Calcule um código de autenticação de mensagem usando o algoritmo especificado na chave e no valor especificados.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`MacAlgorithm`	Um algoritmo `MacAlgorithm` a ser usado para gerar um hash do valor de entrada.
`value`	`Byte[]`	O valor de entrada para gerar um hash.
`key`	`Byte[]`	Uma chave para gerar o hash.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeHmacSignature(algorithm, value, key)`

Calcule um código de autenticação de mensagem usando o algoritmo especificado na chave e no valor especificados.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`MacAlgorithm`	Um algoritmo `MacAlgorithm` a ser usado para gerar um hash do valor de entrada.
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave para gerar o hash.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

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

Calcule um código de autenticação de mensagem usando o algoritmo especificado na chave e no valor especificados.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`MacAlgorithm`	Um algoritmo `MacAlgorithm` a ser usado para gerar um hash do valor de entrada.
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave para gerar o hash.
`charset`	`Charset`	Um `Charset` que representa o conjunto de caracteres de entrada.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeRsaSha1Signature(value, key)`

Assina o valor fornecido usando RSA-SHA1 com a chave especificada.

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave formatada em PEM para gerar a assinatura.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeRsaSha1Signature(value, key, charset)`

Assina o valor fornecido usando RSA-SHA1 com a chave e o conjunto de caracteres fornecidos.

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave formatada em PEM para gerar a assinatura.
`charset`	`Charset`	Um `Charset` que representa o conjunto de caracteres de entrada.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeRsaSha256Signature(value, key)`

Assina o valor fornecido usando RSA-SHA256 com a chave especificada.

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave formatada em PEM para gerar a assinatura.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeRsaSha256Signature(value, key, charset)`

Assina o valor fornecido usando RSA-SHA256 com a chave especificada.

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

Parâmetros

Nome	Tipo	Descrição
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave formatada em PEM para gerar a assinatura.
`charset`	`Charset`	Um `Charset` que representa o conjunto de caracteres de entrada.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`computeRsaSignature(algorithm, value, key)`

Assina o valor fornecido usando o algoritmo RSA especificado com a chave fornecida.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`RsaAlgorithm`	Um algoritmo `RsaAlgorithm` a ser usado para gerar um hash do valor de entrada.
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave formatada em PEM para gerar a assinatura.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

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

Assina o valor fornecido usando o algoritmo RSA especificado com a chave e o conjunto de caracteres fornecidos.

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

Parâmetros

Nome	Tipo	Descrição
`algorithm`	`RsaAlgorithm`	Um algoritmo `RsaAlgorithm` a ser usado para gerar um hash do valor de entrada.
`value`	`String`	O valor de entrada para gerar um hash.
`key`	`String`	Uma chave formatada em PEM para gerar a assinatura.
`charset`	`Charset`	Um `Charset` que representa o conjunto de caracteres de entrada.

Retornar

Byte[]: um byte[] que representa a assinatura de saída.

`formatDate(date, timeZone, format)`

Formata a data de acordo com a especificação descrita na classe SimpleDateFormat do Java SE. Acesse a especificação em 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);

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	Um `Date` para formatar como uma string.
`timeZone`	`String`	Fuso horário de saída do resultado.
`format`	`String`	Um formato de acordo com a especificação `SimpleDateFormat`.

Retornar

String: a data de entrada como uma string formatada.

`formatString(template, args)`

Realiza a formatação de string semelhante a sprintf usando strings de formato do tipo "%".

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

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

Parâmetros

Nome	Tipo	Descrição
`template`	`String`	A string de formato que controla o que é retornado.
`args`	`Object...`	Objetos a serem usados para preencher os marcadores de posição "%" no modelo.

Retornar

String: a string formatada.

`getUuid()`

Receber um UUID como uma string (equivalente ao uso do método java.util.UUID.randomUUID()). Não há garantia de que esse identificador seja exclusivo em todos os tempos e espaços. Portanto, não use em situações em que a exclusividade garantida é necessária.

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

Retornar

String: uma representação de string do UUID.

`gzip(blob)`

gzip: comprime os dados Blob fornecidos e os retorna em um novo objeto Blob.

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

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

Parâmetros

Nome	Tipo	Descrição
`blob`	`BlobSource`	Um objeto `Blob` para compactar usando `gzip`.

Retornar

Blob: um novo Blob que contém os dados compactados.

`gzip(blob, name)`

gzip: comprime os dados Blob fornecidos e os retorna em um novo objeto Blob. Essa versão do método permite que um nome de arquivo seja especificado.

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

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

Parâmetros

Nome	Tipo	Descrição
`blob`	`BlobSource`	Um objeto `Blob` para compactar usando `gzip`.
`name`	`String`	O nome do arquivo `gzip` a ser criado.

Retornar

Blob: um novo Blob que contém os dados compactados.

`newBlob(data)`

Crie um novo objeto Blob a partir de uma matriz de bytes. Blobs são usados em muitas APIs do Apps Script que usam dados binários como entrada.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`Byte[]`	Os bytes do blob.

Retornar

Blob: o Blob recém-criado.

`newBlob(data, contentType)`

Crie um novo objeto Blob a partir de uma matriz de bytes e um tipo de conteúdo. Blobs são usados em muitas APIs do Apps Script que recebem dados binários como entrada.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`Byte[]`	Os bytes do blob.
`contentType`	`String`	O tipo de conteúdo do blob pode ser `null`.

Retornar

Blob: o Blob recém-criado.

`newBlob(data, contentType, name)`

Crie um novo objeto Blob usando uma matriz de bytes, um tipo de conteúdo e um nome. Blobs são usados em muitas APIs do Apps Script que recebem dados binários como entrada.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`Byte[]`	Os bytes do blob.
`contentType`	`String`	- O tipo de conteúdo do blob pode ser `null`.
`name`	`String`	O nome do blob pode ser `null`.

Retornar

Blob: o Blob recém-criado.

`newBlob(data)`

Crie um novo objeto Blob a partir de uma string. Blobs são usados em muitas APIs do Apps Script que usam dados binários como entrada.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`String`	A string do blob, presumida como UTF-8.

Retornar

Blob: o Blob recém-criado.

`newBlob(data, contentType)`

Crie um novo objeto Blob usando uma string e um tipo de conteúdo. Blobs são usados em muitas APIs do Apps Script que recebem dados binários como entrada.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`String`	A string do blob, presumida como UTF-8.
`contentType`	`String`	O tipo de conteúdo do blob pode ser `null`.

Retornar

Blob: o Blob recém-criado.

`newBlob(data, contentType, name)`

Crie um novo objeto Blob usando uma string, um tipo de conteúdo e um nome. Blobs são usados em muitas APIs do Apps Script que recebem dados binários como entrada.

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

Parâmetros

Nome	Tipo	Descrição
`data`	`String`	A string do blob, presumida como UTF-8.
`contentType`	`String`	O tipo de conteúdo do blob pode ser `null`.
`name`	`String`	O nome do blob pode ser `null`.

Retornar

Blob: o Blob recém-criado.

`parseCsv(csv)`

Retorna uma representação de matriz 2D tabular de uma string 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);

Parâmetros

Nome	Tipo	Descrição
`csv`	`String`	Uma string que contém dados únicos ou de várias linhas no formato CSV (valores separados por vírgula).

Retornar

String[][]: uma matriz bidimensional que contém os valores na string CSV.

`parseCsv(csv, delimiter)`

Retorna uma representação de matriz 2D tabular de uma string CSV usando um delimitador personalizado.

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

Parâmetros

Nome	Tipo	Descrição
`csv`	`String`	Uma string que contém dados únicos ou de várias linhas no formato CSV (valores separados por vírgula).
`delimiter`	`Char`	Entre valores.

Retornar

String[][]: uma matriz bidimensional que contém os valores na string CSV.

`parseDate(date, timeZone, format)`

Analisa a data da string fornecida de acordo com a especificação descrita na classe SimpleDateFormat da edição padrão do Java. Para saber mais, consulte a classe SimpleDateFormat do Java.

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

Parâmetros

Nome	Tipo	Descrição
`date`	`String`	Um valor de string para analisar como uma data.
`timeZone`	`String`	O fuso horário de saída.
`format`	`String`	O formato de data de acordo com a especificação `SimpleDateFormat`.

Retornar

Date: a string de entrada como uma data.

`sleep(milliseconds)`

Entra em suspensão por um número especificado de milissegundos. Coloca o script em suspensão imediatamente pelo número especificado de milissegundos. O valor máximo permitido é 300000 (ou 5 minutos).

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

Parâmetros

Nome	Tipo	Descrição
`milliseconds`	`Integer`	O número de milissegundos de suspensão.

`ungzip(blob)`

Descompacta um objeto Blob e retorna um Blob que contém os dados descompactados.

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

Parâmetros

Nome	Tipo	Descrição
`blob`	`BlobSource`	O `Blob` de dados compactados.

Retornar

Blob: um Blob que representa os dados descompactados.

`unzip(blob)`

Recebe um blob que representa um arquivo ZIP e retorna os arquivos de componentes.

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

Parâmetros

Nome	Tipo	Descrição
`blob`	`BlobSource`	O blob do arquivo ZIP.

Retornar

Blob[]: um Blob[] que representa os blobs de componentes, cada um nomeado com o caminho completo dentro do zip.

`zip(blobs)`

Cria um novo objeto Blob, que é um arquivo ZIP contendo os dados dos Blobs transmitidos.

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]);

Parâmetros

Nome	Tipo	Descrição
`blobs`	`BlobSource[]`	Uma matriz de blobs para compactar.

Retornar

Blob: um novo blob que contém as entradas como um arquivo.

`zip(blobs, name)`

Cria um novo objeto Blob, que é um arquivo ZIP contendo os dados dos Blobs transmitidos. Essa versão do método permite que um nome de arquivo seja especificado.

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');

Parâmetros

Nome	Tipo	Descrição
`blobs`	`BlobSource[]`	Uma matriz de blobs para compactar.
`name`	`String`	O nome do arquivo ZIP a ser criado.

Retornar

Blob: um novo blob que contém as entradas como um arquivo.

Métodos obsoletos

`jsonParse(jsonString)`

Obsoleto. Substituído por JSON.parse() em novembro de 2013

Retorna um objeto correspondente à string JSON transmitida.

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

Parâmetros

Nome	Tipo	Descrição
`jsonString`	`String`	Uma representação de string de um objeto JavaScript a ser desserializado.

Retornar

Object: uma representação de objeto JavaScript da entrada.

`jsonStringify(obj)`

Obsoleto. Substituído por JSON.stringify() em novembro de 2013

Retorna uma string JSON do objeto transmitido.

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

Parâmetros

Nome	Tipo	Descrição
`obj`	`Object`	o objeto JavaScript a ser serializado em JSON

Retornar

String: um objeto JavaScript serializado JSON