Class PropertiesService

Properties 服务

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

// Sets three properties of different types.
const documentProperties = PropertiesService.getDocumentProperties();
const scriptProperties = PropertiesService.getScriptProperties();
const 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 - 一个仅脚本的当前用户可以访问的属性存储