Funciones personalizadas en Hojas de cálculo de Google

Hojas de cálculo de Google ofrece cientos de funciones integradas, como AVERAGE, SUM y VLOOKUP. Cuando estas no sean suficientes para tus necesidades, puedes usar Apps Script de Google para escribir funciones personalizadas, por ejemplo, para convertir metros a millas o obtener contenido en vivo de Internet, y, luego, usarlas en Hojas de cálculo de Google como una función integrada.

Cómo comenzar

Las funciones personalizadas se crean con JavaScript estándar. Si es la primera vez que usas JavaScript, Codecademy ofrece un excelente curso para principiantes. (Nota: Google no desarrolló este curso ni está asociado con él).

Esta es una función personalizada simple, llamada DOUBLE, que multiplica un valor de entrada por 2:

/**
 * Multiplies an input value by 2.
 * @param {number} input The number to double.
 * @return The input multiplied by 2.
 * @customfunction
*/
function DOUBLE(input) {
  return input * 2;
}

Si no sabes cómo escribir JavaScript y no tienes tiempo para aprender, consulta la tienda de complementos para ver si otra persona ya creó la función personalizada que necesitas.

Cómo crear una función personalizada

Para escribir una función personalizada, sigue estos pasos:

1. Crea o abre una hoja de cálculo en Hojas de cálculo de Google.
2. Selecciona el elemento de menú Extensiones > Apps Script.
3. Borra cualquier código que aparezca en el editor de secuencias de comandos. Para la función DOUBLE anterior, simplemente copia y pega el código en el editor de secuencia de comandos.
4. En la parte superior, haz clic en Guardar save.

Ahora puedes usar la función personalizada.

Cómo obtener una función personalizada de

ofrece varias funciones personalizadas como complementos para Hojas de cálculo de Google. Para usar o explorar estos complementos, haz lo siguiente:

1. Crea o abre una hoja de cálculo en Hojas de cálculo de Google.
2. En la parte superior, haz clic en Complementos > Obtener complementos.
3. Una vez que se abra , haz clic en el cuadro de búsqueda que se encuentra en la esquina superior derecha.
4. Escribe "función personalizada" y presiona Intro.
5. Si encuentras un complemento de función personalizada que te interese, haz clic en Instalar para instalarlo.
6. Es posible que un cuadro de diálogo te indique que el complemento requiere autorización. Si es así, lee el aviso detenidamente y, luego, haz clic en Permitir.
7. El complemento estará disponible en la hoja de cálculo. Para usar el complemento en una hoja de cálculo diferente, abre la otra hoja y, en la parte superior, haz clic en Complementos > Administrar complementos. Busca el complemento que quieres usar y haz clic en Opciones more_vert > Usar en este documento.

Cómo usar una función personalizada

Una vez que hayas escrito una función personalizada o instalado una desde, será tan fácil de usar como una función integrada:

1. Haz clic en la celda en la que deseas usar la función.
2. Escribe un signo igual (=) seguido del nombre de la función y cualquier valor de entrada (por ejemplo, =DOUBLE(A1)) y presiona Intro.
3. La celda mostrará Loading... por un momento y, luego, mostrará el resultado.

Lineamientos para las funciones personalizadas

Antes de escribir tu propia función personalizada, debes conocer algunos lineamientos.

Nombre

Además de las convenciones estándar para nombrar funciones de JavaScript, ten en cuenta lo siguiente:

• El nombre de una función personalizada debe ser distinto de los nombres de las funciones integradas, como SUM().
• El nombre de una función personalizada no puede terminar con un guion bajo (_), que indica una función privada en Apps Script.
• El nombre de una función personalizada se debe declarar con la sintaxis function myFunction(), no var myFunction = new Function().
• La mayúscula o minúscula no importa, aunque los nombres de las funciones de la hoja de cálculo suelen escribirse en mayúsculas.

Argumentos

Al igual que una función integrada, una función personalizada puede tomar argumentos como valores de entrada:

• Si llamas a tu función con una referencia a una sola celda como argumento (como =DOUBLE(A1)), el argumento será el valor de la celda.

• Si llamas a tu función con una referencia a un rango de celdas como argumento (como =DOUBLE(A1:B10)), el argumento será un array bidimensional de los valores de las celdas. Por ejemplo, en la siguiente captura de pantalla, Apps Script interpreta los argumentos en =DOUBLE(A1:B2) como double([[1,3],[2,4]]). Ten en cuenta que el código de muestra de DOUBLE anterior debería modificarse para aceptar un array como entrada.

  
  

• Los argumentos de las funciones personalizadas deben ser determinísticos. Es decir, las funciones integradas de la hoja de cálculo que muestran un resultado diferente cada vez que se calculan, como NOW() o RAND(), no se permiten como argumentos de una función personalizada. Si una función personalizada intenta mostrar un valor basado en una de estas funciones integradas volátiles, mostrará Loading... de forma indefinida.

Valores que se muestran

Cada función personalizada debe mostrar un valor, de modo que se cumpla lo siguiente:

• Si una función personalizada muestra un valor, este se muestra en la celda desde la que se llamó a la función.
• Si una función personalizada muestra un array de valores de dos dimensiones, los valores se desbordan en celdas adyacentes, siempre que esas celdas estén vacías. Si esto causa que el array reemplace el contenido de la celda existente, la función personalizada arrojará un error. Para ver un ejemplo, consulta la sección sobre cómo optimizar las funciones personalizadas.
• Una función personalizada no puede afectar a otras celdas que no sean aquellas a las que muestra un valor. En otras palabras, una función personalizada no puede editar celdas arbitrarias, solo las celdas desde las que se llama y sus celdas adyacentes. Para editar celdas arbitrarias, usa un menú personalizado para ejecutar una función.
• Una llamada a función personalizada debe mostrarse en un plazo de 30 segundos. De lo contrario, la celda mostrará #ERROR! y la nota de la celda será Exceeded maximum execution time (line 0)..

Tipos de datos

Hojas de cálculo de Google almacena datos en diferentes formatos según su naturaleza. Cuando se usan estos valores en funciones personalizadas, Apps Script los trata como el tipo de datos apropiado en JavaScript. Estas son las áreas de confusión más comunes:

• Las horas y las fechas de Hojas de cálculo se convierten en objetos Date en Apps Script. Si la hoja de cálculo y la secuencia de comandos usan diferentes zonas horarias (un problema poco frecuente), la función personalizada deberá compensarlo.
• Los valores de duración en Hojas de cálculo también se convierten en objetos Date, pero trabajar con ellos puede ser complicado.
• Los valores de porcentaje en Hojas de cálculo se convierten en números decimales en Apps Script. Por ejemplo, una celda con un valor de 10% se convierte en 0.1 en Apps Script.

Autocompletar

Hojas de cálculo de Google admite el autocompletado para funciones personalizadas, al igual que para las funciones integradas. A medida que escribas un nombre de función en una celda, verás una lista de funciones integradas y personalizadas que coincidan con lo que ingreses.

Las funciones personalizadas aparecerán en esta lista si su secuencia de comandos incluye una etiqueta @customfunction de JsDoc, como en el ejemplo de DOUBLE() que aparece a continuación.

/**
 * Multiplies the input value by 2.
 *
 * @param {number} input The value to multiply.
 * @return The input multiplied by 2.
 * @customfunction
 */
function DOUBLE(input) {
  return input * 2;
}

Avanzado

Cómo usar los servicios de Google Apps Script

Las funciones personalizadas pueden llamar a ciertos servicios de Google Apps Script para realizar tareas más complejas. Por ejemplo, una función personalizada puede llamar al servicio Language para traducir una frase en inglés al español.

A diferencia de la mayoría de los otros tipos de Apps Scripts, las funciones personalizadas nunca les solicitan a los usuarios que autoricen el acceso a los datos personales. Por lo tanto, solo pueden llamar a servicios que no tengan acceso a datos personales, específicamente a los siguientes:

Si tu función personalizada muestra el mensaje de error You do not have permission to call X service., el servicio requiere la autorización del usuario y, por lo tanto, no se puede usar en una función personalizada.

Para usar un servicio que no sea uno de los mencionados anteriormente, crea un menú personalizado que ejecute una función de Apps Script en lugar de escribir una función personalizada. Una función que se activa desde un menú le pedirá autorización al usuario si es necesario y, en consecuencia, puede usar todos los servicios de Apps Script.

Uso compartido

Las funciones personalizadas comienzan vinculadas a la hoja de cálculo en la que se crearon. Esto significa que una función personalizada escrita en una hoja de cálculo no se puede usar en otras, a menos que uses uno de los siguientes métodos:

• Haz clic en Extensiones > Apps Script para abrir el editor de secuencia de comandos y, luego, copia el texto de la secuencia de comandos de la hoja de cálculo original y pégalo en el editor de secuencia de comandos de otra hoja de cálculo.
• Haz una copia de la hoja de cálculo que contiene la función personalizada haciendo clic en Archivo > Crear una copia. Cuando se copia una hoja de cálculo, también se copian las secuencias de comandos que se adjuntan a ella. Cualquier persona que tenga acceso a la hoja de cálculo puede copiar la secuencia de comandos. (Los colaboradores que solo tienen acceso de lectura no pueden abrir el editor de secuencia de comandos en la hoja de cálculo original. Sin embargo, cuando hacen una copia, se convierten en el propietario de la copia y pueden ver la secuencia de comandos).
• Publica la secuencia de comandos como un complemento de Editor de Hojas de cálculo de Google.

Optimización

Cada vez que se usa una función personalizada en una hoja de cálculo, Hojas de cálculo de Google realiza una llamada independiente al servidor de Apps Script. Si tu hoja de cálculo contiene decenas (o cientos o miles) de llamadas a funciones personalizadas, este proceso puede ser bastante lento.

Por lo tanto, si planeas usar una función personalizada varias veces en un rango grande de datos, considera modificar la función para que acepte un rango como entrada en forma de array bidimensional y, luego, devuelva un array bidimensional que pueda desbordarse en las celdas adecuadas.

Por ejemplo, la función DOUBLE() que se muestra arriba se puede volver a escribir para aceptar una sola celda o un rango de celdas de la siguiente manera:

/**
 * Multiplies the input value by 2.
 *
 * @param {number|Array<Array<number>>} input The value or range of cells
 *     to multiply.
 * @return The input multiplied by 2.
 * @customfunction
 */
function DOUBLE(input) {
  return Array.isArray(input) ?
      input.map(row => row.map(cell => cell * 2)) :
      input * 2;
}

El enfoque anterior usa el método map del objeto Array de JavaScript para llamar de forma recursiva a DOUBLE en cada valor del array de celdas de dos dimensiones. Muestra un array bidimensional que contiene los resultados. De esta manera, puedes llamar a DOUBLE solo una vez, pero hacer que calcule una gran cantidad de celdas a la vez, como se muestra en la siguiente captura de pantalla. (podrías lograr lo mismo con sentencias if anidadas en lugar de la llamada a map).

De manera similar, la siguiente función personalizada recupera contenido en vivo de Internet de manera eficiente y usa un array bidimensional para mostrar dos columnas de resultados con una sola llamada a función. Si cada celda requiriera su propia llamada a función, la operación tardaría mucho más tiempo, ya que el servidor de Apps Script tendría que descargar y analizar el feed XML cada vez.

/**
 * Show the title and date for the first page of posts on the
 * Developer blog.
 *
 * @return Two columns of data representing posts on the
 *     Developer blog.
 * @customfunction
 */
function getBlogPosts() {
  var array = [];
  var url = 'https://gsuite-developers.googleblog.com/atom.xml';
  var xml = UrlFetchApp.fetch(url).getContentText();
  var document = XmlService.parse(xml);
  var root = document.getRootElement();
  var atom = XmlService.getNamespace('http://www.w3.org/2005/Atom');
  var entries = document.getRootElement().getChildren('entry', atom);
  for (var i = 0; i < entries.length; i++) {
    var title = entries[i].getChild('title', atom).getText();
    var date = entries[i].getChild('published', atom).getValue();
    array.push([title, date]);
  }
  return array;
}

Estas técnicas se pueden aplicar a casi cualquier función personalizada que se use de forma repetida en una hoja de cálculo, aunque los detalles de la implementación variarán según el comportamiento de la función.