Class ScriptProperties

Propriedades do script

Obsoleto. Essa classe está obsoleta e não deve ser usada em novos scripts.

As propriedades do script são pares de chave-valor armazenados por um script em um armazenamento permanente. As propriedades do script são definidas por script, independente de qual usuário o executa.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
deleteAllProperties()	ScriptProperties	Exclui todas as propriedades.
deleteProperty(key)	ScriptProperties	Exclui a propriedade com a chave especificada.
getKeys()	String[]	Receba todas as chaves disponíveis.
getProperties()	Object	Receba todas as propriedades disponíveis de uma vez.
getProperty(key)	String|null	Retorna o valor associado à chave fornecida ou null se não houver esse valor.
setProperties(properties)	ScriptProperties	Define em massa todas as propriedades extraídas do objeto especificado.
setProperties(properties, deleteAllOthers)	ScriptProperties	Define em massa todas as propriedades extraídas do objeto especificado.
setProperty(key, value)	ScriptProperties	Persiste o valor especificado com a chave fornecida.

Métodos obsoletos

deleteAllProperties()

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui todas as propriedades.

ScriptProperties.deleteAllProperties();

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também

• deleteProperty(key)

---

deleteProperty(key)

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui a propriedade com a chave especificada.

ScriptProperties.deleteProperty('special');

Parâmetros

Nome	Tipo	Descrição
key	String	chave da propriedade a ser excluída

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também

• deleteAllProperties()

---

getKeys()

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Receba todas as chaves disponíveis.

Retornar

String[]

---

getProperties()

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Receba todas as propriedades disponíveis de uma vez.

Isso fornece uma cópia, não uma visualização dinâmica. Portanto, mudar as propriedades no objeto retornado não as atualiza no armazenamento e vice-versa.

ScriptProperties.setProperties({
  "cow"     : "moo",
  "sheep"   : "baa",
  "chicken" : "cluck"
});

// Logs "A cow goes: moo"
Logger.log("A cow goes: %s", ScriptProperties.getProperty("cow"));

// This makes a copy. Any changes that happen here will not
// be written back to properties.
var animalSounds = ScriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for(var kind in animalSounds) {
  Logger.log("A %s goes %s!", kind, animalSounds[kind]);
}

Retornar

Object: uma cópia das propriedades que contêm pares de chave-valor

---

getProperty(key)

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Retorna o valor associado à chave fornecida ou null se não houver esse valor.

const specialValue = ScriptProperties.getProperty('special');

Parâmetros

Nome	Tipo	Descrição
key	String	chave do valor a ser recuperado

Retornar

String|null: o valor associado à chave.

Consulte também

• setProperty(key, value)

---

setProperties(properties)

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define em massa todas as propriedades extraídas do objeto especificado.

ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});

Parâmetros

Nome	Tipo	Descrição
properties	Object	um objeto que contém as propriedades a serem definidas.

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também

• setProperty(key, value)

---

setProperties(properties, deleteAllOthers)

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define em massa todas as propriedades extraídas do objeto especificado.

// This deletes all other properties
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);

Parâmetros

Nome	Tipo	Descrição
properties	Object	um objeto que contém as propriedades a serem definidas.
deleteAllOthers	Boolean	se todas as propriedades atuais serão excluídas.

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também

• setProperty(key, value)

---

setProperty(key, value)

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Persiste o valor especificado com a chave fornecida. Qualquer valor associado a essa chave será substituído.

ScriptProperties.setProperty('special', 'sauce');

Parâmetros

Nome	Tipo	Descrição
key	String	chave da propriedade
value	String	valor a ser associado à chave

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também

• getProperty(key)