Properties Service

属性

借助此服务,脚本可以将字符串存储为键值对,这些键值对的作用范围限定为某个脚本、某个脚本用户或使用编辑器插件的某个文档。如需详细了解何时使用每种类型的属性,请参阅 Properties 服务指南

名称简介
Properties属性对象充当访问用户、文档或脚本属性的接口。
PropertiesService允许脚本将简单数据存储在键值对中,这些键值对的作用范围限定为某个脚本、某个脚本用户或使用插件的某个文档。
ScriptProperties脚本属性是脚本存储在持久性存储区中的键值对。
UserProperties用户属性是用户独有的键值对。

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获取属性存储区,只有当前用户或有效用户可以访问该存储区,并且只能在此脚本中访问。

ScriptProperties

UserProperties