Bibliothèques

Une bibliothèque est un projet de script dont les fonctions peuvent être réutilisées dans d'autres scripts.

Accéder à une bibliothèque

Pour inclure une bibliothèque dans votre projet, vous devez au moins y avoir accès au niveau de la vue. Si vous n'êtes pas l'auteur de la bibliothèque que vous souhaitez inclure, contactez-le et demandez-lui l'accès.

Vous avez besoin de l'ID de script de la bibliothèque que vous souhaitez inclure. Une fois que vous avez accès à la bibliothèque, vous trouverez l'ID de script sur la page Paramètres du projet settings.

Ajouter une bibliothèque à votre projet de script

1. À gauche de l'éditeur Apps Script, à côté de "Bibliothèques", cliquez sur Ajouter une bibliothèque add.
2. Dans le champ "ID de script", collez l'ID de script de la bibliothèque.
3. Cliquez sur Rechercher.
4. Cliquez sur le menu déroulant Version et sélectionnez la version de la bibliothèque à utiliser.
5. Vérifiez si le nom "Identifier" par défaut est celui que vous souhaitez utiliser avec cette bibliothèque. Il s'agit du nom que votre script utilise pour faire référence à la bibliothèque. Par exemple, si vous la définissez sur Test, vous pouvez appeler une méthode de cette bibliothèque comme suit: Test.libraryMethod().
6. Cliquez sur Ajouter.

Utiliser une bibliothèque

Utilisez votre bibliothèque incluse comme vous le feriez avec un service par défaut. Par exemple, si Test est l'identifiant de votre bibliothèque, saisissez Test immédiatement suivi d'un point pour afficher la liste des méthodes de la bibliothèque.

Pour ouvrir la documentation de référence d'une bibliothèque incluse, procédez comme suit:

À gauche de l'éditeur de script, à côté du nom de la bibliothèque, cliquez sur Plus more_vert > Ouvrir dans un nouvel onglet.

Supprimer une bibliothèque

À gauche de l'éditeur de script, à côté du nom de la bibliothèque, cliquez sur Plus more_vert > Supprimer > Supprimer la bibliothèque.

Mettre à jour une bibliothèque

Vous pouvez modifier la version de la bibliothèque ou mettre à jour son identifiant.

1. À gauche de l'éditeur, sous "Bibliothèques", cliquez sur le nom de la bibliothèque.
2. Apportez les modifications nécessaires, puis cliquez sur Enregistrer.

Créer et partager une bibliothèque

Pour utiliser et partager votre projet de script en tant que bibliothèque, procédez comme suit.

1. Créez un déploiement avec gestion des versions de votre script.
2. Partagez au moins un accès en lecture avec tous les utilisateurs potentiels de la bibliothèque.
3. Attribuez à ces utilisateurs l'ID de script, disponible sur la page Paramètres du projet settings.

Bonnes pratiques

Voici quelques consignes à suivre lors de l'écriture d'une bibliothèque:

1. Choisissez un nom explicite pour votre projet, car il sera utilisé comme identifiant par défaut lorsque votre bibliothèque est incluse par d'autres.
2. Si vous souhaitez qu'une ou plusieurs méthodes de votre script ne soient pas visibles (ni utilisables) par les utilisateurs de votre bibliothèque, vous pouvez terminer le nom de la méthode par un trait de soulignement. Par exemple, myPrivateMethod_().
3. Seules les propriétés globales énumérables sont visibles par les utilisateurs de la bibliothèque. Cela inclut les déclarations de fonction, les variables créées en dehors d'une fonction avec var, ainsi que les propriétés définies explicitement sur l'objet global. Par exemple, Object.defineProperty() avec enumerable défini sur false crée un symbole que vous pouvez utiliser dans votre bibliothèque, mais ce symbole n'est pas accessible par vos utilisateurs.

4. Si vous souhaitez que les utilisateurs de votre bibliothèque puissent utiliser la saisie semi-automatique de l'éditeur de scripts et la documentation générée automatiquement, vous devez disposer d'une documentation de type JSDoc pour toutes vos fonctions. Exemple :

   /**
    * Raises a number to the given power, and returns the result.
    *
    * @param {number} base the number we're raising to a power
    * @param {number} exp the exponent we're raising the base to
    * @return {number} the result of the exponential calculation
    */
   function power(base, exp) { ... }
   

Portée des ressources

Lorsque vous travaillez avec des bibliothèques, il existe deux types de ressources: partagées et non partagées. Une ressource partagée signifie que la bibliothèque et le script inclusif disposent d'un accès intégré à la même instance de la ressource. Le schéma suivant illustre une ressource partagée utilisant l'exemple de propriétés utilisateur:

Une ressource non partagée signifie que la bibliothèque et le script d'inclusion ne disposent que d'un accès intégré à leur instance de la ressource. Cependant, une bibliothèque peut fournir un accès à ses ressources non partagées en exécutant des fonctions explicites sur celles-ci. Voici un exemple de fonction que vous pouvez inclure dans votre bibliothèque pour exposer ses propriétés de script:

  function getLibraryProperty(key) {
    return ScriptProperties.getProperty(key);
  }

Le schéma suivant illustre une ressource non partagée à l'aide de l'exemple de propriétés de script:

Pour référence, ce tableau recense les ressources partagées et non partagées:

Ressource	Partagé*	Non partagé**	Remarques
Verrouiller			Lorsqu'elle est créée dans la bibliothèque, la même instance est visible par tous, y compris les scripts.
Propriétés du script			Lorsqu'elle est créée dans la bibliothèque, la même instance est visible par tous, y compris les scripts.
Cache			Lorsqu'elle est créée dans la bibliothèque, la même instance est visible par tous, y compris les scripts.
Déclencheurs			Les déclencheurs simples créés dans la bibliothèque ne sont pas déclenchés par le script d'inclusion.
ScriptApp
UiApp
Propriétés utilisateur
Enregistreur et la transcription de l'exécution
Sites, Sheets et autres conteneurs			Un appel à getActive() renvoie le conteneur du script inclusif.
MailApp et GmailApp
* Cela signifie que la bibliothèque ne possède pas sa propre instance de la fonctionnalité ou de la ressource, mais qu'elle utilise celle créée par le script qui l'a appelée. ** Cela signifie que la bibliothèque possède sa propre instance de la ressource/fonctionnalité, et que tous les scripts qui l'utilisent partagent cette même instance et y ont accès.

Tester une bibliothèque

Pour tester votre bibliothèque, utilisez le déploiement "head". Toute personne disposant d'un accès éditeur au script peut utiliser le déploiement "head".

Déboguer une bibliothèque

Lorsque vous utilisez le débogueur dans un projet qui inclut une bibliothèque, vous pouvez entrer dans une fonction de la bibliothèque incluse. Le code s'affiche dans le débogueur en mode lecture seule et à la bonne version.