Class PropertiesService

PropertiesService

允许脚本以键值对形式存储简单数据,其范围限定为一个脚本、 脚本或某个使用插件的文档。属性不能在脚本之间共享。 如需详细了解何时使用每种类型的属性,请参阅属性服务指南

// Sets three properties of different types.
var documentProperties = PropertiesService.getDocumentProperties();
var scriptProperties = PropertiesService.getScriptProperties();
var userProperties = PropertiesService.getUserProperties();

documentProperties.setProperty('DAYS_TO_FETCH', '5');
scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/MyWeatherService/');
userProperties.setProperty('DISPLAY_UNITS', 'metric');

方法

方法返回类型简介
getDocumentProperties()Properties获取所有用户都可以在 Open 文档、电子表格或表单
getScriptProperties()Properties获取所有用户都可以访问的媒体资源存储区,但只能在此脚本中访问。
getUserProperties()Properties获取只有当前用户才能访问且只能在此脚本内访问的属性存储区。

详细文档

getDocumentProperties()

获取所有用户都可以在 Open 文档、电子表格或表单只有在脚本已发布并执行 或者已绑定到 Google 文件 类型。当文档属性不可用时,此方法会返回 null。文档 由某个脚本创建的属性无法从该脚本外部访问,即使是其他脚本也是如此 访问同一文档。

返回

Properties - 仅限此脚本的属性存储,仅限当前文档的所有用户 或null如果脚本既不是插件,也不是 Google 工作区文件


getScriptProperties()

获取所有用户都可以访问的媒体资源存储区,但只能在此脚本中访问。

返回

Properties - 脚本的所有用户都可以访问的属性存储区


getUserProperties()

获取只有当前用户才能访问且只能在此脚本内访问的属性存储区。

返回

Properties - 只有脚本的当前用户访问的属性存储区