Properties Service

Propriedades

Esse serviço permite que os scripts armazenem strings como pares de chave-valor no escopo de um script, um usuário de um script ou um documento em que um complemento do editor é usado. Para mais informações sobre quando usar cada tipo de propriedade, consulte o guia do serviço de propriedades.

Classes

NomeBreve descrição
PropertiesO objeto de propriedades funciona como a interface para acessar propriedades do usuário, do documento ou do script.
PropertiesServicePermite que os scripts armazenem dados simples em pares de chave-valor no escopo de um script, um usuário de um script ou um documento em que um complemento é usado.
ScriptPropertiesAs propriedades do script são pares de chave-valor armazenados por um script em um armazenamento permanente.
UserPropertiesAs propriedades do usuário são pares de chave-valor exclusivos para um usuário.

Properties

Métodos

MétodoTipo de retornoBreve descrição
deleteAllProperties()PropertiesExclui todas as propriedades na loja Properties atual.
deleteProperty(key)PropertiesExclui a propriedade com a chave especificada na loja Properties atual.
getKeys()String[]Recebe todas as chaves na loja Properties atual.
getProperties()ObjectRecebe uma cópia de todos os pares de chave-valor na loja Properties atual.
getProperty(key)StringConsegue o valor associado à chave especificada na loja Properties atual ou null se essa chave não existir.
setProperties(properties)PropertiesDefine todos os pares de chave-valor do objeto especificado na loja Properties atual.
setProperties(properties, deleteAllOthers)PropertiesDefine todos os pares de chave-valor do objeto especificado na loja Properties atual, opcionalmente excluindo todas as outras propriedades da loja.
setProperty(key, value)PropertiesDefine o par de chave-valor especificado na loja Properties atual.

PropertiesService

Métodos

MétodoTipo de retornoBreve descrição
getDocumentProperties()PropertiesExtrai uma loja de propriedades (somente para este script) que todos os usuários podem acessar no documento, na planilha ou no formulário aberto.
getScriptProperties()PropertiesExtrai uma loja de propriedades que todos os usuários podem acessar, mas apenas neste script.
getUserProperties()PropertiesRetorna um repositório de propriedades que só o usuário atual pode acessar e apenas neste script.

ScriptProperties

UserProperties