属性对象充当访问用户、文档或脚本属性的接口。具体属性类型取决于脚本调用的 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');
参数
名称 | 类型 | 说明 |
---|---|---|
key | String | 要删除的属性的键 |
弃踢回攻
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);
参数
名称 | 类型 | 说明 |
---|---|---|
key | String | 要检索的属性值的键 |
弃踢回攻
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);
参数
名称 | 类型 | 说明 |
---|---|---|
properties | Object | 一个包含要设置的键值对的对象 |
弃踢回攻
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);
参数
名称 | 类型 | 说明 |
---|---|---|
properties | Object | 一个包含要设置的键值对的对象 |
deleteAllOthers | Boolean | true 表示删除属性对象中的所有其他键值对;false 表示不删除 |
弃踢回攻
Properties
- 此 Properties
商店,用于连锁销售
setProperty(key, value)
设置当前 Properties
存储区中的给定键值对。
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
参数
名称 | 类型 | 说明 |
---|---|---|
key | String | 属性的键 |
value | String | 要与该键相关联的值 |
弃踢回攻
Properties
- 此 Properties
商店,用于连锁销售