此服务允许脚本将字符串存储为键值对,范围限定为一个脚本、一个脚本的一位用户或一个使用编辑器插件的文档。如需详细了解何时使用每种类型的属性,请参阅属性服务指南。
类
名称 | 简介 |
---|---|
Properties | 属性对象充当访问用户、文档或脚本属性的接口。 |
PropertiesService | 允许脚本以键值对形式存储简单数据,这些键值对的范围限定为一个脚本、一个脚本的一位用户或一个使用插件的文档。 |
| 脚本属性是脚本存储在永久性存储区中的键值对。 |
| 用户属性是用户独有的键值对。 |
Properties
方法
方法 | 返回类型 | 简介 |
---|---|---|
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 存储区中的给定键值对。 |
PropertiesService
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDocumentProperties() | Properties | 获取所有用户都可以在打开的文档、电子表格或表单中访问的资源存储区(仅适用于此脚本)。 |
getScriptProperties() | Properties | 获取所有用户都可以访问,但仅限于此脚本中的资源存储区。 |
getUserProperties() | Properties | 获取只有当前用户才能访问且仅限此脚本内的属性存储区。 |