Properties Service

媒体资源

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

名称简介
Propertiesproperties 对象充当访问用户、文档或脚本属性的接口。
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