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 extraire du contenu en direct depuis 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 d'entrée par deux:

/**
 * 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 écrire du code JavaScript et que vous n'avez pas le temps de l'apprendre, consultez la plate-forme 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 (Enregistrer).

Vous pouvez maintenant utiliser la fonction personnalisée.

Obtenir une fonction personnalisée à partir de la

propose plusieurs fonctions personnalisées en tant que 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 ouvert, cliquez sur la zone 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 est alors 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  > Utiliser dans ce document.

Utiliser une fonction personnalisée

Une fois que vous avez écrit une fonction personnalisée ou en avez installé une à partir de, 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 momentanément Loading..., puis renvoie 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 de dénomination des fonctions JavaScript, tenez compte des points suivants:

• Le nom d'une fonction personnalisée doit être distinct des noms 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 de feuille de calcul soient traditionnellement en majuscules.

Arguments

Comme une fonction intégrée, une fonction personnalisée peut utiliser 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 en tant qu'argument (comme =DOUBLE(A1:B10)), l'argument sera un tableau à deux dimensions 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 doit être modifié pour accepter un tableau en entrée.

  
  

• Les arguments de fonction personnalisés doivent être déterministes. Autrement dit, les fonctions de feuille de calcul intégrées qui renvoient un résultat différent à chaque calcul (telles que 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, 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 à deux dimensions de valeurs, 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 d'autres cellules 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 leurs 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 être renvoyé dans un délai de 30 secondes. Si ce n'est pas le cas, la cellule affiche #ERROR! et la note de la 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 (problème rare), la fonction personnalisée devra compenser.
• Les valeurs de durée dans Sheets deviennent également des objets Date, mais les utiliser peut s'avérer compliqué.
• Les valeurs en 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 est compatible avec la saisie semi-automatique pour les fonctions personnalisées, comme pour les fonctions intégrées. Lorsque vous saisissez un nom de 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 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é

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 phrase en anglais 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 à des données à caractère personnel. Par conséquent, elles ne peuvent appeler que des services qui n'ont pas accès aux données à caractère personnel, en particulier les suivants:

Services compatibles	Remarques
Cache	Fonctionne, mais n'est 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
Langue
Verrouiller	Fonctionne, mais n'est pas particulièrement utile dans les fonctions personnalisées
Maps	Peut calculer des itinéraires, mais pas afficher de cartes
Propriétés	getUserProperties() n'obtient que les propriétés du propriétaire de la feuille de calcul. Les éditeurs de feuilles de calcul ne peuvent pas définir de propriétés utilisateur dans une fonction personnalisée.
Feuille de calcul	Lecture seule (peut utiliser la plupart des méthodes get*(), mais pas set*()). Impossible d'ouvrir d'autres feuilles de calcul (SpreadsheetApp.openById() ou SpreadsheetApp.openByUrl()).
Récupération d'URL
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 l'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 par conséquent utiliser tous les services Apps Script.

Partage

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

• Cliquez sur Extensions > Apps Script pour ouvrir l'éditeur de script, puis copiez 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 sont également copiés. 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 devient le propriétaire de la copie et peut voir le script.)
• Publiez le script en tant que module complémentaire de l'éditeur Google Sheets.

Tous les scripts liés à un conteneur ont les mêmes listes d'accès que leurs conteneurs. Cela signifie que toute personne autorisée à modifier la feuille de calcul peut modifier le code Apps Script qui y est associé.

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 (ou des centaines, voire des milliers) d'appels de fonction personnalisés, ce processus peut être très lent.

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

Par exemple, la fonction DOUBLE() illustré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 appeler de manière récursive DOUBLE sur chaque valeur du tableau bidimensionnel de cellules. Elle renvoie un tableau à deux dimensions contenant les résultats. De cette façon, vous pouvez 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 extrait efficacement du 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 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.