O serviço de propriedades permite armazenar dados simples em pares de chave-valor com escopo para um script, um usuário de um script ou um documento em que um complemento é usado. Ele geralmente é usado para armazenar configurações do desenvolvedor ou preferências do usuário. As propriedades nunca são compartilhadas entre scripts.
Para ver as cotas diárias e os limites de armazenamento do serviço de Propriedades, consulte Cotas do Google Services.
Comparação de lojas de imóveis
O objeto global PropertiesService
oferece três métodos, cada um deles retorna um objeto Properties
semelhante, mas com direitos de acesso diferentes, conforme mostrado na tabela a seguir:
Propriedades do script | Propriedades do usuário | Propriedades do documento | |
---|---|---|---|
Método de acesso | getScriptProperties() |
getUserProperties() |
getDocumentProperties() |
Dados compartilhados entre | Todos os usuários de um script, complemento ou app da Web | O usuário atual de um script, complemento ou app da Web | Todos os usuários de um complemento no documento aberto |
Normalmente usado para | Dados de configuração em todo o app, como nome de usuário e senha do banco de dados externo do desenvolvedor | Configurações específicas do usuário, como unidades métricas ou imperiais | Dados específicos do documento, como o URL de origem de um gráfico incorporado |
Formato de dados
O serviço de propriedades armazena todos os dados como strings em pares de chave-valor. Os tipos de dados que ainda não são strings são convertidos automaticamente em strings, incluindo métodos contidos em objetos salvos.
Economia de dados
Para salvar um único valor, chame o método Properties.setProperty(key,
value)
do armazenamento apropriado, como mostrado no exemplo a seguir:
Para salvar dados em massa, transmita um mapa de pares de chave-valor para
Properties.setProperties(properties)
.
Cada par de chave-valor do objeto no parâmetro é armazenado como uma propriedade separada:
Como ler dados
Para recuperar um único valor salvo anteriormente, chame Properties.getProperty(key)
:
Para recuperar todos os valores no armazenamento de propriedades atual, chame Properties.getProperties()
:
Como modificar dados
Os métodos getProperty()
e getProperties()
retornam uma cópia dos dados armazenados, não uma visualização ao vivo. Portanto, a alteração do objeto retornado não atualiza o valor no armazenamento de propriedades. Para atualizar os dados no armazenamento, basta salvá-los novamente:
Exclusão de dados
Para excluir um único valor, chame Properties.deleteProperty(key)
:
Para excluir todas as propriedades no armazenamento atual, chame Properties.deleteAllProperties()
:
Gerenciar propriedades do script manualmente
É possível adicionar manualmente até 50 propriedades personalizadas, como strings em pares de chave-valor, na página de configurações do projeto. Para adicionar mais de cinquenta propriedades, você precisa adicioná-las de maneira programática usando os métodos descritos acima em Como salvar dados. Ao definir as propriedades do script na página de configurações do projeto, não é possível fazer referência a variáveis de script.
Adicionar propriedades do script
- Abra seu projeto do Apps Script.
- À esquerda, clique em Project Settings
.
- Para adicionar a primeira propriedade, em Propriedades do script, clique em Adicionar propriedade do script.
- Para adicionar uma segunda propriedade e propriedades subsequentes, em Script Properties, clique em Edit script properties > Add script property.
- Em Propriedade, insira o nome da chave.
- Em Valor, insira o valor da chave.
- (Opcional) Para adicionar mais propriedades, clique em Adicionar propriedade do script.
- Clique em Salvar propriedades do script.
Editar propriedades do script
- Abra seu projeto do Apps Script.
- À esquerda, clique em Project Settings
.
- Em Propriedades do script, clique em Editar propriedades do script.
- Faça alterações no nome e no valor da chave de cada propriedade que você quer alterar.
- Clique em Salvar propriedades do script.
Excluir propriedades do script
- Abra seu projeto do Apps Script.
- À esquerda, clique em Project Settings
.
- Em Propriedades do script, clique em Editar propriedades do script.
- Ao lado da propriedade que você quer excluir, clique em Remover .
- Clique em Salvar propriedades do script.