Com o serviço de propriedades, você armazena 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. É geralmente são usados para armazenar a configuração do desenvolvedor ou as preferências do usuário. Propriedades nunca são compartilhados entre os scripts.
Para visualizar as cotas diárias e os limites de armazenamento do serviço Properties, consulte Cotas para Serviços do Google.
Comparação de lojas de propriedades
O
PropertiesService
objeto global oferece três métodos, cada um retornando um resultado
Properties
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 |
Usada normalmente para | Dados de configuração do app, como nome de usuário e senha da 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. Tipos de dados que ainda não são strings são convertidos automaticamente em strings, incluindo contidos em objetos salvos.
Economia de dados
Para salvar um único valor, chame o método Properties.setProperty(key,
value)
.
da loja apropriada, 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 um
:
Como ler dados
Para recuperar um único valor que você salvou 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 arquivos
dados, não uma visualização ao vivo, portanto a alteração do objeto retornado não atualizará o valor
no armazenamento de propriedades. Para atualizar os dados na loja, basta salvá-los novamente:
Exclusão de dados
Para excluir um único valor, chame
Properties.deleteProperty(key)
Para excluir todas as propriedades na loja atual, chame
Properties.deleteAllProperties()
Gerenciar propriedades do script manualmente
É possível adicionar manualmente até cinquenta propriedades personalizadas, como strings no valor-chave na página de configurações do projeto. Para adicionar mais de cinquenta propriedades, precisar adicioná-los de maneira programática usando os métodos descritos acima em Salvando dados. Ao definir as propriedades do script na página de configurações do projeto, não é possível variáveis de script de referência.
Adicionar propriedades do script
- Abra seu projeto do Apps Script.
- À esquerda, clique em Configurações do projeto
.
- Para adicionar a primeira propriedade, em Propriedades do script, clique em Adicionar propriedade de script.
- Para adicionar propriedades segunda e subsequentes, em Propriedades do script, clique em Editar as propriedades do script > Adicionar propriedade do script.
- Em Propriedade, insira o nome da chave.
- Em Valor, insira o valor da chave.
- (Opcional) Para adicionar mais propriedades, clique em Adicionar propriedade de script.
- Clique em Salvar propriedades do script.
Editar propriedades do script
- Abra seu projeto do Apps Script.
- À esquerda, clique em Configurações do projeto
.
- Em Propriedades do script, clique em Editar propriedades do script.
- Faça alterações no nome e no valor da chave de cada propriedade.
- Clique em Salvar propriedades do script.
Excluir propriedades do script
- Abra seu projeto do Apps Script.
- À esquerda, clique em Configurações do projeto
.
- 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.