Um script será vinculado a um arquivo do Planilhas, Documentos, Apresentações ou Formulários Google se tiver sido criado a partir desse documento, e não como um script independente. O arquivo ao qual um script vinculado é anexado é chamado de "contêiner". Em geral, os scripts vinculados se comportam como independentes. A diferença é que, não aparecem no Google Drive, não podem ser desconectados do arquivo a que estão vinculados e têm alguns privilégios especiais sobre o arquivo pai.
Os scripts também podem ser vinculados ao Google Sites, mas eles são quase sempre implantados como apps da Web. Os scripts vinculados ao Planilhas, Documentos, Apresentações ou Formulários Google também podem se tornar apps da Web, embora isso seja incomum.
Criar um script vinculado
Documentos, Planilhas ou Apresentações Google
Para criar um script vinculado nos apps Documentos, Planilhas ou Apresentações Google, abra um documento 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 a mesma coisa ou abra o script no painel do Apps Script.
Formulários Google
Para criar um script vinculado no Formulários Google, abra um formulário e clique em Mais > Editor de scripts. Para reabrir o script no futuro, faça a mesma coisa ou abra o script no painel do Apps Script.
Métodos especiais
Os scripts vinculados podem chamar alguns métodos que os scripts autônomos não podem:
getActiveSpreadsheet()
,getActiveDocument()
,getActivePresentation()
egetActiveForm()
permitem que os scripts vinculados se refiram ao arquivo pai sem se referir ao ID do arquivo.- O
getUi
permite que 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 do usuário, o intervalo de células selecionado ou a célula individual selecionada.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 Planilhas Google ou o guia para estender documentos Google.
Menus, caixas de diálogo e barras laterais personalizados
Os scripts vinculados podem personalizar os apps Planilhas, Documentos e Formulários Google, adicionando menus personalizados e caixas de diálogo ou barras laterais. No entanto, lembre-se de que um script só pode interagir com a interface do usuário para a instância atual de um arquivo aberto. Ou seja, um script vinculado a um documento não afeta a interface do usuário de outro.
Complementos
Os complementos são executados no Gmail, Planilhas, Documentos, Apresentações e Formulários Google. Se você desenvolveu um script vinculado ou independente e quer compartilhá-lo com outras pessoas, o Apps Script permite publish seu script como um complemento para que outros usuários possam instalá-lo na 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 gatilhos 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()
. As funções personalizadas são semelhantes às centenas de
funções integradas no app Planilhas,
como AVERAGE
ou
SUM
, mas você define
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 do 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.