Bibliotecas

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

Cómo obtener acceso a una biblioteca

Para incluir una biblioteca en tu proyecto, debes tener, como mínimo, 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 secuencia de comandos de la biblioteca que deseas incluir. Cuando tengas acceso a la biblioteca, puedes encontrar el ID de secuencia de comandos en la página Configuración del proyecto settings.

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 add.
2. En el campo "ID de secuencia de comandos", pega el ID de secuencia de comandos de la biblioteca.
3. Haz clic en Mirar hacia arriba.
4. Haz clic en el menú desplegable Version (Versión) y selecciona la versión de la biblioteca que quieres usar.
5. Verifica si el nombre predeterminado del "Identificador" es el que quieres usar con esta biblioteca. Este es el nombre que la secuencia de comandos usa para referirse a la biblioteca. Por ejemplo, si lo estableces en Test, puedes llamar a un método de esa biblioteca de la siguiente manera: Test.libraryMethod().
6. Haz clic en Agregar.

Cómo usar una biblioteca

Usa la biblioteca incluida como usarías 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 more_vert > 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 more_vert > Quitar > Quitar biblioteca.

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 utilizar 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 control de versiones de tu secuencia de comandos.
2. Comparte al menos el acceso a nivel de lectura con todos los usuarios potenciales de la biblioteca.
3. Proporciona a esos usuarios el ID de secuencia de comandos, que se encuentra en la página Configuración del proyecto settings.

Prácticas recomendadas

A continuación, se incluyen algunas pautas que se deben seguir para escribir una biblioteca:

1. Elige un nombre significativo para tu proyecto, ya que se usará como identificador predeterminado cuando otras personas incluyan tu biblioteca.
2. Si quieres que uno o más métodos de la secuencia de comandos no sean visibles (ni utilizables) para los usuarios de la biblioteca, puedes terminar el nombre del método con un guion bajo. Por ejemplo, myPrivateMethod_().
3. Solo los usuarios de la biblioteca pueden ver las propiedades globales enumerables. Esto incluye declaraciones de funciones, variables creadas fuera de una función con var y propiedades establecidas 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 los usuarios no pueden acceder a él.

4. Si deseas que los usuarios de tu biblioteca usen el autocompletado del editor de secuencia de comandos y la documentación generada automáticamente, 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 recursos

Existen dos tipos de recursos cuando trabajas con bibliotecas: compartidos y no compartidos. Un recurso compartido significa que tanto la biblioteca como la secuencia de comandos incluida tienen un 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 tanto la biblioteca como 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 mediante funciones explícitas que operan en ellos. Aquí hay 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 secuencias de comandos, incluidas las secuencias de comandos, cuando se crean en la biblioteca.
Propiedades de secuencia de comandos			La misma instancia es visible para todas las secuencias de comandos, incluidas las secuencias de comandos, cuando se crean en la biblioteca.
Caché			La misma instancia es visible para todas las secuencias de comandos, 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.
ScriptApp
UiApp
Propiedades del usuario
Registrador y transcripción de ejecución
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 lo invocó. ** Esto significa que la biblioteca tiene su propia instancia del recurso o la función, y que todas las secuencias de comandos que usan la biblioteca comparten y tienen acceso a esa misma instancia.

Cómo probar una biblioteca

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

Cómo depurar una biblioteca

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