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获取所有用户都可以在打开的文档、电子表格或表单中访问的资源存储区(仅适用于此脚本)。
getScriptProperties()Properties获取所有用户都可以访问,但仅限于此脚本中的资源存储区。
getUserProperties()Properties获取只有当前用户才能访问且仅限此脚本内的属性存储区。

详细文档

getDocumentProperties()

获取所有用户都可以在打开的文档、电子表格或表单中访问的资源存储区(仅适用于此脚本)。只有在脚本作为插件发布和执行,或者脚本已绑定到某个 Google 文件类型时,才可以使用此字段。当文档属性不可用时,此方法会返回 null。由某个脚本创建的文档属性无法在该脚本之外访问,即使其他脚本访问同一文档也是如此。

弃踢回攻

Properties - 此脚本的属性存储区,仅允许当前文档的所有用户访问;如果该脚本不是插件或绑定到 Google Workspace 文件,则为 null


getScriptProperties()

获取所有用户都可以访问,但仅限于此脚本中的资源存储区。

弃踢回攻

Properties - 脚本的所有用户均可访问的媒体资源存储区


getUserProperties()

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

弃踢回攻

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