Funções personalizadas no Planilhas Google

As Planilhas Google oferecem centenas de funções integradas, como AVERAGE, SUM e VLOOKUP. Quando isso não for suficiente para suas necessidades, use o Google Apps Script para escrever funções personalizadas, por exemplo, para converter metros em milhas ou buscar conteúdo ao vivo da Internet. Em seguida, use-as nas Planilhas Google como uma função integrada.

Primeiros passos

As funções personalizadas são criadas usando o JavaScript padrão. Se você não tem experiência com JavaScript, a Codecademy oferece um ótimo curso para iniciantes. Observação: este curso não foi desenvolvido nem está associado ao Google.

Esta é uma função personalizada simples, chamada DOUBLE, que multiplica um 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;
}

Se você não souber como escrever JavaScript e não tiver tempo para aprender, confira a loja de complementos para ver se outra pessoa já criou a função personalizada que você precisa.

Como criar uma função personalizada

Para escrever uma função personalizada:

  1. Crie ou abra uma planilha no app Planilhas Google.
  2. Selecione o item de menu Extensões > Apps Script.
  3. Exclua qualquer código no editor de script. Para a função DOUBLE acima, basta copiar e colar o código no editor de script.
  4. Na parte superior, clique em Salvar .

Agora você pode usar a função personalizada.

Como acessar uma função personalizada do Google Workspace Marketplace

O Google Workspace Marketplace oferece várias funções personalizadas como complementos para as Planilhas Google. Para usar ou conferir estes complementos:

  1. Crie ou abra uma planilha no app Planilhas Google.
  2. Na parte de cima, clique em Complementos > Instalar complementos.
  3. Quando o Google Workspace Marketplace for aberto, clique na caixa de pesquisa no canto superior direito.
  4. Digite "função personalizada" e pressione Enter.
  5. Se você encontrar um complemento de função personalizada que lhe interessar, clique em Instalar para fazer a instalação.
  6. Uma caixa de diálogo pode informar que o complemento requer autorização. Se sim, leia o aviso com atenção e clique em Permitir.
  7. O complemento fica disponível na planilha. Para usar o complemento em uma planilha diferente, abra a outra planilha e, na parte de cima, clique em complementos > Gerenciar complementos. Encontre o complemento que você quer usar e clique em Opções > Usar neste documento.

Usar uma função personalizada

Depois de escrever uma função personalizada ou instalar uma do Google Workspace Marketplace, ela fica tão fácil de usar quanto uma função integrada:

  1. Clique na célula em que você quer usar a função.
  2. Digite um sinal de igual (=) seguido pelo nome da função e qualquer valor de entrada (por exemplo, =DOUBLE(A1)) e pressione Enter.
  3. A célula vai mostrar Loading... por um momento e depois retornar o resultado.

Diretrizes para funções personalizadas

Antes de escrever sua própria função personalizada, conheça algumas diretrizes.

Nomeação

Além das convenções padrão para nomear funções JavaScript, observe o seguinte:

  • O nome de uma função personalizada precisa ser diferente dos nomes de funções integradas, como SUM().
  • O nome de uma função personalizada não pode terminar com um sublinhado (_), que indica uma função particular no Apps Script.
  • O nome de uma função personalizada precisa ser declarado com a sintaxe function myFunction(), não var myFunction = new Function().
  • A diferenciação entre maiúsculas e minúsculas não importa, embora os nomes das funções de planilha sejam tradicionalmente em maiúsculas.

Argumentos

Assim como uma função integrada, uma função personalizada pode receber argumentos como valores de entrada:

  • Se você chamar a função com uma referência a uma única célula como argumento (como =DOUBLE(A1)), o argumento será o valor da célula.

  • Se você chamar a função com uma referência a um intervalo de células como um argumento (como =DOUBLE(A1:B10)), o argumento será uma matriz bidimensional dos valores das células. Por exemplo, na captura de tela abaixo, os argumentos em =DOUBLE(A1:B2) são interpretados pelo Apps Script como double([[1,3],[2,4]]). O código de exemplo para DOUBLE acima precisa ser modificado para aceitar uma matriz como entrada.


  • Os argumentos de função personalizados precisam ser determinísticos. Ou seja, funções de planilha integradas que retornam um resultado diferente a cada cálculo, como NOW() ou RAND(), não são permitidas como argumentos de uma função personalizada. Se uma função personalizada tentar retornar um valor com base em uma dessas funções integradas voláteis, ela vai mostrar Loading... indefinidamente.

Valores de retorno

Todas as funções personalizadas precisam retornar um valor para exibição, como:

  • Se uma função personalizada retornar um valor, ele será exibido na célula de onde a função foi chamada.
  • Se uma função personalizada retornar uma matriz bidimensional de valores, os valores vão transbordar para células adjacentes, desde que estejam vazias. Se isso fizer com que a matriz substitua o conteúdo das células, a função personalizada gerará um erro. Para conferir um exemplo, consulte a seção sobre como otimizar funções personalizadas.
  • Uma função personalizada não pode afetar outras células, exceto aquelas para as quais ela retorna um valor. Em outras palavras, uma função personalizada não pode editar células arbitrárias, apenas as células de onde ela é chamada e as células adjacentes. Para editar células arbitrárias, use um menu personalizado para executar uma função.
  • Uma chamada de função personalizada precisa retornar em até 30 segundos. Caso contrário, a célula vai mostrar #ERROR! e a nota da célula será Exceeded maximum execution time (line 0)..

Tipos de dados

O Planilhas Google armazena dados em formatos diferentes, dependendo da natureza deles. Quando esses valores são usados em funções personalizadas, o Apps Script os trata como o tipo de dados apropriado em JavaScript. Estas são as áreas mais comuns de confusão:

  • As horas e datas nas Planilhas se tornam objetos Date no Apps Script. Se a planilha e o script usarem fusos horários diferentes (um problema raro), a função personalizada precisará compensar.
  • Os valores de duração nas Planilhas também se tornam objetos Date, mas trabalhar com eles pode ser complicado.
  • Os valores percentuais nas Planilhas se tornam números decimais no Apps Script. Por exemplo, uma célula com um valor de 10% se torna 0.1 no Apps Script.

Preenchimento automático

O app Planilhas Google oferece suporte ao preenchimento automático para funções personalizadas, assim como para funções integradas. Ao digitar o nome de uma função em uma célula, você vai ver uma lista de funções padrão e personalizadas que correspondem ao que você digitou.

As funções personalizadas vão aparecer nessa lista se o script incluir uma tag @customfunction do JsDoc, como no exemplo DOUBLE() abaixo.

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

Avançado

Como usar os serviços do Google Apps Script

As funções personalizadas podem chamar determinados serviços do Google Apps Script para realizar tarefas mais complexas. Por exemplo, uma função personalizada pode chamar o serviço Language para traduzir uma frase em inglês para o espanhol.

Ao contrário da maioria dos outros tipos de Apps Script, as funções personalizadas nunca pedem aos usuários que autorizem o acesso a dados pessoais. Consequentemente, eles só podem chamar serviços que não têm acesso a dados pessoais, especificamente os seguintes:

Serviços compatíveis Observações
Cache Funciona, mas não é muito útil em funções personalizadas
HTML Gera HTML, mas não o exibe (raramente útil)
JDBC
Idioma
Bloquear Funciona, mas não é muito útil em funções personalizadas
Maps Pode calcular rotas, mas não mostrar mapas
Propriedades getUserProperties() só recebe as propriedades do proprietário da planilha. Os editores de planilhas não podem definir propriedades do usuário em uma função personalizada.
Planilha Somente leitura (pode usar a maioria dos métodos get*(), mas não set*()).
Não é possível abrir outras planilhas (SpreadsheetApp.openById() ou SpreadsheetApp.openByUrl()).
Busca de URL
Utilitários
XML

Se a função personalizada gerar a mensagem de erro You do not have permission to call X service., o serviço vai exigir a autorização do usuário e, portanto, não poderá ser usado em uma função personalizada.

Para usar um serviço diferente dos listados acima, crie um menu personalizado que execute uma função do Apps Script em vez de escrever uma função personalizada. Uma função acionada por um menu vai pedir autorização ao usuário, se necessário, e poderá usar todos os serviços do Apps Script.

Compartilhamento

As funções personalizadas começam vinculadas à planilha em que foram criadas. Isso significa que uma função personalizada gravada em uma planilha não pode ser usada em outras, a menos que você use um dos seguintes métodos:

  • Clique em Extensões > Apps Script para abrir o editor de script e copie o texto do script da planilha original e cole no editor de script de outra planilha.
  • Para fazer uma cópia da planilha que contém a função personalizada, clique em Arquivo > Fazer uma cópia. Quando uma planilha é copiada, os scripts anexados a ela também são copiados. Qualquer pessoa com acesso à planilha pode copiar o script. Os colaboradores com acesso de leitura não podem abrir o editor de script na planilha original. No entanto, quando eles fazem uma cópia, eles se tornam o proprietário da cópia e podem acessar o script.)
  • Publique o script como um complemento do editor das Planilhas Google.

Otimização

Sempre que uma função personalizada é usada em uma planilha, o app Planilhas Google faz uma chamada separada para o servidor do Apps Script. Se a planilha tiver dezenas (ou centenas ou milhares!) de chamadas de função personalizadas, esse processo pode ser bastante lento.

Consequentemente, se você planeja usar uma função personalizada várias vezes em um grande intervalo de dados, considere modificar a função para que ela aceite um intervalo como entrada na forma de uma matriz bidimensional e, em seguida, retorne uma matriz bidimensional que pode transbordar para as células adequadas.

Por exemplo, a função DOUBLE() mostrada acima pode ser reescrita para aceitar uma única célula ou um intervalo de células da seguinte maneira:

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

A abordagem acima usa o método map do objeto Array do JavaScript para chamar recursivamente DOUBLE em cada valor na matriz bidimensional de células. Ele retorna uma matriz bidimensional que contém os resultados. Dessa forma, você pode chamar DOUBLE apenas uma vez, mas calcular um grande número de células de uma vez, conforme mostrado na captura de tela abaixo. Você pode fazer a mesma coisa com instruções if anexadas em vez da chamada map.

Da mesma forma, a função personalizada abaixo busca conteúdo em tempo real da Internet e usa uma matriz bidimensional para mostrar duas colunas de resultados com apenas uma chamada de função. Se cada célula exigisse uma chamada de função própria, a operação levaria muito mais tempo, já que o servidor do Apps Script precisaria fazer o download e analisar o feed XML toda 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;
}

Essas técnicas podem ser aplicadas a quase qualquer função personalizada usada repetidamente em uma planilha, embora os detalhes da implementação variem dependendo do comportamento da função.