Class PropertiesService

属性服务

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

// 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 - 只有脚本的当前用户或有效用户才能访问的属性存储区。