Um script é vinculado a um arquivo do Google Planilhas, Google Docs, Google Apresentações ou Google Formulários se foi criado com base nesse documento, e não como um script independente. O arquivo a que um script vinculado está anexado é chamado de "contêiner". Os scripts vinculados geralmente se comportam como scripts independentes, exceto que não aparecem no Google Drive, não podem ser separados do arquivo a que estão vinculados e ganham alguns privilégios especiais sobre o arquivo principal.
Os scripts também podem ser vinculados ao Google Sites, mas quase sempre são implantados como apps da Web. Scripts vinculados a Planilhas, Documentos, Apresentações ou Formulários também podem se tornar apps da Web, embora isso seja incomum.
Os scripts vinculados são efetivamente complementos do Google Workspace não publicados que funcionam apenas para o arquivo a que estão vinculados.
Criar um script vinculado
É possível criar scripts vinculados no Google Docs, Planilhas, Apresentações e Formulários.
Documentos, Planilhas ou Apresentações
Para criar um script vinculado nos apps Documentos, Planilhas ou Apresentações, abra um documento, uma planilha ou uma apresentação 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, 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.
A ferramenta clasp não pode criar scripts vinculados, mas pode cloná-los e editá-los.
Métodos especiais
Os scripts vinculados podem chamar alguns métodos que os scripts independentes não podem:
getActiveSpreadsheet,getActiveDocument,getActivePresentation, egetActiveFormpermitem que scripts vinculados se refiram ao arquivo principal sem mencionar o ID do arquivo.- O
getUipermite que scripts vinculados acessem a interface do usuário do arquivo principal para adicionar menus, caixas de diálogo e barras laterais personalizados. - Nas Planilhas Google,
getActiveSheet,getActiveRangeegetActiveCellpermitem que o script determine a planilha atual do usuário, o intervalo de células selecionado ou a célula individual selecionada.setActiveSheetesetActiveRangepermitem que o script mude essas seleções. - No Google Docs,
getActiveTab,getCursoregetSelectionpermitem que o script determine a guia atual do usuário, a posição do cursor ou o texto selecionado.setActiveTab,setCursoresetSelectionpermitem que o script mude essas seleções.
Para mais informações, consulte o guia para estender o Planilhas ou o guia para estender o Documentos.
Esses métodos só estão disponíveis para scripts vinculados executados no editor de scripts, itens de menu, caixas de diálogo, barras laterais ou acionadores. Quando um script vinculado é executado como um app da Web ou usando a API Google Apps Script, esses métodos não estão disponíveis.
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. Um script só pode interagir com a interface do usuário da instância atual de um arquivo aberto. Um script vinculado a um documento não pode afetar a interface de outro.
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 de 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 às 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 nas Planilhas, como AVERAGE ou SUM, mas você define o comportamento delas.
Acesso a scripts vinculados
Somente usuários com permissão para editar um contêiner podem executar o script vinculado a ele. Os colaboradores que têm apenas acesso de visualização não podem abrir o editor de script. Se eles fizerem uma cópia do arquivo de contêiner, vão se tornar proprietários dela 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 Drive.
Todos os scripts vinculados ao contêiner usam a mesma lista de acesso de proprietário, leitor e edição definida para o arquivo do contêiner. O proprietário do contêiner assume a propriedade de um novo projeto de script, independente de quem o criou.