Bibliotecas

Uma biblioteca é um projeto de script cujas funções podem ser reutilizadas em outros scripts.

Acessar uma biblioteca

Para incluir uma biblioteca no seu projeto, você precisa ter pelo menos acesso de leitura a ela. Se você não for o autor da biblioteca que quer incluir, entre em contato com ele e peça acesso.

Você precisa do ID do script da biblioteca que quer incluir. Quando você tiver acesso à biblioteca, encontre o ID do script na página Configurações do projeto .

Adicionar uma biblioteca ao projeto de script

  1. À esquerda do editor do Apps Script, ao lado de "Bibliotecas", clique em Adicionar uma biblioteca .
  2. No campo "ID do script", cole o ID do script da biblioteca.
  3. Clique em Pesquisar.
  4. Clique no menu suspenso Versão e selecione a versão da biblioteca que você quer usar.
  5. Verifique se o nome padrão "Identifier" é o que você quer usar com essa biblioteca. Esse é o nome que seu script usa para se referir à biblioteca. Por exemplo, se você definir como Test, poderá chamar um método dessa biblioteca da seguinte maneira: Test.libraryMethod().
  6. Clique em Adicionar.

Usar uma biblioteca

Use a biblioteca incluída como se fosse um serviço padrão. Por exemplo, se Test for o identificador da sua biblioteca, digite Test imediatamente seguido por um ponto para ver a lista de métodos na biblioteca.

Para abrir a documentação de referência de uma biblioteca incluída, siga estas etapas:

À esquerda do editor de script, ao lado do nome da biblioteca, clique em Mais > Abrir em uma nova guia.

Remover uma biblioteca

À esquerda do editor de script, ao lado do nome da biblioteca, clique em Mais > Remover > Remover biblioteca.

Atualizar uma biblioteca

Você pode mudar a versão da biblioteca ou atualizar o identificador dela.

  1. À esquerda do editor, em "Bibliotecas", clique no nome da biblioteca.
  2. Faça as mudanças e clique em Salvar.

Criar e compartilhar uma biblioteca

Para usar e compartilhar seu projeto de script como uma biblioteca, siga as etapas abaixo.

  1. Crie uma implantação com controle de versão do seu script.
  2. Compartilhe pelo menos o acesso de visualização com todos os usuários em potencial da biblioteca.
  3. Dê a esses usuários o ID do script, que pode ser encontrado na página Configurações do projeto .

Práticas recomendadas

Confira algumas diretrizes a seguir ao escrever uma biblioteca:

  1. Escolha um nome significativo para seu projeto, já que ele é usado como o identificador padrão quando sua biblioteca é incluída por outras pessoas.
  2. Se você não quiser que um ou mais métodos do seu script sejam visíveis (nem utilizáveis) para os usuários da biblioteca, termine o nome do método com um sublinhado. Por exemplo, myPrivateMethod_().
  3. Apenas propriedades globais enumeráveis ficam visíveis para os usuários da biblioteca. Isso inclui declarações de função, variáveis criadas fora de uma função com var e propriedades definidas explicitamente no objeto global. Por exemplo, Object.defineProperty() com enumerable definido como false cria um símbolo que pode ser usado na sua biblioteca, mas não é acessível aos usuários.

  4. Se quiser que os usuários da sua biblioteca usem o preenchimento automático do editor de script e a documentação gerada automaticamente, você precisa ter documentação no estilo JSDoc para todas as suas funções. Veja um exemplo:

    /**
 * Raises a number to the given power, and returns the result.
 *
 * @param {number} base the number we're raising to a power
 * @param {number} exp the exponent we're raising the base to
 * @return {number} the result of the exponential calculation
 */
function power(base, exp) { ... }

Escopo de recursos

Há dois tipos de recursos ao trabalhar com bibliotecas: compartilhados e não compartilhados. Um recurso compartilhado significa que a biblioteca e o script de inclusão têm acesso integrado à mesma instância do recurso. O diagrama a seguir ilustra um recurso compartilhado usando o exemplo de propriedades do usuário:

Recurso compartilhado

Um recurso não compartilhado significa que a biblioteca e o script de inclusão têm acesso integrado apenas à instância do recurso. No entanto, uma biblioteca pode fornecer acesso aos recursos não compartilhados com funções explícitas que operam neles. Confira um exemplo de função que você incluiria na biblioteca para expor as propriedades de script dela:

  function getLibraryProperty(key) {
    const scriptProperties = PropertiesService.getScriptProperties();
    return scriptProperties.getProperty(key);
  }

O diagrama a seguir ilustra um recurso não compartilhado usando o exemplo de propriedades de script:

Recurso não compartilhado

Esta tabela lista os recursos compartilhados e não compartilhados para sua referência:

Recurso Compartilhada* Não compartilhado** Observações
Bloquear A mesma instância fica visível para todos, incluindo scripts, quando criada na biblioteca.
Propriedades do script A mesma instância fica visível para todos, incluindo scripts, quando criada na biblioteca.
Cache A mesma instância fica visível para todos, incluindo scripts, quando criada na biblioteca.
Gatilhos Gatilhos simples criados na biblioteca não são acionados pelo script incluído.
ScriptApp
UiApp
Propriedades do usuário
Logger e transcrição de execução
Sites, Planilhas e outros contêineres Uma chamada para getActive() retorna o contêiner do incluindo o script.
MailApp e GmailApp
* Isso significa que a biblioteca não tem uma instância própria do recurso e, em vez disso, está usando a criada pelo script que a invocou.
** Isso significa que a biblioteca tem a própria instância do recurso/funcionalidade e que todos os scripts que usam a biblioteca compartilham e têm acesso a essa mesma instância.

Testar uma biblioteca

Para testar sua biblioteca, use a implantação principal. Qualquer pessoa com acesso de editor ao script pode usar a implantação principal.

Depurar uma biblioteca

Ao usar o depurador em um projeto que inclui uma biblioteca, você pode entrar em uma função da biblioteca incluída. O código aparece no depurador no modo somente leitura e na versão correta.