Funções personalizadas no Planilhas Google

As Planilhas Google oferecem centenas de funções integradas, como AVERAGE, SUM e VLOOKUP. Quando eles não forem suficientes para suas necessidades, use o Google Apps Script para escrever funções personalizadas, como converter metros em milhas ou buscar conteúdo ao vivo na Internet, e usá-las nas Planilhas Google como uma função integrada.

Como começar

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

Confira a seguir uma função personalizada simples, chamada DOUBLE, que multiplica um valor de entrada por dois:

/**
 * 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 sabe como escrever em JavaScript e não tem tempo para aprender, consulte a loja de complementos para ver se outra pessoa já criou a função personalizada de que você precisa.

Como criar uma função personalizada

Para escrever uma função personalizada, faça o seguinte:

1. Crie ou abra um arquivo no Planilhas Google.
2. Selecione o item de menu Extensions > 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 receber 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 conhecer esses complementos, faça o seguinte:

1. Crie ou abra um arquivo no Planilhas Google.
2. Na parte superior, clique em Complementos > Instalar complementos.
3. Quando a Google Workspace Marketplace abrir, 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 do seu interesse, clique em Instalar para fazer a instalação.
6. Uma caixa de diálogo pode informar que o complemento exige autorização. Se esse for o caso, leia o aviso com atenção e clique em Permitir.
7. O complemento será disponibilizado na planilha. Para usar o complemento em uma planilha diferente, abra a outra planilha e, na parte superior, clique em Complementos > Gerenciar complementos. Encontre o complemento que você quer usar e clique em Opções > Usar neste documento.

Como usar uma função personalizada

Depois de escrever uma função personalizada ou instalar uma do Google Workspace Marketplace, ela é 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 exibe Loading... por um momento e depois retorna o resultado.

Diretrizes para funções personalizadas

Antes de criar sua própria função personalizada, é preciso conhecer algumas diretrizes.

Nomeação

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

• O nome de uma função personalizada precisa ser diferente dos nomes das 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().
• O uso de letras maiúsculas não importa, embora os nomes das funções de planilha sejam tradicionalmente maiúsculas.

Argumentos

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

• Se você chamar sua 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 sua 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 exemplo de código para DOUBLE acima precisaria ser modificado para aceitar uma matriz como entrada.

  
  

• Os argumentos da função personalizada precisam ser determinísticos. Ou seja, as funções integradas de planilhas que retornam um resultado diferente sempre que fazem cálculos, como NOW() ou RAND(), não são permitidas como argumentos para uma função personalizada. Se uma função personalizada tentar retornar um valor com base em uma dessas funções integradas voláteis, ela exibirá Loading... indefinidamente.

Valores de retorno

Cada função personalizada precisa retornar um valor a ser exibido, de modo que:

• Se uma função personalizada retornar um valor, esse valor será exibido na célula em que a função foi chamada.
• Se uma função personalizada retornar uma matriz bidimensional de valores, os valores transbordarão para células adjacentes, desde que essas células estejam vazias. Se isso fizer com que a matriz substitua o conteúdo da célula, a função personalizada gerará um erro. Para ver um exemplo, consulte a seção sobre como otimizar funções personalizadas.
• Uma função personalizada não pode afetar células além daquelas 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 exibirá um erro: Internal error executing the custom function.

Tipos de dados

O Planilhas Google armazena dados em diferentes formatos, dependendo da natureza dos dados. 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 de confusão mais comuns:

• Os horários e datas no Planilhas Google tornam-se objetos de data 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 no app Planilhas se tornam números decimais no Apps Script. Por exemplo, uma célula com um valor 10% torna-se 0.1 no Apps Script.

Preenchimento automático

As Planilhas Google são compatíveis com o preenchimento automático para funções personalizadas, assim como as funções integradas. Ao digitar um nome de função em uma célula, você verá uma lista de funções integradas e personalizadas que correspondem ao que você inseriu.

As funções personalizadas aparecerão nessa lista se o script incluir uma tag @customfunction 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 executar 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.

Diferentemente da maioria dos outros tipos de Apps Scripts, as funções personalizadas nunca solicitam que os usuários autorizem o acesso a dados pessoais. Por isso, eles só podem chamar serviços que não tenham acesso a dados pessoais, especificamente os seguintes:

Serviços compatíveis	Observações
Cache	Funciona, mas não é particularmente útil em funções personalizadas
HTML	Pode gerar HTML, mas não pode exibi-lo (raramente útil)
JDBC
Idioma
Bloquear	Funciona, mas não é particularmente útil em funções personalizadas
Maps	Pode calcular rotas, mas não exibir mapas
Propriedades	getUserProperties() só consegue 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 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 solicitar autorização do usuário, se necessário, e, consequentemente, usar todos os serviços do Apps Script.

Compartilhamento

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

• Clique em Extensões > Apps Script para abrir o editor de scripts. Depois, copie o texto do script da planilha original e cole-o no editor de outra planilha.
• Faça uma cópia da planilha que contém a função personalizada clicando em Arquivo > Fazer uma cópia. Quando uma planilha é copiada, todos os scripts anexados a ela também são copiados. Qualquer pessoa com acesso à planilha pode copiar o script. Os colaboradores que têm apenas acesso de leitura não podem abrir o editor de script na planilha original. No entanto, ao fazer uma cópia, ele se torna o proprietário da cópia e pode ver o script.
• Publique o script como um complemento do editor das Planilhas Google.

Todos os scripts vinculados a contêineres têm as mesmas listas de acesso que os respectivos contêineres. Isso significa que qualquer pessoa com permissão para editar a planilha pode editar qualquer código do Apps Script anexado a ela.

Otimização

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

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

Por exemplo, a função DOUBLE() mostrada acima pode ser reescrita para aceitar uma única célula ou 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 DOUBLE recursivamente em cada valor na matriz bidimensional de células. Ela retorna uma matriz bidimensional que contém os resultados. Dessa forma, é possível chamar DOUBLE apenas uma vez, mas calcular um grande número de células de uma só vez, como mostrado na captura de tela abaixo. Você pode conseguir o mesmo resultado com instruções if aninhadas em vez da chamada map.

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

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