Estender o Planilhas Google com complementos

O Planilhas Google é uma solução de planilhas baseada na nuvem com colaboração em tempo real e ferramentas avançadas para visualizar, processar e comunicar dados.

É possível estender as Planilhas com complementos que criam melhorias personalizadas no fluxo de trabalho, estabeleça conectividade com sistemas de terceiros e integra os dados das Planilhas a outros aplicativos do Google Workspace (como Apresentações Google).

Você pode ver os complementos do Planilhas que outras pessoas criaram no Google Workspace Marketplace.

O que você pode fazer

Estes são alguns exemplos do que você pode fazer com um complemento que estende o Planilhas Google:

• Você pode ler, editar, visualizar e formatar dados em planilhas Google usando o serviço de planilha do Apps Script integrado. O serviço também permite criar e modificar formatação condicional e regras de validação de dados.
• Você pode usar o serviço avançado das Planilhas do Apps Script para acessar a API Google Sheets diretamente.
• É possível criar menus personalizados e definir várias interfaces de caixas de diálogo e barras laterais personalizadas usando HTML e CSS padrão.
• Você pode incluir definições de função personalizada no seu complemento.
• É possível usar acionadores de complementos que executam funções especificadas quando determinados eventos de acionamento ocorrem.

Os complementos das Planilhas Google são criados usando o Apps Script. Para saber mais sobre como acessar e gerenciar Planilhas Google com o Apps Script, consulte Como estender as Planilhas Google.

Estrutura da página

Uma planilha do Planilhas Google consiste em uma ou mais páginas. Cada página é, basicamente, uma grade de células 2D em que texto, números, links ou outros valores podem ser armazenados. Um grupo com uma ou mais células adjacentes é chamado de intervalo.

O serviço de planilha do Apps Script fornece várias classes para representar estruturas organizacionais no app Planilhas, como Sheet e Range. Você pode usar essas classes para ler e modificar os dados e o comportamento das Planilhas.

Gatilhos

Os acionadores do Apps Script permitem que um projeto de script execute uma função especificada quando determinadas condições são atendidas, como quando uma planilha é aberta ou quando um complemento é instalado.

Consulte o artigo Acionadores de complementos para mais informações sobre quais acionadores podem ser usados com complementos das Planilhas e quais restrições se aplicam ao uso deles.

Funções personalizadas

O Planilhas Google tem várias funções integradas, como SUM e AVERAGE, que podem ser invocadas dentro de uma célula. Os complementos das Planilhas podem definir outras funções personalizadas para complementar essas funções integradas. Quando um usuário instala o complemento, todas as funções personalizadas definidas incluídas nele ficam disponíveis imediatamente. É possível que um complemento consista apenas em definições de função personalizadas. As definições de função personalizadas são compartilhadas principalmente com outras pessoas publicando um complemento contendo as definições.

Como criar funções personalizadas de complementos

Qualquer função definida em um projeto de script de complemento pode ser usada como uma função personalizada. Depois que a função for implementada e o complemento for instalado, você poderá chamar a função personalizada como qualquer outra função integrada do Planilhas: em uma célula da planilha, digite = seguido pelo nome da função e pelos parâmetros necessários. Se não houver erros, o resultado retornado pela função será colocado na célula da planilha, transbordando para células vizinhas conforme necessário.

Ao criar funções personalizadas em um complemento, siga as diretrizes gerais de funções personalizadas:

• Diretrizes de nomenclatura de função
• Como definir argumentos de função
• Como definir o valor de retorno da função
• Tipos de dados de funções personalizadas
• Como ativar o preenchimento automático usando o JSDoc
• As funções personalizadas de serviços podem usar
• Como otimizar funções personalizadas

Além disso, as funções personalizadas definidas em complementos têm algumas considerações especiais:

• Ao nomear a função, tente criar um nome exclusivo, talvez relacionado ao nome do complemento. Se dois ou mais complementos instalados definirem funções personalizadas com o mesmo nome, os usuários só poderão usar um deles.
• Seu complemento precisa informar claramente quais funções personalizadas ele oferece. Envie comentários precisos no JSDoc para as funções personalizadas. Assim, o Apps Script pode apresentar informações de preenchimento automático ao usuário. Além disso, considere fornecer documentação adicional das funções personalizadas no próprio complemento ou em uma página da Web de suporte para ele.
• As funções personalizadas que não são concluídas em menos de 30 segundos falham com um erro Internal error executing the custom function. Crie uma boa experiência do usuário limitando a quantidade de processamento que você faz em uma função personalizada. Otimize a função onde possível.
• As funções personalizadas não podem usar serviços do Apps Script que exigem autorização e falharão com um erro You do not have permission to call X service se isso for tentado. Use apenas os serviços permitidos na sua função personalizada.
• Cada função personalizada em uma página resulta em uma chamada separada para os servidores do Apps Script. Se um usuário tentar usar funções personalizadas em muitas células, as funções poderão ser executadas lentamente. Para atenuar isso, mantenha as funções personalizadas o mais simples possível. Se você precisar que a função execute processamento complexo ou estendido, não use uma função personalizada. Em vez disso, forneça essa funcionalidade por um item de menu, caixa de diálogo ou interação da barra lateral.

Macros das Planilhas

Com as macros, você pode gravar ações realizadas no Planilhas Google e repeti-las mais tarde com um atalho de teclado. Quando uma macro é criada em uma página, ela é adicionada como uma função de macro em um projeto do Apps Script vinculado a essa página. Para mais informações sobre macros, consulte Macros do Planilhas Google.

As macros das Planilhas Google não podem ser distribuídas com complementos. Se você incluir uma definição de macro no manifesto de um complemento, ela ficará indisponível para os usuários desse complemento.