Um script será vinculado a um arquivo do Planilhas, Documentos, Apresentações ou Formulários Google se tiver sido criado a partir desse documento em vez de um script autônomo. O arquivo ao qual um script vinculado está anexado é chamado de "container." Os scripts vinculados geralmente se comportam como scripts independentes, mas não são exibidos no Google Drive. Eles não podem ser removidos 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 esses scripts são quase sempre implantados como apps da Web. Os scripts vinculados ao Planilhas, Documentos, Apresentações ou Formulários 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 em um arquivo do Documentos, do Planilhas ou do Apresentações Google, abra um arquivo no Documentos, no Planilhas ou 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 Google
Para criar um script vinculado no Formulários Google, abra um formulário e clique em Mais > Editor de script. Para reabrir o script no futuro, 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 autônomos não podem:
getActiveSpreadsheet()
,getActiveDocument()
,getActivePresentation()
egetActiveForm()
permitem que os scripts vinculados usem o arquivo pai sem se referir ao ID do arquivo.- A
getUi
permite que scripts vinculados acessem a interface do usuário para o arquivo pai para adicionar menus, caixas de diálogo e barras laterais personalizados. - No Planilhas Google,
getActiveSheet()
,getActiveRange()
egetActiveCell()
permitem que o script determine a página atual, o intervalo de células ou a célula individual selecionada do usuário.setActiveSheet(sheet)
esetActiveRange(range)
permitem que o script altere essas seleções. - No Documentos Google,
getCursor()
egetSelection()
permitem que o script determine a posição do cursor ou do texto selecionado do usuário.setCursor(position)
esetSelection(range)
permitem que o script altere esses locais.
Para saber mais, consulte o guia sobre como estender arquivos do Planilhas Google ou como estender o Documentos Google.
Menus personalizados, caixas de diálogo e barras laterais
Os scripts vinculados podem personalizar as Planilhas, os Documentos e o 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 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 documento.
Complementos
Os complementos são executados no Gmail, no Planilhas Google, no Documentos, no Apresentações e no Formulários. Se você desenvolveu um script vinculado ou independente e quer compartilhá-lo com o mundo, o Apps Script permite publicar seu script como um complemento para que outros usuários possam instalá-lo do repositório 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 editar. Assim 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()
. As funções personalizadas são semelhantes às centenas de
funções integradas no Planilhas,
como AVERAGE
ou
SUM
, exceto pelo fato de que você define
o comportamento da função personalizada.
Acesso a scripts vinculados
Somente usuários que têm permissão para editar um contêiner podem executar o script vinculado. Os colaboradores que só têm acesso para visualização não podem abrir o editor de script. No entanto, se fizerem uma cópia do arquivo pai, eles se tornarão proprietários da cópia e poderão ver e executar uma cópia do script.