Bibliotecas

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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

Obtén acceso a una biblioteca

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

Necesitas el ID de la secuencia de comandos de la biblioteca que quieres 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 "Script ID&quot, pegue el ID de la secuencia de comandos de la biblioteca.
  3. Haz clic en Buscar.
  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 predeterminado "Identifier es el que deseas usar con esta biblioteca. Este es el nombre que usa la secuencia de comandos para hacer referencia 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 Add.

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 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. > Remove > Remove library.

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 control de versiones de tu secuencia de comandos.
  2. Comparte al menos el 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 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 otras personas 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. 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 establecido en false crea un símbolo que puedes usar en tu biblioteca, pero tus usuarios no pueden acceder a este símbolo.
  4. Si quieres que los usuarios de tu biblioteca usen el autocompletado del editor de secuencias 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 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:

Recurso compartido

Un recurso no compartido significa que la biblioteca y la secuencia de comandos incluida tienen acceso integrado solo a su instancia del recurso. Sin embargo, una biblioteca puede proporcionar acceso a sus recursos no compartidos si 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 mediante el ejemplo de propiedades de la secuencia de comandos:

Recurso no compartido

En esta tabla, se enumeran los recursos compartidos y no compartidos para tu referencia:

Recurso Compartido* No compartido** Notas
Bloquear La misma instancia es visible para todas las secuencias de comandos, incluso cuando se crean en la biblioteca.
Propiedades de secuencia de comandos La misma instancia es visible para todas las secuencias de comandos, incluso cuando se crean en la biblioteca.
Caché La misma instancia es visible para todas las secuencias de comandos, incluso cuando se crean en la biblioteca.
Activadores La secuencia de comandos de inclusión no activa los activadores simples creados en la biblioteca.
App de Script
Aplicación de IU
Propiedades del usuario
Transcripción del registrador y la ejecución
Sitios, 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 y, en su lugar, 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 a la secuencia de comandos a nivel de editor puede usar la implementación principal.

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 aparece en el depurador en el modo de solo lectura y en la versión correcta.