Properties Service

Propriedades

Esse serviço permite que os scripts armazenem strings como pares de chave-valor com escopo para 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 Properties.

Classes

Nome	Breve descrição
Properties	O objeto de propriedades atua como a interface para acessar as propriedades do usuário, do documento ou do script.
PropertiesService	Permite que os scripts armazenem 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.
ScriptProperties	As propriedades do script são pares de chave-valor armazenados por um script em um armazenamento persistente.
UserProperties	As propriedades do usuário são pares de chave-valor exclusivos de um usuário.

Properties

Métodos

Método	Tipo de retorno	Breve descrição
deleteAllProperties()	Properties	Exclui todas as propriedades no armazenamento Properties atual.
deleteProperty(key)	Properties	Exclui a propriedade com a chave especificada no repositório Properties atual.
getKeys()	String[]	Recebe todas as chaves no armazenamento Properties atual.
getProperties()	Object	Recebe uma cópia de todos os pares de chave-valor no armazenamento Properties atual.
getProperty(key)	String	Recebe o valor associado à chave especificada no armazenamento Properties atual ou null se essa chave não existir.
setProperties(properties)	Properties	Define todos os pares de chave-valor do objeto especificado no armazenamento Properties atual.
setProperties(properties, deleteAllOthers)	Properties	Define todos os pares de chave-valor do objeto especificado no armazenamento Properties atual, excluindo opcionalmente todas as outras propriedades no armazenamento.
setProperty(key, value)	Properties	Define o par de chave-valor especificado no armazenamento Properties atual.

PropertiesService

Métodos

Método	Tipo de retorno	Breve descrição
getDocumentProperties()	Properties	Recebe um armazenamento de propriedades (somente para esse script) que todos os usuários podem acessar no documento, planilha ou formulário aberto.
getScriptProperties()	Properties	Recebe um armazenamento de propriedades que todos os usuários podem acessar, mas apenas nesse script.
getUserProperties()	Properties	Recebe um armazenamento de propriedades que apenas o usuário atual ou efetivo pode acessar e somente nesse script.

ScriptProperties

UserProperties