Class Properties

属性

属性对象充当访问用户、文档或脚本属性的接口。具体的属性类型取决于该脚本调用的 PropertiesService 的三种方法中的哪一种：PropertiesService.getDocumentProperties()、PropertiesService.getUserProperties() 或 PropertiesService.getScriptProperties()。属性不能在脚本之间共享。如需详细了解属性类型，请参阅属性服务指南。

方法

方法返回类型简介
deleteAllProperties()Properties删除当前 Properties 存储区中的所有属性。
deleteProperty(key)Properties删除当前 Properties 存储区中具有给定键的属性。
getKeys()String[]获取当前 Properties 存储区中的所有密钥。
getProperties()Object获取当前 Properties 存储区中所有键值对的副本。
getProperty(key)String获取与当前 Properties 存储区中给定键关联的值，如果不存在此类键，则获取 null。
setProperties(properties)Properties设置当前 Properties 存储区中给定对象的所有键值对。
setProperties(properties, deleteAllOthers)Properties设置当前 Properties 存储区中给定对象的所有键值对，还可选择删除存储区中的所有其他属性。
setProperty(key, value)Properties设置当前 Properties 存储区中给定的键值对。

详细文档

deleteAllProperties()

删除当前 Properties 存储区中的所有属性。 

// Deletes all user properties.
var userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

返回

Properties - 此 Properties 存储区（用于链式处理）

deleteProperty(key)

删除具有当前 Properties 存储区中给定键的属性。 

// Deletes the user property 'nickname'.
var userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

参数

名称类型说明
keyString要删除的媒体资源的键

返回

Properties - 此 Properties 存储区（用于链式处理）

getKeys()

获取当前 Properties 存储区中的所有密钥。 

// Sets several properties, then logs the value of each key.
var scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  'cow': 'moo',
  'sheep': 'baa',
  'chicken': 'cluck'
});
var keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (var i = 0; i < keys.length; i++) {
  Logger.log(keys[i]);
}

返回

String[] - 当前 Properties 存储区中所有密钥的数组

getProperties()

获取当前 Properties 存储区中所有键值对的副本。请注意，返回的对象不是商店的实际视图。因此，更改返回对象的属性不会自动更新存储中的属性，反之亦然。

// Sets several script properties, then retrieves them and logs them.
var scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  'cow': 'moo',
  'sheep': 'baa',
  'chicken': 'cluck'
});

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 - 当前 Properties 存储区中所有键值对的副本

getProperty(key)

获取与当前 Properties 存储区中的指定键相关联的值，如果 null 不存在，则获取相应值。 

// Gets the user property 'nickname'.
var userProperties = PropertiesService.getUserProperties();
var nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

参数

名称类型说明
keyString要检索的属性值的键

返回

String - 与当前 Properties 存储区中给定键关联的值

setProperties(properties)

设置当前 Properties 存储区中给定对象的所有键值对。 

// Sets multiple user properties at once.
var userProperties = PropertiesService.getUserProperties();
var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'};
userProperties.setProperties(newProperties);

参数

名称类型说明
propertiesObject一个包含要设置的键值对的对象

返回

Properties - 此 Properties 存储区（用于链式处理）

setProperties(properties, deleteAllOthers)

设置当前 Properties 存储区中给定对象的所有键值对，还可选择删除存储区中的所有其他属性。 

// Sets multiple user properties at once while deleting all other user properties.
var userProperties = PropertiesService.getUserProperties();
var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'};
userProperties.setProperties(newProperties, true);

参数

名称类型说明
propertiesObject一个包含要设置的键值对的对象
deleteAllOthersBooleantrue（用于删除属性对象中的所有其他键值对）；false 用于不删除

返回

Properties - 此 Properties 存储区（用于链式处理）

setProperty(key, value)

设置当前 Properties 存储区中给定的键值对。 

// Sets the user property 'nickname' to 'Bobby'.
var userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

参数

名称类型说明
keyString属性的键
valueString与键关联的值

返回

Properties - 此 Properties 存储区（用于链式处理）