Class PropertiesService

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