Class ScriptProperties

ScriptProperties

已弃用。此类已弃用，不应在新脚本中使用。

脚本属性是脚本存储在持久性存储区中的键值对。脚本属性的范围限定为每个脚本，无论哪个用户运行脚本。

已弃用的方法

方法	返回类型	简介
deleteAllProperties()	ScriptProperties	删除所有属性。
deleteProperty(key)	ScriptProperties	删除具有给定键的属性。
getKeys()	String[]	获取所有可用密钥。
getProperties()	Object	一次性获取所有可用的媒体资源。
getProperty(key)	String|null	返回与所提供键关联的值，如果没有此类值，则返回 null。
setProperties(properties)	ScriptProperties	批量设置从给定对象中提取的所有属性。
setProperties(properties, deleteAllOthers)	ScriptProperties	批量设置从给定对象中提取的所有属性。
setProperty(key, value)	ScriptProperties	使用提供的键持久保存指定的值。

已弃用的方法

deleteAllProperties()

已弃用。此函数已弃用，不应在新脚本中使用。

删除所有属性。

ScriptProperties.deleteAllProperties();

返回

ScriptProperties - 此对象，用于链式调用

另请参阅

• deleteProperty(key)

---

deleteProperty(key)

已弃用。此函数已弃用，不应在新脚本中使用。

删除具有给定键的属性。

ScriptProperties.deleteProperty('special');

参数

名称	类型	说明
key	String	要删除的属性的键

返回

ScriptProperties - 此对象，用于链式调用

另请参阅

• deleteAllProperties()

---

getKeys()

已弃用。此函数已弃用，不应在新脚本中使用。

获取所有可用密钥。

返回

String[]

---

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)

已弃用。此函数已弃用，不应在新脚本中使用。

返回与所提供键关联的值，如果没有此类值，则返回 null。

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

参数

名称	类型	说明
key	String	要检索的值的键

返回

String|null - 与键关联的值

另请参阅

• setProperty(key, value)

---

setProperties(properties)

已弃用。此函数已弃用，不应在新脚本中使用。

批量设置从给定对象中提取的所有属性。

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

参数

名称	类型	说明
properties	Object	包含要设置的属性的对象。

返回

ScriptProperties - 此对象，用于链式调用

另请参阅

• setProperty(key, value)

---

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 - 此对象，用于链式调用

另请参阅

• getProperty(key)