Class Utilities

Ce service fournit des utilitaires pour l'encodage/le décodage de chaînes, la mise en forme de dates, la manipulation de JSON et d'autres tâches diverses.

Propriétés

Propriété	Type	Description
`Charset`	`Charset`
`DigestAlgorithm`	`DigestAlgorithm`
`MacAlgorithm`	`MacAlgorithm`
`RsaAlgorithm`	`RsaAlgorithm`

Méthodes

Méthode	Type renvoyé	Brève description
`base64Decode(encoded)`	`Byte[]`	Décode une chaîne encodée en base64 en un tableau d'octets UTF-8.
`base64Decode(encoded, charset)`	`Byte[]`	Décode une chaîne encodée en base64 en un tableau d'octets dans un jeu de caractères spécifique.
`base64DecodeWebSafe(encoded)`	`Byte[]`	Décode une chaîne encodée en base64 sécurisée pour le Web en un tableau d'octets UTF-8.
`base64DecodeWebSafe(encoded, charset)`	`Byte[]`	Décode une chaîne encodée en base64 sécurisée pour le Web en un tableau d'octets dans un jeu de caractères spécifique.
`base64Encode(data)`	`String`	Génère une chaîne encodée en base64 à partir du tableau d'octets donné.
`base64Encode(data)`	`String`	Génère une chaîne encodée en base64 à partir de la chaîne donnée.
`base64Encode(data, charset)`	`String`	Génère une chaîne encodée en base64 à partir de la chaîne donnée dans un jeu de caractères spécifique.
`base64EncodeWebSafe(data)`	`String`	Génère une chaîne encodée en base64 sécurisée pour le Web à partir du tableau d'octets donné.
`base64EncodeWebSafe(data)`	`String`	Génère une chaîne encodée en base64 sécurisée pour le Web à partir de la chaîne donnée.
`base64EncodeWebSafe(data, charset)`	`String`	Génère une chaîne encodée au format base64 adapté au Web à partir de la chaîne donnée dans un jeu de caractères spécifique.
`computeDigest(algorithm, value)`	`Byte[]`	Calculez un récapitulatif à l'aide de l'algorithme spécifié sur la valeur `Byte[]` spécifiée.
`computeDigest(algorithm, value)`	`Byte[]`	Calculez un récapitulatif à l'aide de l'algorithme spécifié sur la valeur `String` spécifiée.
`computeDigest(algorithm, value, charset)`	`Byte[]`	Calcule un récapitulatif à l'aide de l'algorithme spécifié sur la valeur `String` spécifiée avec le jeu de caractères donné.
`computeHmacSha256Signature(value, key)`	`Byte[]`	Signe la valeur fournie à l'aide de HMAC-SHA256 avec la clé indiquée.
`computeHmacSha256Signature(value, key)`	`Byte[]`	Signe la valeur fournie à l'aide de HMAC-SHA256 avec la clé indiquée.
`computeHmacSha256Signature(value, key, charset)`	`Byte[]`	Signe la valeur fournie à l'aide de HMAC-SHA256 avec la clé et le jeu de caractères indiqués.
`computeHmacSignature(algorithm, value, key)`	`Byte[]`	Calculez un code d'authentification de message à l'aide de l'algorithme spécifié sur la clé et la valeur spécifiées.
`computeHmacSignature(algorithm, value, key)`	`Byte[]`	Calculez un code d'authentification de message à l'aide de l'algorithme spécifié sur la clé et la valeur spécifiées.
`computeHmacSignature(algorithm, value, key, charset)`	`Byte[]`	Calculez un code d'authentification de message à l'aide de l'algorithme spécifié sur la clé et la valeur spécifiées.
`computeRsaSha1Signature(value, key)`	`Byte[]`	Signe la valeur fournie à l'aide de RSA-SHA1 avec la clé donnée.
`computeRsaSha1Signature(value, key, charset)`	`Byte[]`	Signe la valeur fournie à l'aide de RSA-SHA1 avec la clé et le jeu de caractères indiqués.
`computeRsaSha256Signature(value, key)`	`Byte[]`	Signe la valeur fournie à l'aide de RSA-SHA256 avec la clé donnée.
`computeRsaSha256Signature(value, key, charset)`	`Byte[]`	Signe la valeur fournie à l'aide de RSA-SHA256 avec la clé donnée.
`computeRsaSignature(algorithm, value, key)`	`Byte[]`	Signe la valeur fournie à l'aide de l'algorithme RSA spécifié avec la clé donnée.
`computeRsaSignature(algorithm, value, key, charset)`	`Byte[]`	Signe la valeur fournie à l'aide de l'algorithme RSA spécifié avec la clé et le jeu de caractères indiqués.
`formatDate(date, timeZone, format)`	`String`	Met en forme la date selon les spécifications décrites dans la classe Java SE SimpleDateFormat.
`formatString(template, args)`	`String`	Effectue une mise en forme de chaîne de type `sprintf` à l'aide de chaînes de mise en forme de type "%".
`getUuid()`	`String`	Obtenez un UUID sous forme de chaîne (équivalent à l'utilisation de la méthode `java.util.UUID.randomUUID()`).
`gzip(blob)`	`Blob`	`gzip` compresse les données `Blob` fournies et les renvoie dans un nouvel objet `Blob`.
`gzip(blob, name)`	`Blob`	`gzip` compresse les données `Blob` fournies et les renvoie dans un nouvel objet `Blob`.
`newBlob(data)`	`Blob`	Crée un objet Blob à partir d'un tableau d'octets.
`newBlob(data, contentType)`	`Blob`	Crée un objet Blob à partir d'un tableau d'octets et d'un type de contenu.
`newBlob(data, contentType, name)`	`Blob`	Créez un objet Blob à partir d'un tableau d'octets, d'un type de contenu et d'un nom.
`newBlob(data)`	`Blob`	Créez un objet Blob à partir d'une chaîne.
`newBlob(data, contentType)`	`Blob`	Crée un objet Blob à partir d'une chaîne et d'un type de contenu.
`newBlob(data, contentType, name)`	`Blob`	Créez un objet Blob à partir d'une chaîne, d'un type de contenu et d'un nom.
`parseCsv(csv)`	`String[][]`	Renvoie une représentation tabulaire sous forme de tableau 2D d'une chaîne CSV.
`parseCsv(csv, delimiter)`	`String[][]`	Renvoie une représentation tabulaire bidimensionnelle d'une chaîne CSV à l'aide d'un délimiteur personnalisé.
`parseDate(date, timeZone, format)`	`Date`	Analyse la chaîne de date fournie selon les spécifications décrites dans la classe `SimpleDateFormat` de Java Standard Edition.
`sleep(milliseconds)`	`void`	Dort pendant le nombre de millisecondes spécifié.
`ungzip(blob)`	`Blob`	Décompresse un objet `Blob` et renvoie un `Blob` contenant les données décompressées.
`unzip(blob)`	`Blob[]`	Prend un blob représentant un fichier ZIP et renvoie ses fichiers composants.
`zip(blobs)`	`Blob`	Crée un objet Blob qui est un fichier ZIP contenant les données des objets Blob transmis.
`zip(blobs, name)`	`Blob`	Crée un objet Blob qui est un fichier ZIP contenant les données des objets Blob transmis.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`jsonParse(jsonString)`	`Object`	Renvoie un objet correspondant à la chaîne JSON transmise.
`jsonStringify(obj)`	`String`	Renvoie une chaîne JSON de l'objet transmis.

Documentation détaillée

`base64Decode(encoded)`

Décode une chaîne encodée en base64 en un tableau d'octets 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 you want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

Paramètres

Nom	Type	Description
`encoded`	`String`	Tableau d'octets de données à décoder.

Renvois

Byte[] : données brutes représentées par l'argument encodé en base64 sous forme de tableau d'octets.

`base64Decode(encoded, charset)`

Décode une chaîne encodée en base64 en un tableau d'octets dans un jeu de caractères spécifique.

// 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 you want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

Paramètres

Nom	Type	Description
`encoded`	`String`	Chaîne de données à décoder.
`charset`	`Charset`	`Charset` spécifiant le jeu de caractères de l'entrée.

Renvois

Byte[] : données brutes représentées par l'argument encodé en base64 sous forme de tableau d'octets.

`base64DecodeWebSafe(encoded)`

Décode une chaîne encodée en base64 sécurisée pour le Web en un tableau d'octets 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 you want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

Paramètres

Nom	Type	Description
`encoded`	`String`	Tableau d'octets de données Web sécurisées à décoder.

Renvois

Byte[] : données brutes représentées par l'argument encodé en base64 sécurisé pour le Web sous forme de tableau d'octets.

`base64DecodeWebSafe(encoded, charset)`

Décode une chaîne encodée en base64 sécurisée pour le Web en un tableau d'octets dans un jeu de caractères spécifique.

// 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 you want a String instead of a byte array:
// This logs the original "Google グループ"
Logger.log(Utilities.newBlob(decoded).getDataAsString());

Paramètres

Nom	Type	Description
`encoded`	`String`	Chaîne de données Web sécurisées à décoder.
`charset`	`Charset`	`Charset` spécifiant le jeu de caractères de l'entrée.

Renvois

Byte[] : données brutes représentées par l'argument encodé en base64 sécurisé pour le Web sous forme de tableau d'octets.

`base64Encode(data)`

Génère une chaîne encodée en base64 à partir du tableau d'octets donné. Base64 est un encodage courant accepté par divers outils qui ne peuvent pas accepter les données binaires. Base64 est couramment utilisé dans les protocoles Internet tels que les e-mails, HTTP ou dans les documents 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);

Paramètres

Nom	Type	Description
`data`	`Byte[]`	Tableau d'octets de données à encoder.

Renvois

String : représentation des données transmises encodée en base64.

`base64Encode(data)`

Génère une chaîne encodée en base64 à partir de la chaîne donnée. Base64 est un encodage courant accepté par divers outils qui ne peuvent pas accepter les données binaires. Base64 est couramment utilisé dans les protocoles Internet tels que les e-mails, HTTP ou dans les documents XML.

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

Paramètres

Nom	Type	Description
`data`	`String`	Chaîne à encoder.

Renvois

String : représentation de la chaîne d'entrée encodée en base64.

`base64Encode(data, charset)`

Génère une chaîne encodée en base64 à partir de la chaîne donnée dans un jeu de caractères spécifique. Un jeu de caractères est un moyen d'encoder des caractères pour qu'ils puissent être encodés. Elles sont généralement effectuées dans un format binaire, qui peut généralement être incompatible avec certains protocoles de transmission de données. Pour rendre les données compatibles, elles sont généralement encodées en base64, qui est un encodage courant accepté par divers outils qui ne peuvent pas accepter les données binaires. Base64 est couramment utilisé dans les protocoles Internet tels que les e-mails, HTTP ou dans les documents 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);

Paramètres

Nom	Type	Description
`data`	`String`	Chaîne de données à encoder.
`charset`	`Charset`	`Charset` spécifiant le jeu de caractères de l'entrée.

Renvois

String : représentation encodée en base64 de la chaîne d'entrée avec le Charset donné.

`base64EncodeWebSafe(data)`

Génère une chaîne encodée en base64 sécurisée pour le Web à partir du tableau d'octets donné. Base64 est un encodage courant accepté par divers outils qui ne peuvent pas accepter les données binaires. Le format Base64 Web-safe est couramment utilisé dans les protocoles Internet tels que les e-mails, HTTP ou dans les documents 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);

Paramètres

Nom	Type	Description
`data`	`Byte[]`	Tableau d'octets de données à encoder.

Renvois

String : représentation des données transmises encodées en base64 sécurisé pour le Web.

`base64EncodeWebSafe(data)`

Génère une chaîne encodée en base64 sécurisée pour le Web à partir de la chaîne donnée. Base64 est un encodage courant accepté par divers outils qui ne peuvent pas accepter les données binaires. Le format Base64 Web-safe est couramment utilisé dans les protocoles Internet tels que les e-mails, HTTP ou dans les documents XML.

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

Paramètres

Nom	Type	Description
`data`	`String`	Chaîne à encoder.

Renvois

String : représentation encodée en base64 adaptée au Web de la chaîne d'entrée.

`base64EncodeWebSafe(data, charset)`

Génère une chaîne encodée au format base64 adapté au Web à partir de la chaîne donnée dans un jeu de caractères spécifique. Un jeu de caractères est une façon d'encoder des caractères pour qu'ils puissent être encodés. Ces opérations sont généralement effectuées dans un format binaire, qui peut être incompatible avec certains protocoles de transmission de données. Pour rendre les données compatibles, elles sont généralement encodées en base64, qui est un encodage courant accepté par divers outils qui ne peuvent pas accepter les données binaires. Le format Base64 Web-safe est couramment utilisé dans les protocoles Internet tels que les e-mails, HTTP ou dans les documents 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);

Paramètres

Nom	Type	Description
`data`	`String`	Chaîne de données à encoder.
`charset`	`Charset`	`Charset` spécifiant le jeu de caractères de l'entrée.

Renvois

String : représentation de la chaîne d'entrée encodée en base64 et sécurisée pour le Web avec le Charset donné.

`computeDigest(algorithm, value)`

Calculez un récapitulatif à l'aide de l'algorithme spécifié sur la valeur Byte[] spécifiée.

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

Paramètres

Nom	Type	Description
`algorithm`	`DigestAlgorithm`	Un `DigestAlgorithm` à utiliser.
`value`	`Byte[]`	Valeur de chaîne d'entrée pour laquelle calculer un résumé.

Renvois

Byte[] : byte[] représentant le résumé de sortie.

`computeDigest(algorithm, value)`

Calculez un récapitulatif à l'aide de l'algorithme spécifié sur la valeur String spécifiée.

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

Paramètres

Nom	Type	Description
`algorithm`	`DigestAlgorithm`	Un `DigestAlgorithm` à utiliser.
`value`	`String`	Valeur de chaîne d'entrée pour laquelle calculer un résumé.

Renvois

Byte[] : byte[] représentant le résumé de sortie.

`computeDigest(algorithm, value, charset)`

Calcule un récapitulatif à l'aide de l'algorithme spécifié sur la valeur String spécifiée avec le jeu de caractères donné.

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

Paramètres

Nom	Type	Description
`algorithm`	`DigestAlgorithm`	Un `DigestAlgorithm` à utiliser.
`value`	`String`	Valeur de chaîne d'entrée pour laquelle calculer un résumé.
`charset`	`Charset`	`Charset` représentant le jeu de caractères d'entrée.

Renvois

Byte[] : byte[] représentant le résumé de sortie.

`computeHmacSha256Signature(value, key)`

Signe la valeur fournie à l'aide de HMAC-SHA256 avec la clé indiquée.

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

Paramètres

Nom	Type	Description
`value`	`Byte[]`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`Byte[]`	Clé à utiliser pour générer le hachage.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeHmacSha256Signature(value, key)`

Signe la valeur fournie à l'aide de HMAC-SHA256 avec la clé indiquée.

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

Paramètres

Nom	Type	Description
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé à utiliser pour générer le hachage.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeHmacSha256Signature(value, key, charset)`

Signe la valeur fournie à l'aide de HMAC-SHA256 avec la clé et le jeu de caractères indiqués.

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

Paramètres

Nom	Type	Description
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé à utiliser pour générer le hachage.
`charset`	`Charset`	`Charset` représentant le jeu de caractères d'entrée.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeHmacSignature(algorithm, value, key)`

Calculez un code d'authentification de message à l'aide de l'algorithme spécifié sur la clé et la valeur spécifiées.

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

Paramètres

Nom	Type	Description
`algorithm`	`MacAlgorithm`	Algorithme `MacAlgorithm` à utiliser pour hacher la valeur d'entrée.
`value`	`Byte[]`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`Byte[]`	Clé à utiliser pour générer le hachage.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeHmacSignature(algorithm, value, key)`

Calculez un code d'authentification de message à l'aide de l'algorithme spécifié sur la clé et la valeur spécifiées.

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

Paramètres

Nom	Type	Description
`algorithm`	`MacAlgorithm`	Algorithme `MacAlgorithm` à utiliser pour hacher la valeur d'entrée.
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé à utiliser pour générer le hachage.

Renvois

Byte[] : byte[] représentant la signature de sortie.

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

Calculez un code d'authentification de message à l'aide de l'algorithme spécifié sur la clé et la valeur spécifiées.

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

Paramètres

Nom	Type	Description
`algorithm`	`MacAlgorithm`	Algorithme `MacAlgorithm` à utiliser pour hacher la valeur d'entrée.
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé à utiliser pour générer le hachage.
`charset`	`Charset`	`Charset` représentant le jeu de caractères d'entrée.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeRsaSha1Signature(value, key)`

Signe la valeur fournie à l'aide de RSA-SHA1 avec la clé donnée.

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

Paramètres

Nom	Type	Description
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé au format PEM à utiliser pour générer la signature.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeRsaSha1Signature(value, key, charset)`

Signe la valeur fournie à l'aide de RSA-SHA1 avec la clé et le jeu de caractères indiqués.

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

Paramètres

Nom	Type	Description
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé au format PEM à utiliser pour générer la signature.
`charset`	`Charset`	`Charset` représentant le jeu de caractères d'entrée.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeRsaSha256Signature(value, key)`

Signe la valeur fournie à l'aide de RSA-SHA256 avec la clé donnée.

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

Paramètres

Nom	Type	Description
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé au format PEM à utiliser pour générer la signature.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeRsaSha256Signature(value, key, charset)`

Signe la valeur fournie à l'aide de RSA-SHA256 avec la clé donnée.

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

Paramètres

Nom	Type	Description
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé au format PEM à utiliser pour générer la signature.
`charset`	`Charset`	`Charset` représentant le jeu de caractères d'entrée.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`computeRsaSignature(algorithm, value, key)`

Signe la valeur fournie à l'aide de l'algorithme RSA spécifié avec la clé donnée.

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

Paramètres

Nom	Type	Description
`algorithm`	`RsaAlgorithm`	Algorithme `RsaAlgorithm` à utiliser pour hacher la valeur d'entrée.
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé au format PEM à utiliser pour générer la signature.

Renvois

Byte[] : byte[] représentant la signature de sortie.

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

Signe la valeur fournie à l'aide de l'algorithme RSA spécifié avec la clé et le jeu de caractères indiqués.

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

Paramètres

Nom	Type	Description
`algorithm`	`RsaAlgorithm`	Algorithme `RsaAlgorithm` à utiliser pour hacher la valeur d'entrée.
`value`	`String`	Valeur d'entrée pour laquelle générer un hachage.
`key`	`String`	Clé au format PEM à utiliser pour générer la signature.
`charset`	`Charset`	`Charset` représentant le jeu de caractères d'entrée.

Renvois

Byte[] : byte[] représentant la signature de sortie.

`formatDate(date, timeZone, format)`

Met en forme la date selon les spécifications décrites dans la classe Java SE SimpleDateFormat. Veuillez consulter la spécification à l'adresse 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);

Paramètres

Nom	Type	Description
`date`	`Date`	`Date` à mettre en forme sous forme de chaîne.
`timeZone`	`String`	Fuseau horaire de sortie du résultat.
`format`	`String`	Format conforme à la spécification `SimpleDateFormat`.

Renvois

String : date d'entrée sous forme de chaîne mise en forme.

`formatString(template, args)`

Effectue une mise en forme de chaîne de type sprintf à l'aide de chaînes de mise en forme de type "%".

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

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

Paramètres

Nom	Type	Description
`template`	`String`	Chaîne de format qui contrôle ce qui est renvoyé.
`args`	`Object...`	Objets à utiliser pour remplir les espaces réservés "%" du modèle.

Renvois

String : chaîne formatée.

`getUuid()`

Obtenez un UUID sous forme de chaîne (équivalent à l'utilisation de la méthode java.util.UUID.randomUUID()). Il n'est pas garanti que cet identifiant soit unique dans l'espace et dans le temps. Par conséquent, ne l'utilisez pas dans les situations où l'unicité garantie est requise.

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

Renvois

String : représentation sous forme de chaîne de l'UUID.

`gzip(blob)`

gzip compresse les données Blob fournies et les renvoie dans un nouvel objet Blob.

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

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

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	Objet `Blob` à compresser à l'aide de `gzip`.

Renvois

Blob : un nouvel Blob contenant les données compressées.

`gzip(blob, name)`

gzip compresse les données Blob fournies et les renvoie dans un nouvel objet Blob. Cette version de la méthode permet de spécifier un nom de fichier.

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

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

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	Objet `Blob` à compresser à l'aide de `gzip`.
`name`	`String`	Nom du fichier `gzip` à créer.

Renvois

Blob : un nouvel Blob contenant les données compressées.

`newBlob(data)`

Crée un objet Blob à partir d'un tableau d'octets. Les blobs sont utilisés dans de nombreuses API Apps Script qui acceptent les données binaires en entrée.

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

Paramètres

Nom	Type	Description
`data`	`Byte[]`	Octets de l'objet blob.

Renvois

Blob : Blob nouvellement créé.

`newBlob(data, contentType)`

Crée un objet Blob à partir d'un tableau d'octets et d'un type de contenu. Les blobs sont utilisés dans de nombreuses API Apps Script qui acceptent les données binaires en entrée.

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

Paramètres

Nom	Type	Description
`data`	`Byte[]`	Octets de l'objet blob.
`contentType`	`String`	Type de contenu du blob. Peut être `null`.

Renvois

Blob : Blob nouvellement créé.

`newBlob(data, contentType, name)`

Créez un objet Blob à partir d'un tableau d'octets, d'un type de contenu et d'un nom. Les blobs sont utilisés dans de nombreuses API Apps Script qui acceptent les données binaires en entrée.

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

Paramètres

Nom	Type	Description
`data`	`Byte[]`	Octets de l'objet blob.
`contentType`	`String`	- Le type de contenu de l'objet blob peut être `null`.
`name`	`String`	Nom du blob (peut être `null`).

Renvois

Blob : Blob nouvellement créé.

`newBlob(data)`

Créez un objet Blob à partir d'une chaîne. Les blobs sont utilisés dans de nombreuses API Apps Script qui acceptent les données binaires en entrée.

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

Paramètres

Nom	Type	Description
`data`	`String`	Chaîne du blob, supposée être au format UTF-8.

Renvois

Blob : Blob nouvellement créé.

`newBlob(data, contentType)`

Crée un objet Blob à partir d'une chaîne et d'un type de contenu. Les blobs sont utilisés dans de nombreuses API Apps Script qui acceptent les données binaires en entrée.

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

Paramètres

Nom	Type	Description
`data`	`String`	Chaîne du blob, supposée être au format UTF-8.
`contentType`	`String`	Type de contenu de l'objet blob. Peut être `null`.

Renvois

Blob : Blob nouvellement créé.

`newBlob(data, contentType, name)`

Créez un objet Blob à partir d'une chaîne, d'un type de contenu et d'un nom. Les blobs sont utilisés dans de nombreuses API Apps Script qui acceptent les données binaires en entrée.

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

Paramètres

Nom	Type	Description
`data`	`String`	Chaîne du blob, supposée être au format UTF-8.
`contentType`	`String`	Type de contenu du blob. Peut être `null`.
`name`	`String`	Nom du blob (peut être `null`).

Renvois

Blob : Blob nouvellement créé.

`parseCsv(csv)`

Renvoie une représentation tabulaire sous forme de tableau 2D d'une chaîne 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);

Paramètres

Nom	Type	Description
`csv`	`String`	Chaîne contenant des données sur une ou plusieurs lignes au format CSV (valeurs séparées par une virgule).

Renvois

String[][] : tableau bidimensionnel contenant les valeurs de la chaîne CSV.

`parseCsv(csv, delimiter)`

Renvoie une représentation tabulaire bidimensionnelle d'une chaîne CSV à l'aide d'un délimiteur personnalisé.

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

Paramètres

Nom	Type	Description
`csv`	`String`	Chaîne contenant des données sur une ou plusieurs lignes au format CSV (valeurs séparées par une virgule).
`delimiter`	`Char`	Entre les valeurs.

Renvois

String[][] : tableau bidimensionnel contenant les valeurs de la chaîne CSV.

`parseDate(date, timeZone, format)`

Analyse la chaîne de date fournie selon les spécifications décrites dans la classe SimpleDateFormat de Java Standard Edition. Pour en savoir plus, consultez la classe SimpleDateFormat de 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);

Paramètres

Nom	Type	Description
`date`	`String`	Valeur de chaîne à analyser en tant que date.
`timeZone`	`String`	Fuseau horaire de sortie.
`format`	`String`	Format de la date selon les spécifications `SimpleDateFormat`.

Renvois

Date : chaîne d'entrée sous forme de date.

`sleep(milliseconds)`

Dort pendant le nombre de millisecondes spécifié. Met immédiatement le script en veille pendant le nombre de millisecondes spécifié. La valeur maximale autorisée est de 300 000 (ou 5 minutes).

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

Paramètres

Nom	Type	Description
`milliseconds`	`Integer`	Nombre de millisecondes de veille.

`ungzip(blob)`

Décompresse un objet Blob et renvoie un Blob contenant les données décompressées.

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

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	`Blob` des données compressées.

Renvois

Blob : Blob représentant les données décompressées.

`unzip(blob)`

Prend un blob représentant un fichier ZIP et renvoie ses fichiers composants.

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

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	Blob du fichier ZIP.

Renvois

Blob[] : tableau Blob[] représentant les blobs de composants, chacun nommé avec le chemin d'accès complet à l'intérieur du fichier ZIP.

`zip(blobs)`

Crée un objet Blob qui est un fichier ZIP contenant les données des objets Blob transmis.

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

Paramètres

Nom	Type	Description
`blobs`	`BlobSource[]`	Tableau de blobs à compresser.

Renvois

Blob : nouvel objet blob contenant les entrées sous forme d'archive.

`zip(blobs, name)`

Crée un objet Blob qui est un fichier ZIP contenant les données des objets Blob transmis. Cette version de la méthode permet de spécifier un nom de fichier.

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

Paramètres

Nom	Type	Description
`blobs`	`BlobSource[]`	Tableau de blobs à compresser.
`name`	`String`	Nom du fichier ZIP à créer.

Renvois

Blob : nouvel objet blob contenant les entrées sous forme d'archive.

Méthodes obsolètes

`jsonParse(jsonString)`

Obsolète. Remplacé par JSON.parse() en novembre 2013

Renvoie un objet correspondant à la chaîne JSON transmise.

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

Paramètres

Nom	Type	Description
`jsonString`	`String`	Représentation sous forme de chaîne d'un objet JavaScript à désérialiser.

Renvois

Object : représentation de l'entrée sous forme d'objet JavaScript.

`jsonStringify(obj)`

Obsolète. Remplacé par JSON.stringify() en novembre 2013

Renvoie une chaîne JSON de l'objet transmis.

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

Paramètres

Nom	Type	Description
`obj`	`Object`	Objet JavaScript à sérialiser au format JSON.

Renvois

String : objet JavaScript sérialisé au format JSON.

Class Utilities Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Propriétés

Méthodes

Méthodes obsolètes

Documentation détaillée

base64Decode(encoded)

Paramètres

Renvois

base64Decode(encoded, charset)

Paramètres

Renvois

base64DecodeWebSafe(encoded)

Paramètres

Renvois

base64DecodeWebSafe(encoded, charset)

Paramètres

Renvois

base64Encode(data)

Paramètres

Renvois

base64Encode(data)

Paramètres

Renvois

base64Encode(data, charset)

Paramètres

Renvois

base64EncodeWebSafe(data)

Paramètres

Renvois

base64EncodeWebSafe(data)

Paramètres

Renvois

base64EncodeWebSafe(data, charset)

Paramètres

Renvois

computeDigest(algorithm, value)

Paramètres

Renvois

computeDigest(algorithm, value)

Paramètres

Renvois

computeDigest(algorithm, value, charset)

Paramètres

Renvois

computeHmacSha256Signature(value, key)

Paramètres

Renvois

computeHmacSha256Signature(value, key)

Paramètres

Renvois

computeHmacSha256Signature(value, key, charset)

Paramètres

Renvois

computeHmacSignature(algorithm, value, key)

Paramètres

Renvois

computeHmacSignature(algorithm, value, key)

Paramètres

Renvois

computeHmacSignature(algorithm, value, key, charset)

Paramètres

Renvois

computeRsaSha1Signature(value, key)

Paramètres

Renvois

computeRsaSha1Signature(value, key, charset)

Paramètres

Renvois

computeRsaSha256Signature(value, key)

Paramètres

Renvois

computeRsaSha256Signature(value, key, charset)

Paramètres

Renvois

computeRsaSignature(algorithm, value, key)

Paramètres

Renvois

computeRsaSignature(algorithm, value, key, charset)

Paramètres

Renvois

Class Utilities

`base64Decode(encoded)`

`base64Decode(encoded, charset)`

`base64DecodeWebSafe(encoded)`

`base64DecodeWebSafe(encoded, charset)`

`base64Encode(data)`

`base64Encode(data)`

`base64Encode(data, charset)`

`base64EncodeWebSafe(data)`

`base64EncodeWebSafe(data)`

`base64EncodeWebSafe(data, charset)`

`computeDigest(algorithm, value)`

`computeDigest(algorithm, value)`

`computeDigest(algorithm, value, charset)`

`computeHmacSha256Signature(value, key)`

`computeHmacSha256Signature(value, key)`

`computeHmacSha256Signature(value, key, charset)`

`computeHmacSignature(algorithm, value, key)`

`computeHmacSignature(algorithm, value, key)`

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

`computeRsaSha1Signature(value, key)`

`computeRsaSha1Signature(value, key, charset)`

`computeRsaSha256Signature(value, key)`

`computeRsaSha256Signature(value, key, charset)`

`computeRsaSignature(algorithm, value, key)`

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

`formatDate(date, timeZone, format)`

`formatString(template, args)`

`getUuid()`

`gzip(blob)`

`gzip(blob, name)`

`newBlob(data)`

`newBlob(data, contentType)`

`newBlob(data, contentType, name)`

`newBlob(data)`

`newBlob(data, contentType)`

`newBlob(data, contentType, name)`

`parseCsv(csv)`

`parseCsv(csv, delimiter)`

`parseDate(date, timeZone, format)`

`sleep(milliseconds)`

`ungzip(blob)`

`unzip(blob)`

`zip(blobs)`

`zip(blobs, name)`

`jsonParse(jsonString)`

`jsonStringify(obj)`