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 son suficientes para tus necesidades, puedes usar Google Apps Script para escribir funciones personalizadas, por ejemplo, para convertir metros a millas o recuperar contenido en vivo de Internet y, luego, usarlas en Hojas de cálculo de Google como si fueran funciones integradas.

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 a é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 código JavaScript y no tienes tiempo para aprender, consulta la tienda de complementos para ver si alguien más 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 secuencias de comandos.
4. En la parte superior, haz clic en Guardar .

Ahora puedes usar la función personalizada.

Cómo obtener una función personalizada de Google Workspace Marketplace

La Google Workspace Marketplace ofrece varias funciones personalizadas comocomplementos 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 Google Workspace Marketplace, haz clic en el cuadro de búsqueda en la esquina superior derecha.
4. Escribe "función personalizada" y presiona Intro.
5. Si encuentras un complemento de funciones personalizadas que te interese, haz clic en Instalar para instalarlo.
6. Es posible que aparezca un cuadro de diálogo que te indique que el complemento requiere autorización. Si es así, lee atentamente el aviso y, luego, haz clic en Permitir.
7. El complemento estará disponible en la hoja de cálculo. Para usar el complemento en otra hoja de cálculo, ábrela y, en la parte superior, haz clic en Complementos > Administrar complementos. Busca el complemento que quieras usar y haz clic en Opciones > Usar en este documento.

Cómo usar una función personalizada

Una vez que escribas una función personalizada o instales una desdeGoogle Workspace Marketplace, será tan fácil de usar como una función integrada:

1. Haz clic en la celda en la que quieres 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, devolverá el resultado.

Lineamientos para 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 diferente de los nombres de las funciones integradas, como SUM().
• El nombre de una función personalizada no puede terminar con un guion bajo (_), que denota 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().
• El uso de mayúsculas no importa, aunque los nombres de las funciones de la hoja de cálculo tradicionalmente se escriben 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 captura de pantalla a continuación, Apps Script interpreta los argumentos en =DOUBLE(A1:B2) como double([[1,3],[2,4]]). Ten en cuenta que el código de muestra para DOUBLE del ejemplo 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 devuelven un resultado diferente cada vez que se calculan, como NOW() o RAND(), no se permiten como argumentos para una función personalizada. Si una función personalizada intenta devolver un valor basado en una de estas funciones integradas volátiles, mostrará Loading... de forma indefinida.

Valores de retorno

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

• Si una función personalizada devuelve un valor, este se muestra en la celda desde la que se llamó a la función.
• Si una función personalizada devuelve un array bidimensional de valores, estos se desbordan en las celdas adyacentes, siempre y cuando estén vacías. Si esto hiciera que el array sobrescribiera el contenido de las celdas existentes, la función personalizada generará un error. Para ver un ejemplo, consulta la sección sobre cómo optimizar funciones personalizadas.
• Una función personalizada no puede afectar a las celdas que no sean aquellas en las que devuelve un valor. En otras palabras, una función personalizada no puede editar celdas arbitrarias, solo las celdas desde las que se llama y las celdas adyacentes. Para editar celdas arbitrarias, usa un menú personalizado para ejecutar una función.
• Una llamada a una función personalizada debe devolver un resultado en un plazo de 30 segundos. Si no es así, la celda muestra #ERROR! y la nota de la celda es Exceeded maximum execution time (line 0)..

Tipos de datos

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

• Las horas y las fechas en Hojas de cálculo se convierten en objetos Date en Apps Script. Si la hoja de cálculo y la secuencia de comandos usan zonas horarias diferentes (un problema poco común), la función personalizada deberá compensar la diferencia.
• 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 las funciones personalizadas, al igual que para las funciones integradas. A medida que escribes el nombre de una función en una celda, verás una lista de funciones integradas y personalizadas que coinciden con lo que ingresas.

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

/**
 * 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

Uso de 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 datos personales. Por lo tanto, solo pueden llamar a servicios que no tienen acceso a datos personales, específicamente los siguientes:

Servicios compatibles	Notas
Caché	Funciona, pero no es particularmente útil en las funciones personalizadas
HTML	Puede generar HTML, pero no mostrarlo (rara vez es útil).
JDBC
Idioma
Bloquear	Funciona, pero no es particularmente útil en las funciones personalizadas
Maps	Puede calcular instrucciones sobre cómo llegar, pero no mostrar mapas
Propiedades	getUserProperties() solo obtiene las propiedades del propietario de la hoja de cálculo. Los editores de hojas de cálculo no pueden establecer propiedades del usuario en una función personalizada.
Spreadsheet	Solo lectura (puede usar la mayoría de los métodos de get*(), pero no set*()). No puede abrir otras hojas de cálculo (SpreadsheetApp.openById() o SpreadsheetApp.openByUrl()).
URL Fetch
Utilidades
XML

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

Para usar un servicio que no se encuentre en la lista anterior, 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, podrá 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 hojas de cálculo, a menos que uses uno de los siguientes métodos:

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

Todas las secuencias de comandos vinculadas a contenedores tienen las mismas listas de acceso que sus contenedores. Esto significa que

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 docenas (o cientos, o miles) de llamadas a funciones personalizadas, este proceso puede ser bastante lento. Es posible que algunos proyectos con muchas funciones personalizadas o funciones personalizadas complejas experimenten una demora temporal en las ejecuciones.

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

Por ejemplo, la función DOUBLE() que se muestra arriba se puede volver a escribir para que acepte 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 aplicar un método en el array bidimensional de celdas y obtener cada fila. Luego, para cada fila, vuelve a usar map para devolver el doble del valor de cada celda. Devuelve 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 instrucciones if anidadas en lugar de la llamada a map).

Del mismo modo, la siguiente función personalizada recupera de manera eficiente contenido en vivo de Internet y usa un array bidimensional para mostrar dos columnas de resultados con una sola llamada a la función. Si cada celda requiriera su propia llamada a la 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 repetidamente en una hoja de cálculo, aunque los detalles de implementación variarán según el comportamiento de la función.