Fonctions personnalisées dans Google Sheets

Google Sheets propose des centaines de fonctions intégrées telles que AVERAGE, SUM et VLOOKUP. Lorsque ces fonctions ne sont pas suffisantes pour vos besoins, vous pouvez utiliser Google Apps Script pour écrire des fonctions personnalisées (par exemple, pour convertir des mètres en miles ou extraire du contenu en direct sur Internet), puis les utiliser dans Google Sheets comme une fonction intégrée.

Premiers pas

Les fonctions personnalisées sont créées à l'aide de JavaScript standard. Si vous débutez avec JavaScript, Codecademy propose un excellent cours pour les débutants. Remarque: ce cours n'a pas été développé par Google et n'est pas associé à Google.

Voici une fonction personnalisée simple, nommée DOUBLE, qui multiplie une valeur saisie par 2:

/**
 * Multiplies an input value by 2.
 * @param {number} input The number to double.
 * @return The input multiplied by 2.
 * @customfunction
*/
function DOUBLE(input) {
  return input * 2;
}

Si vous ne savez pas comment écrire en JavaScript et que vous n'avez pas le temps d'apprendre, consultez la plate-forme de téléchargement de modules complémentaires pour voir si quelqu'un d'autre a déjà créé la fonction personnalisée dont vous avez besoin.

Créer une fonction personnalisée

Pour écrire une fonction personnalisée:

1. Créez ou ouvrez une feuille de calcul dans Google Sheets.
2. Sélectionnez l'élément de menu Extensions > Apps Script.
3. Supprimez le code dans l'éditeur de scripts. Pour la fonction DOUBLE ci-dessus, il vous suffit de copier et de coller le code dans l'éditeur de script.
4. En haut, cliquez sur save (Enregistrer).

Vous pouvez maintenant utiliser la fonction personnalisée.

Obtenir une fonction personnalisée à partir de Google Workspace Marketplace

Google Workspace Marketplace propose plusieurs fonctions personnalisées en tant que modules complémentaires pour Google Sheets. Pour utiliser ou découvrir ces modules complémentaires:

1. Créez ou ouvrez une feuille de calcul dans Google Sheets.
2. En haut, cliquez sur Modules complémentaires > Télécharger des modules complémentaires.
3. Une fois le Google Workspace Marketplace ouvert, cliquez sur le champ de recherche en haut à droite.
4. Saisissez "fonction personnalisée", puis appuyez sur Entrée.
5. Si vous trouvez un module complémentaire de fonction personnalisée qui vous intéresse, cliquez sur Install (Installer) pour l'installer.
6. Une boîte de dialogue peut vous indiquer que le module complémentaire nécessite une autorisation. Le cas échéant, lisez attentivement la notification, puis cliquez sur Allow (Autoriser).
7. Le module complémentaire devient disponible dans la feuille de calcul. Pour utiliser le module complémentaire dans une autre feuille de calcul, ouvrez l'autre feuille de calcul et, en haut, cliquez sur Modules complémentaires > Gérer les modules complémentaires. Recherchez le module complémentaire que vous souhaitez utiliser, puis cliquez sur Options more_vert > Utiliser dans ce document.

Utiliser une fonction personnalisée

Une fois que vous avez écrit une fonction personnalisée ou que vous en avez installé une à partir deGoogle Workspace Marketplace, elle est aussi facile à utiliser qu'une fonction intégrée:

1. Cliquez sur la cellule dans laquelle vous souhaitez utiliser la fonction.
2. Saisissez un signe égal (=), suivi du nom de la fonction et de toute valeur d'entrée (par exemple, =DOUBLE(A1)), puis appuyez sur Entrée.
3. La cellule affiche Loading... dans un instant, puis renvoie le résultat.

Consignes concernant les fonctions personnalisées

Voici quelques consignes à connaître avant de créer votre propre fonction personnalisée.

Dénomination

En plus des conventions standards d'attribution de noms aux fonctions JavaScript, tenez compte des points suivants:

• Le nom d'une fonction personnalisée doit être différent de celui des fonctions intégrées telles que SUM().
• Le nom d'une fonction personnalisée ne peut pas se terminer par un trait de soulignement (_), qui indique une fonction privée dans Apps Script.
• Le nom d'une fonction personnalisée doit être déclaré avec la syntaxe function myFunction(), et non var myFunction = new Function().
• La casse n'a pas d'importance, bien que les noms des fonctions des feuilles de calcul soient généralement en majuscules.

Arguments

Comme les fonctions intégrées, les fonctions personnalisées peuvent accepter des arguments en tant que valeurs d'entrée:

• Si vous appelez votre fonction avec une référence à une cellule unique en tant qu'argument (comme =DOUBLE(A1)), l'argument sera la valeur de la cellule.

• Si vous appelez votre fonction en tant qu'argument en faisant référence à une plage de cellules (comme =DOUBLE(A1:B10)), l'argument est un tableau bidimensionnel des valeurs des cellules. Par exemple, dans la capture d'écran ci-dessous, les arguments de =DOUBLE(A1:B2) sont interprétés par Apps Script comme double([[1,3],[2,4]]). Notez que l'exemple de code pour DOUBLE vu ci-dessus devrait être modifié pour accepter un tableau en tant qu'entrée.

  
  

• Les arguments de la fonction personnalisée doivent être déterministes. Autrement dit, les fonctions de feuille de calcul intégrées qui renvoient un résultat différent à chaque calcul (comme NOW() ou RAND()) ne sont pas autorisées en tant qu'arguments d'une fonction personnalisée. Si une fonction personnalisée tente de renvoyer une valeur basée sur l'une de ces fonctions intégrées volatiles, elle affiche Loading... indéfiniment.

Valeurs renvoyées

Chaque fonction personnalisée doit renvoyer une valeur à afficher, telle que:

• Si une fonction personnalisée renvoie une valeur, celle-ci s'affiche dans la cellule à partir de laquelle la fonction a été appelée.
• Si une fonction personnalisée renvoie un tableau de valeurs à deux dimensions, les valeurs débordent dans les cellules adjacentes tant que ces cellules sont vides. Si le tableau écrase le contenu des cellules existantes, la fonction personnalisée génère une erreur. Pour obtenir un exemple, consultez la section sur l'optimisation des fonctions personnalisées.
• Une fonction personnalisée ne peut pas affecter les cellules autres que celles auxquelles elle renvoie une valeur. En d'autres termes, une fonction personnalisée ne peut pas modifier des cellules arbitraires, mais uniquement les cellules à partir desquelles elle est appelée et les cellules adjacentes. Pour modifier des cellules arbitraires, utilisez un menu personnalisé pour exécuter une fonction.
• Un appel de fonction personnalisée doit renvoyer un résultat dans un délai de 30 secondes. Si ce n'est pas le cas, la cellule affiche une erreur: Internal error executing the custom function.

Types de données

Google Sheets stocke les données dans différents formats en fonction de leur nature. Lorsque ces valeurs sont utilisées dans des fonctions personnalisées, Apps Script les traite comme le type de données approprié dans JavaScript. Voici les sujets de confusion les plus courants:

• Les heures et les dates dans Sheets deviennent des objets Date dans Apps Script. Si la feuille de calcul et le script utilisent des fuseaux horaires différents (un problème rare), la fonction personnalisée doit compenser.
• Les valeurs de durée dans Sheets deviennent également des objets Date, mais leur utilisation peut être compliquée.
• Les valeurs de pourcentage dans Sheets deviennent des nombres décimaux dans Apps Script. Par exemple, une cellule dont la valeur est 10% devient 0.1 dans Apps Script.

Saisie semi-automatique

Google Sheets accepte la saisie semi-automatique pour les fonctions personnalisées, comme pour les fonctions intégrées. Lorsque vous saisissez le nom d'une fonction dans une cellule, une liste de fonctions intégrées et personnalisées correspondant à votre saisie s'affiche.

Les fonctions personnalisées apparaissent dans cette liste si leur script inclut une balise JsDoc @customfunction, comme dans l'exemple DOUBLE() ci-dessous.

/**
 * Multiplies the input value by 2.
 *
 * @param {number} input The value to multiply.
 * @return The input multiplied by 2.
 * @customfunction
 */
function DOUBLE(input) {
  return input * 2;
}

Avancé

Utilisation des services Google Apps Script

Les fonctions personnalisées peuvent appeler certains services Google Apps Script pour effectuer des tâches plus complexes. Par exemple, une fonction personnalisée peut appeler le service Language pour traduire une expression anglaise en espagnol.

Contrairement à la plupart des autres types de scripts Apps Script, les fonctions personnalisées ne demandent jamais aux utilisateurs d'autoriser l'accès aux données à caractère personnel. Par conséquent, ils ne peuvent appeler que des services qui n'ont pas accès à des données à caractère personnel, en particulier aux services suivants:

Services compatibles	Remarques
Cache	Fonctionne, mais pas particulièrement utile dans les fonctions personnalisées
HTML	Peut générer du code HTML, mais ne peut pas l'afficher (rarement utile)
JDBC
Language
Verrouiller	Fonctionne, mais pas particulièrement utile dans les fonctions personnalisées
Maps	Permet de calculer des itinéraires, mais pas d'afficher des cartes
Propriétés	getUserProperties() ne récupère que les propriétés du propriétaire de la feuille de calcul. Les éditeurs de feuilles de calcul ne peuvent pas définir les propriétés utilisateur dans une fonction personnalisée.
Feuille de calcul	Lecture seule (permet d'utiliser la plupart des méthodes get*(), mais pas set*()). Impossible d'ouvrir d'autres feuilles de calcul (SpreadsheetApp.openById() ou SpreadsheetApp.openByUrl()).
URL Fetch
Fournisseurs
XML

Si votre fonction personnalisée génère le message d'erreur You do not have permission to call X service., le service nécessite une autorisation de l'utilisateur et ne peut donc pas être utilisé dans une fonction personnalisée.

Pour utiliser un service autre que ceux listés ci-dessus, créez un menu personnalisé qui exécute une fonction Apps Script au lieu d'écrire une fonction personnalisée. Une fonction déclenchée à partir d'un menu demandera une autorisation à l'utilisateur si nécessaire et pourra donc utiliser tous les services Apps Script.

Partage

Les fonctions personnalisées sont initialement liées à la feuille de calcul dans laquelle elles ont été créées. Cela signifie qu'une fonction personnalisée écrite dans une feuille de calcul ne peut pas être utilisée dans d'autres feuilles de calcul, sauf si vous optez pour l'une des méthodes suivantes:

• Cliquez sur Extensions > Apps Script pour ouvrir l'éditeur de script. Copiez ensuite le texte du script de la feuille de calcul d'origine et collez-le dans l'éditeur de scripts d'une autre feuille de calcul.
• Effectuez une copie de la feuille de calcul contenant la fonction personnalisée en cliquant sur File > Make a copy (Fichier > Créer une copie). Lorsqu'une feuille de calcul est copiée, tous les scripts associés le sont également. Toute personne ayant accès à la feuille de calcul peut copier le script. (Les collaborateurs qui ne disposent que d'un accès en lecture ne peuvent pas ouvrir l'éditeur de script dans la feuille de calcul d'origine. Toutefois, lorsqu'il crée une copie, il en devient le propriétaire et peut voir le script.)
• Publiez le script en tant que module complémentaire de l'éditeur Google Sheets.

Optimisation

Chaque fois qu'une fonction personnalisée est utilisée dans une feuille de calcul, Google Sheets envoie un appel distinct au serveur Apps Script. Si votre feuille de calcul contient des dizaines (ou des centaines, voire des milliers) d'appels de fonctions personnalisées, ce processus peut être assez lent.

Par conséquent, si vous prévoyez d'utiliser une fonction personnalisée plusieurs fois sur une large plage de données, envisagez de la modifier afin qu'elle accepte une plage en entrée sous la forme d'un tableau à deux dimensions, puis renvoie un tableau bidimensionnel qui peut déborder dans les cellules appropriées.

Par exemple, la fonction DOUBLE() ci-dessus peut être réécrite pour accepter une seule cellule ou plage de cellules comme suit:

/**
 * Multiplies the input value by 2.
 *
 * @param {number|Array<Array<number>>} input The value or range of cells
 *     to multiply.
 * @return The input multiplied by 2.
 * @customfunction
 */
function DOUBLE(input) {
  return Array.isArray(input) ?
      input.map(row => row.map(cell => cell * 2)) :
      input * 2;
}

L'approche ci-dessus utilise la méthode map de l'objet Array JavaScript pour appeler DOUBLE de manière récursive sur chaque valeur du tableau de cellules à deux dimensions. Elle renvoie un tableau bidimensionnel contenant les résultats. De cette façon, vous pouvez appeler DOUBLE une seule fois, mais le calculer pour un grand nombre de cellules à la fois, comme illustré dans la capture d'écran ci-dessous. Vous pouvez accomplir la même chose avec des instructions if imbriquées au lieu de l'appel map.

De même, la fonction personnalisée ci-dessous extrait efficacement le contenu en direct sur Internet et utilise un tableau à deux dimensions pour afficher deux colonnes de résultats avec un seul appel de fonction. Si chaque cellule nécessitait son propre appel de fonction, l'opération prendrait considérablement plus de temps, car le serveur Apps Script devait télécharger et analyser le flux XML à chaque fois.

/**
 * Show the title and date for the first page of posts on the
 * Developer blog.
 *
 * @return Two columns of data representing posts on the
 *     Developer blog.
 * @customfunction
 */
function getBlogPosts() {
  var array = [];
  var url = 'https://gsuite-developers.googleblog.com/atom.xml';
  var xml = UrlFetchApp.fetch(url).getContentText();
  var document = XmlService.parse(xml);
  var root = document.getRootElement();
  var atom = XmlService.getNamespace('http://www.w3.org/2005/Atom');
  var entries = document.getRootElement().getChildren('entry', atom);
  for (var i = 0; i < entries.length; i++) {
    var title = entries[i].getChild('title', atom).getText();
    var date = entries[i].getChild('published', atom).getValue();
    array.push([title, date]);
  }
  return array;
}

Ces techniques peuvent être appliquées à presque toutes les fonctions personnalisées utilisées de manière répétée dans une feuille de calcul, bien que les détails de l'implémentation varient en fonction du comportement de la fonction.