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 atua como a interface para acessar as 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.
ScriptPropertiesPropriedades do script são pares de chave-valor armazenados por um script em um armazenamento permanente.
UserPropertiesPropriedades 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 no armazenamento Properties atual.
deleteProperty(key)PropertiesExclui a propriedade com a chave fornecida no armazenamento Properties atual.
getKeys()String[]Recebe todas as chaves no armazenamento Properties atual.
getProperties()ObjectRecebe uma cópia de todos os pares de chave-valor no armazenamento atual de Properties.
getProperty(key)StringRecebe o valor associado à chave fornecida no armazenamento Properties atual ou null se essa chave não existir.
setProperties(properties)PropertiesDefine todos os pares de chave-valor do objeto especificado no armazenamento Properties atual.
setProperties(properties, deleteAllOthers)PropertiesDefine todos os pares de chave-valor do objeto especificado no armazenamento Properties atual, opcionalmente excluindo todas as outras propriedades no armazenamento.
setProperty(key, value)PropertiesDefine o par de chave-valor informado no armazenamento de Properties atual.

PropertiesService

Métodos

MétodoTipo de retornoBreve descrição
getDocumentProperties()PropertiesRecebe um armazenamento de propriedades (somente para este script) que todos os usuários podem acessar no documento, planilha ou formulário aberto.
getScriptProperties()PropertiesRecebe um armazenamento de propriedades que todos os usuários podem acessar, mas somente nesse script.
getUserProperties()PropertiesRecebe um armazenamento de propriedades que somente o usuário atual pode acessar e somente nesse script.

ScriptProperties

UserProperties