O Google Apps Script permite que você faça coisas novas e legais com o Planilhas Google. Você pode usar o Apps Script para adicionar menus personalizados, caixas de diálogo e barras laterais às Planilhas Google. Ele também permite escrever funções personalizadas para Planilhas e integrar as Planilhas a outros Serviços do Google, como Agenda, Drive e Gmail.
A maioria dos scripts projetados para o Planilhas Google manipula matrizes para interagir com as células, linhas e colunas em uma planilha. Se você não tem familiaridade com matrizes em JavaScript, o Codecademy oferece um ótimo módulo de treinamento para matrizes. Este curso não foi desenvolvido nem 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.
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 amplas: qualquer script poderá criar ou modificar uma planilha se o usuário tiver as permissões apropriadas, e um script também poderá ser vinculado a uma planilha, o que dá ao script habilidades especiais para alterar a interface do usuário ou responder quando a planilha for aberta. Para criar um script vinculado, selecione Extensões > Apps Script nas Planilhas Google.
O serviço de planilhas trata as Planilhas Google como uma grade, operando com matrizes bidimensionais. Para recuperar os dados, você precisa ter acesso à planilha em que os dados estão armazenados, obter o intervalo na planilha que contém os dados e, em seguida, obter 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
Suponha que você tenha uma lista de nomes e números de produtos que você armazena em uma planilha, conforme mostrado na imagem abaixo.
No exemplo abaixo, mostramos como recuperar e registrar os nomes e números dos 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]);
}
}
Ler registros
Para ver os dados registrados, clique em Registro de execução na parte superior do editor de scripts.
Como gravar dados
Para armazenar dados, como um novo nome e número de produto à 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, verá uma nova linha adicionada à planilha.
Menus e interfaces do usuário personalizados
Você pode personalizar as Planilhas Google adicionando menus, caixas de diálogo e barras laterais personalizados. Para aprender os conceitos básicos da criação de menus, consulte o guia de menus. Para saber mais sobre como personalizar o conteúdo de uma caixa de diálogo, consulte o guia para 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 no desenho. Saiba mais em Imagens e desenhos no app 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 ao Formulários Google
O Apps Script permite que você conecte Formulários Google ao Planilhas Google usando os serviços do Formulários e do 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 acionadores, como
onFormSubmit, para executar uma ação específica depois que um usuário responde ao formulário.
Para saber mais sobre como conectar Planilhas Google ao Formulários Google, consulte o guia de início rápido de cinco minutos Como gerenciar respostas para Formulários Google.
Formatação
A classe Range tem métodos como
setBackground(color)
para acessar e modificar o formato de uma célula ou intervalo de células. O exemplo
abaixo mostra como definir o estilo da 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 Planilhas Google ou criar novas regras. Veja no exemplo a seguir como definir uma regra de validação de dados que permita somente 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 em uma planilha que representam os dados em um intervalo específico. O exemplo a seguir gera um gráfico de barras incorporado, 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 à planilha, consulte EmbeddedChart e criadores de gráficos específicos, como EmbeddedPieChartBuilder.
Funções personalizadas nas Planilhas Google
Uma função personalizada é semelhante a uma
função de planilha integrada, como =SUM(A1:A5), mas você define o
comportamento das funções com o Apps Script. Por exemplo, é possível criar uma função personalizada, in2mm(), que converte um valor de polegadas para milímetros e usar a fórmula na sua planilha digitando =in2mm(A1) ou =in2mm(10) em uma célula.
Para saber mais sobre funções personalizadas, confira o guia de início rápido de cinco minutos Menus e funções personalizadas ou confira o guia mais detalhado sobre funções personalizadas.
Macros
As macros são outra forma de executar códigos do Apps Script na IU do Planilhas Google. Ao contrário das funções personalizadas, você as ativa com um atalho de teclado ou pelo menu das 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 especialmente que são executados no Planilhas Google e podem ser instalados na loja de complementos do Planilhas Google. Se você desenvolveu um script para Planilhas Google e quer compartilhá-lo com o mundo, o Apps Script permite que você publique seu script como um complemento para que outros usuários possam instalá-lo da loja de complementos.
Gatilhos
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 edição abre ou edita a planilha.
Como acionadores simples, os acionadores instaláveis permitem que o Planilhas Google execute uma função automaticamente quando um determinado evento ocorre. No entanto, os acionadores instaláveis oferecem mais flexibilidade do que os simples e são compatíveis com os seguintes eventos: abrir, editar, alterar, enviar formulário e orientado por tempo (relógio).