Um script será vinculado a um arquivo do Planilhas, Documentos, Apresentações ou Formulários Google se tiver sido criado com base nesse documento e não como um script independente. O arquivo ao qual um script vinculado está anexado é chamado de "contêiner". Os scripts vinculados geralmente se comportam como scripts independentes, exceto pelo fato de não aparecerem no Google Drive, não podem ser desanexados do arquivo a que estão vinculados e recebem alguns privilégios especiais sobre o arquivo pai.
Os scripts também podem ser vinculados ao Google Sites, mas eles quase sempre são implantados como apps da Web. Os scripts vinculados a Planilhas, Documentos, Apresentações ou Formulários Google também podem se tornar apps da Web, embora isso não seja comum.
Criar um script vinculado
Documentos, Planilhas ou Apresentações Google
Para criar um script vinculado no Documentos, Planilhas ou Apresentações Google, abra um arquivo no Documentos, uma planilha no Planilhas ou uma apresentação no Apresentações e clique em Extensões > Apps Script. Para reabrir o script no futuro, faça o mesmo ou abra o script no painel do Apps Script.
Formulários
Para criar um script vinculado nos Formulários Google, abra um formulário e clique em Mais > Editor de script. Para reabrir o script, faça o mesmo ou abra o script no painel do Apps Script.
Métodos especiais
Os scripts vinculados podem chamar alguns métodos que os scripts independentes não podem:
getActiveSpreadsheet()
,getActiveDocument()
,getActivePresentation()
egetActiveForm()
permitem que os scripts vinculados se refiram ao arquivo pai sem indicar o ID do arquivo.getUi
permite que os scripts vinculados acessem a interface do usuário do arquivo pai para adicionar menus, caixas de diálogo e barras laterais personalizados.- Nas Planilhas Google,
getActiveSheet()
,getActiveRange()
egetActiveCell()
permitem que o script determine a planilha atual, o intervalo de células selecionado ou a célula individual selecionada do usuário.setActiveSheet(sheet)
esetActiveRange(range)
permitem que o script mude essas seleções. - Nos Documentos Google,
getCursor()
egetSelection()
permitem que o script determine a posição do cursor do usuário ou do texto selecionado.setCursor(position)
esetSelection(range)
permitem que o script mude esses locais.
Para mais informações, consulte o guia para estender as Planilhas Google ou o guia para estender o Documentos Google.
Menus, caixas de diálogo e barras laterais personalizados
Os scripts vinculados podem personalizar Planilhas, Documentos e Formulários Google adicionando menus personalizados e caixas de diálogo ou barras laterais. No entanto, um script só pode interagir com a interface do usuário da instância atual de um arquivo aberto. Ou seja, um script vinculado a um documento não pode afetar a interface do usuário de outro documento.
Complementos
Os complementos podem ser executados no Gmail, Planilhas, Documentos, Apresentações e Formulários Google. Se você desenvolveu um script vinculado ou independente e quer compartilhá-lo com o mundo, o Apps Script permite publish como um complemento para que outros usuários possam instalá-lo da loja de complementos.
Gatilhos
Os scripts vinculados podem usar acionadores simples,
como a função especial onOpen()
, que é executada automaticamente sempre que um arquivo
é aberto por um usuário com acesso para edição. Como todos os tipos de scripts, eles também podem usar acionadores instaláveis.
Funções personalizadas
Uma função personalizada é uma função em um script vinculado ao Planilhas Google que você chama diretamente de uma célula usando a sintaxe =myFunctionName()
. Portanto, as funções personalizadas são semelhantes às centenas de
funções integradas nas Planilhas,
como AVERAGE
ou
SUM
, exceto pelo fato de você definir
o comportamento da função personalizada.
Acesso a scripts vinculados
Somente usuários com permissão para editar um contêiner podem executar o script vinculado. Os colaboradores que têm apenas acesso de leitura não podem abrir o editor de script. No entanto, se fizerem uma cópia do arquivo de contêiner, se tornarão os proprietários da cópia e poderão ver e executar uma cópia do script.
Para saber como compartilhar o arquivo de contêiner de um script, consulte Compartilhar arquivos do Google Drive.