O Google Apps Script permite que você faça coisas novas e legais com o app Planilhas Google. Você pode usar o Apps Script para adicionar menus personalizados, caixas de diálogo e barras laterais ao Planilhas Google. Também é possível criar funções personalizadas para o Planilhas e integrá-lo a outros serviços do Google, como Agenda, Drive e Gmail.
A maioria dos scripts criados nas Planilhas Google manipula matrizes para interagir com as células, linhas e colunas de uma planilha. Se você não conhece bem as matrizes em JavaScript, o Codecademy oferece um ótimo módulo de treinamento para matrizes. Este curso não foi desenvolvido e não está associado ao Google.
Para uma introdução rápida ao uso do Apps Script com o Planilhas Google, consulte o guia de início rápido de cinco minutos sobre macros, menus e funções personalizadas.
Para começar
O Apps Script inclui APIs especiais para permitir que você crie, leia e edite Planilhas Google de forma programática. O Apps Script pode interagir com o Planilhas Google de duas maneiras: qualquer script pode criar ou modificar uma planilha se o usuário do script tiver as permissões apropriadas para ela, e um script também puder ser vinculado a uma planilha, o que concede ao script recursos especiais para alterar a interface do usuário ou responder quando a planilha é aberta. Para criar um script vinculado, selecione Extensões > Apps Script no Planilhas Google.
O serviço de planilhas trata o Planilhas Google como uma grade que funciona com matrizes bidimensionais. Para recuperar os dados da planilha, você precisa ter acesso à planilha em que os dados estão armazenados, acessar o intervalo na planilha que contém os dados e, em seguida, receber os valores das células. O Apps Script facilita o acesso aos dados lendo dados estruturados na planilha e criando objetos JavaScript para eles.
Como ler dados
Imagine que você tenha uma lista de nomes de produtos e números de produtos armazenados em uma planilha, conforme mostrado na imagem abaixo.
O exemplo abaixo mostra como recuperar e registrar os nomes e números de produtos.
function logProductInfo() {
var sheet = SpreadsheetApp.getActiveSheet();
var data = sheet.getDataRange().getValues();
for (var i = 0; i < data.length; i++) {
Logger.log('Product name: ' + data[i][0]);
Logger.log('Product number: ' + data[i][1]);
}
}
Ver registros
Para ver os dados que foram registrados, na parte superior do editor de scripts, clique em Registro de execução.
Como gravar dados
Para armazenar dados, como um novo nome de produto e um número na planilha, adicione o seguinte código ao final do script.
function addProduct() {
var sheet = SpreadsheetApp.getActiveSheet();
sheet.appendRow(['Cotton Sweatshirt XL', 'css004']);
}
O código acima anexa uma nova linha na parte inferior da planilha, com os valores especificados. Se você executar essa função, uma nova linha será adicionada à planilha.
Menus personalizados e interfaces do usuário
Para personalizar as Planilhas Google, adicione menus, caixas de diálogo e barras personalizadas. Para aprender os conceitos básicos da criação de menus, consulte o guia de menus. Para saber como personalizar o conteúdo de uma caixa de diálogo, consulte o guia sobre o serviço HTML.
Você também pode anexar uma função de script a uma imagem ou desenho em uma planilha. A função será executada quando um usuário clicar na imagem ou desenho. Saiba mais em Imagens e desenhos no Planilhas Google.
Se você planeja publicar sua interface personalizada como parte de um complemento, siga o guia de estilo para manter a consistência com o estilo e o layout do editor do Planilhas Google.
Como se conectar aos Formulários Google
Com o Apps Script, é possível conectar arquivos do Formulários ao Planilhas Google usando os serviços Formulários e Planilhas. Esse recurso pode criar automaticamente um arquivo do Formulários Google com base nos dados de uma planilha.
O Apps Script também permite usar gatilhos, como onFormSubmit, para executar uma ação específica depois que um usuário responde ao formulário.
Para saber mais sobre como conectar as Planilhas Google aos Formulários Google, consulte o guia de início rápido de como gerenciar respostas dos Formulários Google de cinco minutos.
Formatação
A classe Range tem métodos como
setBackground(color)
para acessar e modificar o formato de uma célula ou um intervalo de células. O exemplo
abaixo mostra como definir o estilo de fonte de um intervalo:
function formatMySpreadsheet() {
// Set the font style of the cells in the range of B2:C2 to be italic.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var cell = sheet.getRange('B2:C2');
cell.setFontStyle('italic');
}
Validação de dados
Com o Apps Script, é possível acessar regras de validação de dados no app Planilhas Google ou criar regras. O exemplo a seguir mostra como definir uma regra de validação de dados que permite apenas números entre 1 e 100 em uma célula.
function validateMySpreadsheet() {
// Set a rule for the cell B4 to be a number between 1 and 100.
var cell = SpreadsheetApp.getActive().getRange('B4');
var rule = SpreadsheetApp.newDataValidation()
.requireNumberBetween(1, 100)
.setAllowInvalid(false)
.setHelpText('Number must be between 1 and 100.')
.build();
cell.setDataValidation(rule);
}
Para mais detalhes sobre como trabalhar com regras de validação de dados, consulte
SpreadsheetApp.newDataValidation(),
DataValidationBuilder
e Range.setDataValidation(rule).
Gráficos
Com o Apps Script, é possível incorporar gráficos a uma planilha que representam os dados de um intervalo específico. No exemplo a seguir, um gráfico de barras incorporado é gerado, supondo que você tenha dados gráficos nas células A1:B15:
function newChart() {
// Generate a chart representing the data in the range of A1:B15.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var chart = sheet.newChart()
.setChartType(Charts.ChartType.BAR)
.addRange(sheet.getRange('A1:B15'))
.setPosition(5, 5, 0, 0)
.build();
sheet.insertChart(chart);
}
Para saber mais sobre como incorporar um gráfico à sua planilha, consulte EmbeddedChart e criadores de gráficos específicos, como EmbeddedPieChartBuilder.
Funções personalizadas no Planilhas Google
Uma função personalizada é semelhante a uma função de planilha integrada, como =SUM(A1:A5), mas você define o comportamento da função com o Apps Script. Por exemplo, é possível criar uma função personalizada, in2mm(), que converte um valor de polegadas em milímetros e, em seguida, usar a fórmula em sua planilha digitando =in2mm(A1) ou =in2mm(10) em uma célula.
Para saber mais sobre funções personalizadas, consulte o guia de início rápido de Menus e funções personalizadas (em inglês) de cinco minutos ou confira o guia sobre funções personalizadas mais detalhado.
Macros
As macros são outra forma de executar o código do Apps Script na IU do Planilhas Google. Ao contrário das funções personalizadas, elas são ativadas com um atalho no teclado ou no menu do Planilhas Google. Para mais informações, consulte Macros do Planilhas Google.
Complementos para o Planilhas Google
Os complementos são projetos do Apps Script empacotados que são executados no Planilhas Google e podem ser instalados a partir da loja de complementos do Planilhas Google. Se você desenvolveu um script para o Planilhas Google e quer compartilhá-lo com o mundo, o Apps Script permite publicá-lo como um complemento para que outros usuários possam instalá-lo na loja de complementos.
Acionadores
Os scripts vinculados a um arquivo das Planilhas Google podem usar acionadores simples, como as funções onOpen() e onEdit(), para responder automaticamente quando um usuário com acesso para editar a planilha abrir ou editar a planilha.
Assim como os acionadores simples, os acionadores instaláveis permitem que o Planilhas Google execute uma função automaticamente quando ocorre um determinado evento. No entanto, os acionadores instaláveis oferecem mais flexibilidade do que os simples e permitem os seguintes eventos: abrir, editar, alterar, enviar formulário e orientado por tempo (relógio).