Устарело. Этот класс устарел и не должен использоваться в новых сценариях.
Свойства сценария — это пары ключ-значение, хранящиеся сценарием в постоянном хранилище. Свойства сценария определяются для каждого сценария независимо от того, какой пользователь запускает сценарий.
Устаревшие методы
Метод | Тип возврата | Краткое описание |
---|---|---|
|
| Удаляет все свойства. |
|
| Удаляет свойство с заданным ключом. |
| String[] | Получите все доступные ключи. |
| Object | Получите все доступные свойства одновременно. |
| String | Возвращает значение, связанное с предоставленным ключом, или значение NULL, если такого значения нет. |
|
| Массовая установка всех свойств, извлеченных из данного объекта. |
|
| Массовая установка всех свойств, извлеченных из данного объекта. |
|
| Сохраняет указанное значение с предоставленным ключом. |
Устаревшие методы
deleteAllProperties()
deleteAllProperties()
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Удаляет все свойства.
ScriptProperties.deleteAllProperties();
Возвращаться
— этот объект для цепочкиScriptProperties
См. также
deleteProperty(key)
deleteProperty(key)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Удаляет свойство с заданным ключом.
ScriptProperties.deleteProperty('special');
Параметры
Имя | Тип | Описание |
---|---|---|
key | String | ключ для свойства, которое нужно удалить |
Возвращаться
— этот объект для цепочкиScriptProperties
См. также
getKeys()
getKeys()
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Получите все доступные ключи.
Возвращаться
String[]
getProperties()
getProperties()
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Получите все доступные свойства одновременно.
Это дает копию, а не просмотр в реальном времени, поэтому изменение свойств возвращаемого объекта не приведет к их обновлению в хранилище, и наоборот.
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]);
}
Возвращаться
Object
— копия свойств, содержащая пары ключ-значение.
getProperty(key)
getProperty(key)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Возвращает значение, связанное с предоставленным ключом, или значение NULL, если такого значения нет.
var specialValue = ScriptProperties.getProperty('special');
Параметры
Имя | Тип | Описание |
---|---|---|
key | String | ключ для значения, которое нужно получить |
Возвращаться
String
— значение, связанное с ключом
См. также
setProperties(properties)
setProperties(properties)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Массовая установка всех свойств, извлеченных из данного объекта.
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});
Параметры
Имя | Тип | Описание |
---|---|---|
properties | Object | объект, содержащий свойства, которые необходимо установить. |
Возвращаться
— этот объект для цепочкиScriptProperties
См. также
setProperties(properties, deleteAllOthers)
setProperties(properties, deleteAllOthers)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Массовая установка всех свойств, извлеченных из данного объекта.
// This deletes all other properties
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);
Параметры
Имя | Тип | Описание |
---|---|---|
properties | Object | объект, содержащий свойства, которые необходимо установить. |
deleteAllOthers | Boolean | следует ли удалять все существующие свойства. |
Возвращаться
— этот объект для цепочкиScriptProperties
См. также
setProperty(key, value)
setProperty(key, value)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Сохраняет указанное значение с помощью предоставленного ключа. Любое существующее значение, связанное с этим ключом, будет перезаписано.
ScriptProperties.setProperty('special', 'sauce');
Параметры
Имя | Тип | Описание |
---|---|---|
key | String | ключ от собственности |
value | String | значение, которое можно связать с ключом |
Возвращаться
— этот объект для цепочкиScriptProperties