Bibliotecas

Una biblioteca es un proyecto de secuencia de comandos cuyas funciones se pueden volver a utilizar en otras secuencias de comandos.

Advertencia: Una secuencia de comandos que usa una biblioteca no se ejecuta tan rápido como lo haría si todo el código estuviera incluido en un solo proyecto de secuencia de comandos. Aunque las bibliotecas pueden hacer que el desarrollo y el mantenimiento sean más convenientes, úsalas con moderación en proyectos en los que la velocidad es fundamental. Debido a este problema, el uso de la biblioteca debe ser limitado en los complementos.

Cómo obtener acceso a una biblioteca

Para incluir una biblioteca en tu proyecto, debes tener al menos acceso de nivel de vista a ella. Si no eres el autor de la biblioteca que quieres incluir, comunícate con él y solicítale acceso.

Necesitas el ID de la secuencia de comandos de la biblioteca que deseas incluir. Cuando tengas acceso a la biblioteca, podrás encontrar el ID de la secuencia de comandos en la página Configuración del proyecto .

Cómo agregar una biblioteca a tu proyecto de secuencia de comandos

1. A la izquierda del editor de Apps Script, junto a "Bibliotecas", haz clic en Agregar una biblioteca .
2. En el campo "ID de secuencia de comandos", pega el ID de secuencia de comandos de la biblioteca.
3. Haga clic en Buscar.
   Si encuentras un error, asegúrate de tener, al menos, acceso a nivel de vista al proyecto que intentas incluir.
4. Haz clic en el menú desplegable Versión y selecciona la versión de la biblioteca que se usará.
5. Verifica si el nombre del "Identificador" predeterminado es el que deseas usar con esta biblioteca. Este es el nombre que usa la secuencia de comandos para referirse a la biblioteca. Por ejemplo, si lo configuras como Test, puedes llamar a un método de esa biblioteca de la siguiente manera: Test.libraryMethod().
   Si usas un nombre de identificador que coincide con el nombre de un servicio existente, como MailApp, o de una biblioteca agregada con anterioridad, la biblioteca que agregaste más recientemente anulará la existente.
6. Haz clic en Agregar.

Cómo usar una biblioteca

Usa la biblioteca incluida como lo harías con un servicio predeterminado. Por ejemplo, si Test es el identificador de la biblioteca, escribe Test inmediatamente seguido de un punto para ver la lista de métodos de la biblioteca.

Para abrir la documentación de referencia de una biblioteca incluida, sigue estos pasos:

A la izquierda del editor de secuencias de comandos, junto al nombre de la biblioteca, haz clic en Más > Abrir en una pestaña nueva.

Cómo quitar una biblioteca

A la izquierda del editor de secuencias de comandos, junto al nombre de la biblioteca, haz clic en Más > Quitar > Quitar biblioteca.

Si el autor borra una biblioteca, debes quitarla de tu lista de bibliotecas incluidas.

Cómo actualizar una biblioteca

Puedes cambiar la versión de la biblioteca o actualizar su identificador.

1. A la izquierda del editor, en "Bibliotecas", haz clic en el nombre de la biblioteca.
2. Realice los cambios y haga clic en Guardar.

Cómo crear y compartir una biblioteca

Para usar y compartir tu proyecto de secuencia de comandos como una biblioteca, sigue los pasos que se indican a continuación.

1. Crea una implementación con versión de la secuencia de comandos.
2. Compartir, al menos, el acceso a nivel de lectura con todos los usuarios potenciales de la biblioteca
3. Proporciona a esos usuarios el ID de la secuencia de comandos, que se puede encontrar en la página Configuración del proyecto .

Prácticas recomendadas

Estos son algunos lineamientos que debes seguir cuando escribes una biblioteca:

1. Elige un nombre significativo para tu proyecto, ya que se usa como identificador predeterminado cuando otros incluyen tu biblioteca.
2. Si quieres que uno o más métodos de la secuencia de comandos no sean visibles (ni fáciles de usar) para los usuarios de la biblioteca, puedes finalizar el nombre del método con un guion bajo. Por ejemplo, myPrivateMethod_().
3. Los usuarios de la biblioteca solo pueden ver las propiedades globales que se pueden enumerar. Esto incluye declaraciones de funciones, variables creadas fuera de una función con var y propiedades establecidas explícitamente en el objeto global. Por ejemplo, Object.defineProperty() con enumerable configurado como false crea un símbolo que puedes usar en tu biblioteca, pero los usuarios no pueden acceder a él.

4. Si quieres que los usuarios de la biblioteca usen el autocompletado del editor de secuencias de comandos y la documentación generada automáticamente, debes tener documentación al estilo JSDoc para todas tus funciones. Por ejemplo:

   /**
    * 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) { ... }
   

Alcance de los recursos

Cuando trabajas con bibliotecas, hay dos tipos de recursos: compartidos y no compartidos. Un recurso compartido significa que la biblioteca y la secuencia de comandos incluida tienen acceso integrado a la misma instancia del recurso. En el siguiente diagrama, se ilustra un recurso compartido con el ejemplo de Propiedades del usuario:

Un recurso no compartido significa que la biblioteca y la secuencia de comandos de inclusión tienen acceso integrado solo a su instancia del recurso. Sin embargo, una biblioteca puede proporcionar acceso a sus recursos no compartidos a través de funciones explícitas que operan en ellos. A continuación, se muestra un ejemplo de una función que puedes incluir en la biblioteca para exponer sus propiedades de secuencia de comandos:

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

En el siguiente diagrama, se ilustra un recurso no compartido con el ejemplo de propiedades de la secuencia de comandos:

En esta tabla, se enumeran los recursos compartidos y no compartidos para que tengas como referencia:

Recurso	Compartido*	No se comparten**	Notas
Bloquear			La misma instancia es visible para todos, incluidas las secuencias de comandos cuando se crean en la biblioteca.
Propiedades de secuencia de comandos			La misma instancia es visible para todos, incluidas las secuencias de comandos cuando se crean en la biblioteca.
Caché			La misma instancia es visible para todos, incluidas las secuencias de comandos cuando se crean en la biblioteca.
Activadores			Los activadores simples creados en la biblioteca no se activan con la secuencia de comandos de inclusión.
App de secuencia de comandos
App de UI
Propiedades del usuario
Transcripción de la ejecución y del registrador
Sites, Hojas de cálculo y otros contenedores			Una llamada a getActive() muestra el contenedor de la secuencia de comandos de inclusión.
MailApp y GmailApp.
* Esto significa que la biblioteca no tiene su propia instancia de la función o el recurso y, en su lugar, utiliza la que creó la secuencia de comandos que la invocó. ** Esto significa que la biblioteca tiene su propia instancia del recurso o la función y que todas las secuencias de comandos que la usan comparten y tienen acceso a esa misma instancia.

Cómo probar una biblioteca

Para probar tu biblioteca, usa la implementación head. Cualquier persona que tenga acceso de nivel de editor a la secuencia de comandos puede usar la implementación principal.

Aún necesitas al menos una versión de la biblioteca guardada.

Cómo depurar una biblioteca

Cuando usas el depurador en un proyecto que incluye una biblioteca, puedes ingresar a una función de la biblioteca incluida. El código aparece en el depurador en el modo de solo lectura y en la versión correcta.