Bibliothèques

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

Avertissement :Un script qui utilise une bibliothèque ne s'exécute pas aussi vite comme si tout le code était contenu dans un seul projet de script. Bien que les bibliothèques puissent faciliter le développement et la maintenance, avec parcimonie dans les projets où la vitesse est essentielle. En raison de ce problème, l'utilisation des bibliothèques doit être limitée dans les modules complémentaires.

Accéder à une bibliothèque

Pour inclure une bibliothèque dans votre projet, vous devez disposer au moins d'un 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. Lorsque vous avez à la bibliothèque, vous trouverez l'ID de script dans les paramètres du projet .

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 .
2. Dans "ID de script", , collez l'ID de script de la bibliothèque.
3. Cliquez sur Rechercher.
   Si vous rencontrez une erreur, assurez-vous disposer au moins d'un accès en lecture au projet inclure.
4. Cliquez sur la liste déroulante Version, puis sélectionnez la version de la bibliothèque à utiliser.
5. Vérifiez si l'identifiant par défaut nom est celui que vous voulez utiliser avec cette bibliothèque. Il s'agit du nom que votre script utilise pour consultez la bibliothèque. Par exemple, si vous le définissez sur Test, vous pouvez appelez une méthode de cette bibliothèque comme suit: Test.libraryMethod().
   Si vous utilisez un nom d'identifiant qui correspond au nom d'un service déjà existant, tel que MailApp, ou d'une bibliothèque précédemment ajoutée, la bibliothèque que vous avez ajoutée la plus récemment remplace le service ou la bibliothèque existante.
6. Cliquez sur Ajouter.

Utiliser une bibliothèque

Utilisez votre bibliothèque incluse comme vous le feriez avec un service par défaut. Pour 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.

La documentation de référence d'une bibliothèque incluse peut être consultée en suivant procédez comme suit:

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

Supprimer une bibliothèque

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

Si une bibliothèque est supprimée par son auteur, vous devez quand même supprimez-la de votre liste de bibliothèques incluses.

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éer 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. Indiquez-leur l'ID du script, qui se trouve sur la page Paramètres du projet.

Bonnes pratiques

Voici quelques consignes à suivre lors de la création d'une bibliothèque :

1. Choisissez un nom explicite pour votre projet, car il est 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 utilisable) pour les utilisateurs de votre bibliothèque, vous pouvez terminer le nom de la méthode par une 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 et 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 vos utilisateurs n'y ont pas accès.

4. Si vous souhaitez que les utilisateurs de votre bibliothèque utilisent la saisie semi-automatique et la documentation générée automatiquement, vous devez utiliser des fichiers 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, vous avez deux types de ressources : partagées et non partagées. Une ressource partagée signifie que la bibliothèque et le script d'inclusion ont un accès intégré à la même instance de la ressource. Le schéma suivant illustre une ressource partagée à l'aide de l'exemple des propriétés utilisateur :

Une ressource non partagée signifie que la bibliothèque et le script correspondant ont tous les deux un accès intégré uniquement à leur instance de la ressource. Toutefois, une bibliothèque peut fournir un accès à ses ressources non partagées en disposant de fonctions explicites qui y opèrent. Voici un exemple de fonction que vous incluriez 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 du script:

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

Ressource	Partagé*	Non partagé**	Remarques
Verrouiller			La même instance est visible par tous, y compris les scripts, lorsqu'elle est créée dans la bibliothèque.
Propriétés du script			La même instance est visible par tous, y compris les scripts, lorsqu'elle est créée dans la bibliothèque.
Cache			La même instance est visible par tous, y compris les scripts, lorsqu'elle est créée dans la bibliothèque.
Déclencheurs			Les déclencheurs simples créés dans la bibliothèque ne sont pas déclenchés par l'instruction "Inclure" script.
ScriptApp
UiApp
Propriétés utilisateur
Enregistreur et transcription de l'exécution
Sites, Sheets et autres conteneurs			Un appel à getActive() renvoie le conteneur du y compris les scripts.
MailApp et GmailApp
* Cela signifie que la bibliothèque ne possède pas sa propre instance du fonctionnalité/ressource et utilise à la place 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 utilisent la bibliothèque partagent et ont accès à cette sur la même instance.

Tester une bibliothèque

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

Vous devez toujours disposer d'au moins une version de la bibliothèque enregistrées.

Déboguer une bibliothèque

Lorsque vous utilisez le débogueur dans un projet qui inclut une bibliothèque peuvent entrer dans une fonction de la bibliothèque incluse. Le code apparaît dans le débogueur en mode lecture seule et dans la bonne version.