Fonctions personnalisées dans Google Sheets

Google Sheets propose des centaines de fonctions intégrées, comme AVERAGE, SUM et VLOOKUP. Si ces fonctions ne suffisent pas à vos besoins, vous pouvez utiliser Google Apps Script pour écrire des fonctions personnalisées, par exemple pour convertir des mètres en miles ou récupérer 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'y est pas associé.)

Voici une fonction personnalisée simple, nommée DOUBLE, qui multiplie une valeur d'entrée 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 du code JavaScript et que vous n'avez pas le temps de l'apprendre, consultez le magasin 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 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 sous forme de modules complémentaires pour Google Sheets. Pour utiliser ou explorer ces modules complémentaires :

1. Créez ou ouvrez une feuille de calcul dans Google Sheets.
2. En haut de la page, cliquez sur Modules complémentaires > Télécharger des modules complémentaires.
3. Une fois l'icône Google Workspace Marketplace ouverte, 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 Installer pour l'installer.
6. Une boîte de dialogue peut vous indiquer que le module complémentaire nécessite une autorisation. Si c'est le cas, lisez attentivement la notification, puis cliquez sur 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-la, puis cliquez sur Modules complémentaires > Gérer les modules complémentaires en haut de l'écran. 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, il est aussi facile de l'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 affichera brièvement Loading..., puis renverra le résultat.

Consignes concernant les fonctions personnalisées

Avant d'écrire votre propre fonction personnalisée, vous devez connaître quelques consignes.

Dénomination

En plus des conventions standards pour nommer les 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, comme SUM().
• Le nom d'une fonction personnalisée ne peut pas se terminer par un trait de soulignement (_), qui désigne 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 de feuille de calcul soient traditionnellement en majuscules.

Arguments

Comme une fonction intégrée, une fonction personnalisée peut accepter des arguments comme valeurs d'entrée :

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

• Si vous appelez votre fonction avec une référence à une plage de cellules comme argument (comme =DOUBLE(A1:B10)), l'argument sera 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 ci-dessus devra être modifié pour accepter un tableau comme entrée.

  
  

• Les arguments de fonction personnalisée doivent être déterministes. En d'autres termes, 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 comme 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 affichera Loading... indéfiniment.

Valeurs renvoyées

Chaque fonction personnalisée doit renvoyer une valeur à afficher, de sorte 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 bidimensionnel, les valeurs sont déversées dans les cellules adjacentes tant qu'elles sont vides. Si cela devait entraîner l'écrasement du contenu des cellules existantes, la fonction personnalisée générera 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 pour lesquelles 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 plutôt un menu personnalisé pour exécuter une fonction.
• Un appel de fonction personnalisée doit renvoyer une réponse dans un délai de 30 secondes. Si ce n'est pas le cas, la cellule affiche #ERROR! et la note de cellule est Exceeded maximum execution time (line 0)..

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é en JavaScript. Voici les sources de confusion les plus courantes :

• 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 devra compenser.
• Les valeurs de durée dans Sheets deviennent également des objets Date, mais il peut être compliqué de les utiliser.
• Les valeurs de pourcentage dans Sheets deviennent des nombres décimaux dans Apps Script. Par exemple, une cellule avec une valeur 10% devient 0.1 dans Apps Script.

Saisie semi-automatique

Google Sheets est compatible avec 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 à ce que vous saisissez s'affiche.

Les fonctions personnalisées s'affichent dans cette liste si leur script inclut un tag 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é

Utiliser les 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 à leurs données personnelles. Par conséquent, ils ne peuvent appeler que les services qui n'ont pas accès aux données à caractère personnel, à savoir les suivants :

Si votre fonction personnalisée génère le message d'erreur You do not have permission to call X service., cela signifie que 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 à l'utilisateur une autorisation si nécessaire et pourra donc utiliser tous les services Apps Script.

Partage

Les fonctions personnalisées sont associé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 utilisez l'une des méthodes suivantes :

• Cliquez sur Extensions > Apps Script pour ouvrir l'éditeur de script. Copiez ensuite le texte du script à partir de la feuille de calcul d'origine et collez-le dans l'éditeur de script d'une autre feuille de calcul.
• Créez une copie de la feuille de calcul contenant la fonction personnalisée en cliquant sur Fichier > Créer une copie. Lorsqu'une feuille de calcul est copiée, tous les scripts qui y sont associés le sont également. Toute personne ayant accès à la feuille de calcul peut copier le script. (Les collaborateurs disposant d'un accès en lecture seule ne peuvent pas ouvrir l'éditeur de script dans la feuille de calcul d'origine. Toutefois, lorsqu'ils en créent une copie, ils en deviennent propriétaires et peuvent 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 effectue un appel distinct au serveur Apps Script. Si votre feuille de calcul contient des dizaines (voire des centaines ou des milliers) d'appels de fonctions personnalisées, ce processus peut être assez lent. Certains projets comportant de nombreuses fonctions personnalisées ou des fonctions personnalisées complexes peuvent subir un retard temporaire dans les exécutions.

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

Par exemple, la fonction DOUBLE() présentée ci-dessus peut être réécrite pour accepter une seule cellule ou une 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 de JavaScript pour appliquer une méthode au tableau bidimensionnel de cellules afin d'obtenir chaque ligne. Ensuite, pour chaque ligne, elle utilise à nouveau map pour renvoyer le double de la valeur de chaque cellule. Elle renvoie un tableau bidimensionnel contenant les résultats. Vous pouvez ainsi appeler DOUBLE une seule fois, mais le faire calculer pour un grand nombre de cellules à la fois, comme illustré dans la capture d'écran ci-dessous. (Vous pouvez obtenir le même résultat avec des instructions if imbriquées au lieu de l'appel map.)

De même, la fonction personnalisée ci-dessous récupère efficacement du contenu en direct sur Internet et utilise un tableau bidimensionnel 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 beaucoup plus de temps, car le serveur Apps Script devrait 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.