Class ScriptProperties

Propriedades do script

Obsoleto. Essa classe foi descontinuada 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, independentemente de qual usuário o executa.

MétodoTipo de retornoBreve descrição
deleteAllProperties()ScriptPropertiesExclui todas as propriedades.
deleteProperty(key)ScriptPropertiesExclui a propriedade com a chave especificada.
getKeys()String[]Receba todas as chaves disponíveis.
getProperties()ObjectReceba todas as propriedades disponíveis de uma só vez.
getProperty(key)StringRetorna o valor associado à chave fornecida ou nulo, se não houver esse valor.
setProperties(properties)ScriptPropertiesDefine em massa todas as propriedades extraídas do objeto especificado.
setProperties(properties, deleteAllOthers)ScriptPropertiesDefine em massa todas as propriedades extraídas do objeto especificado.
setProperty(key, value)ScriptPropertiesPersistência do valor especificado com a chave fornecida.

Métodos obsoletos

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


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

NomeTipoDescrição
keyStringchave da propriedade a ser excluída

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também


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

Receba todas as chaves disponíveis.

Retornar

String[]


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

Receba todas as propriedades disponíveis de uma só vez.

Isso gera uma cópia, não uma visualização em tempo real. Portanto, mudar as propriedades no objeto retornado não vai atualizar 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.


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

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

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

Parâmetros

NomeTipoDescrição
keyStringchave para o valor a ser recuperado

Retornar

String: o valor associado à chave.

Consulte também


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

NomeTipoDescrição
propertiesObjectum objeto que contém as propriedades a serem definidas.

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também


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

NomeTipoDescrição
propertiesObjectum objeto que contém as propriedades a serem definidas.
deleteAllOthersBooleanse todas as propriedades atuais serão excluídas.

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também


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

Persistência do valor especificado com a chave fornecida. Qualquer valor associado a essa chave será substituído.

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

Parâmetros

NomeTipoDescrição
keyStringchave da propriedade
valueStringvalor a ser associado à chave

Retornar

ScriptProperties: este objeto, para encadeamento

Consulte também