Bibliotecas

Una biblioteca es un proyecto de secuencias de comandos cuyas funciones se pueden reutilizar 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 contenido en un solo proyecto de secuencia de comandos. Aunque las bibliotecas pueden hacer que el desarrollo y el mantenimiento sean más convenientes, utilízalos con moderación en proyectos en los que la velocidad es fundamental. Debido a este problema, el uso de la biblioteca debe limitarse en los complementos.

Obtén 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 deseas incluir, comunícate con el autor y solicita 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 .

Agrega 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. Haz 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 deseas usar.
5. Verifica si el nombre "Identificador" predeterminado es el que quieres usar con esta biblioteca. Este es el nombre que usa tu 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 coincida con el nombre de un servicio existente, como MailApp, o una biblioteca ya agregada, la biblioteca que agregaste más recientemente anula la biblioteca o el servicio 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 tu biblioteca, escribe Test seguido de un punto inmediatamente para ver la lista de métodos en 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, deberás quitarla de la lista de bibliotecas incluidas.

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 estos pasos.

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

Prácticas recomendadas

A continuación, se incluyen 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 otras personas incluyen tu biblioteca.
2. Si deseas que los métodos de tu secuencia de comandos no sean visibles (ni usables) para los usuarios de tu biblioteca, puedes finalizar el nombre del método con un guion bajo. Por ejemplo, myPrivateMethod_().
3. Solo los usuarios de la biblioteca 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 configuradas de forma explícita en el objeto global. Por ejemplo, Object.defineProperty() con enumerable configurado como false crea un símbolo que puedes usar en tu biblioteca, pero tus usuarios no pueden acceder a él.

4. Si quieres que tus usuarios de la biblioteca usen el autocompletado del editor de secuencias de comandos y la documentación generada de forma automática, debes tener documentación de 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

Existen dos tipos de recursos cuando trabajas con bibliotecas: compartidas y no compartidas. 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 incluida solo tienen acceso integrado a su instancia del recurso. Sin embargo, una biblioteca puede proporcionar acceso a sus recursos no compartidos, ya que tiene funciones explícitas que operan en ellos. Este es un ejemplo de una función que puedes incluir en tu 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 tu referencia:

Recurso	Compartido*	No compartidos**	Notas
Bloquear			La misma instancia es visible para todas las personas, incluidas las secuencias de comandos, cuando se crean en la biblioteca.
Propiedades de secuencia de comandos			La misma instancia es visible para todas las personas, incluidas las secuencias de comandos, cuando se crean en la biblioteca.
Caché			La misma instancia es visible para todas las personas, incluidas las secuencias de comandos, cuando se crean en la biblioteca.
Activadores			La secuencia de comandos incluida no activa los activadores simples creados en la biblioteca.
App de Script
App de IU
Propiedades del usuario
Registrador y transcripción de la ejecución
Sites, Hojas de cálculo y otros contenedores			Una llamada a getActive() muestra el contenedor de la secuencia de comandos incluida.
MailApp y GmailApp
* Esto significa que la biblioteca no tiene su propia instancia de la función o el recurso, sino que usa 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 principal. 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 entrar en una función de la biblioteca incluida. El código se muestra en el depurador en modo de solo lectura y en la versión correcta.