Scripts vinculados a contêineres

Um script ficará vinculado a um arquivo das 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". Os scripts vinculados geralmente se comportam como scripts independentes, mas não aparecem no Google Drive, não podem ser desanexados do arquivo ao qual 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 são quase sempre implantados como apps da Web. Scripts vinculados a Planilhas, Documentos, Apresentações ou Formulários Google também podem se tornar apps da Web, embora isso seja incomum.

Observação :os scripts vinculados são complementos não publicados que funcionam apenas para o arquivo a que estão vinculados.

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 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 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.

Observação: 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() e getActiveForm() permitem que os scripts vinculados façam referência ao arquivo pai sem fazer referência 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.
• No Planilhas Google, getActiveSheet(), getActiveRange() e getActiveCell() permitem que o script determine a página atual do usuário, o intervalo de células selecionado ou a célula individual selecionada. setActiveSheet(sheet) e setActiveRange(range) permitem que o script mude essas seleções.
• No Documentos Google, getCursor() e getSelection() permitem que o script determine a posição do cursor do usuário ou do texto selecionado. setCursor(position) e setSelection(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 os Documentos Google.

Observação :esses métodos estão disponíveis apenas para scripts vinculados executados no editor de scripts, nos itens de menu, nas caixas de diálogo, nas barras laterais ou nos gatilhos. Quando um script vinculado é executado como um app da Web ou usando a API Apps Script, esses métodos ficam indisponíveis.

Menus, caixas de diálogo e barras laterais personalizados

Os scripts vinculados podem personalizar as Planilhas, os Documentos e os 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 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.

Os complementos também podem adicionar menus, caixas de diálogo e barras laterais personalizados. É recomendável desenvolver complementos usando scripts independentes.

Complementos

Os complementos funcionam 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 publicar o script 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 onOpen() especial, que é executada automaticamente sempre que um arquivo é aberto por um usuário com acesso para edição. Como todos os tipos de script, 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(). Portanto, as funções personalizadas são semelhantes às centenas de funções integradas nas Planilhas, como AVERAGE ou SUM, exceto que 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 de contêiner, eles 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.

Todos os scripts vinculados a contêineres usam a mesma lista de acesso de proprietário, visualizador e editor definida para o arquivo de contêiner. O proprietário do contêiner assume a propriedade de um novo projeto de script, independentemente de quem o criou.