This service allows scripts to store strings as key-value pairs scoped to one script, one user of a script, or one document in which an editor add-on is used. For more information about when to use each type of property, see the guide to the Properties service.
Classes
| Name | Brief description |
|---|---|
Properties | The properties object acts as the interface to access user, document, or script properties. |
PropertiesService | Allows scripts to store simple data in key-value pairs scoped to one script, one user of a script, or one document in which an add-on is used. |
| Script Properties are key-value pairs stored by a script in a persistent store. |
| User Properties are key-value pairs unique to a user. |
Properties
Methods
| Method | Return type | Brief description |
|---|---|---|
deleteAllProperties() | Properties | Deletes all properties in the current Properties store. |
deleteProperty(key) | Properties | Deletes the property with the given key in the current Properties store. |
getKeys() | String[] | Gets all keys in the current Properties store. |
getProperties() | Object | Gets a copy of all key-value pairs in the current Properties store. |
getProperty(key) | String | Gets the value associated with the given key in the current Properties store, or null if no such key exists. |
setProperties(properties) | Properties | Sets all key-value pairs from the given object in the current Properties store. |
setProperties(properties, deleteAllOthers) | Properties | Sets all key-value pairs from the given object in the current Properties store,
optionally deleting all other properties in the store. |
setProperty(key, value) | Properties | Sets the given key-value pair in the current Properties store. |
PropertiesService
Methods
| Method | Return type | Brief description |
|---|---|---|
getDocumentProperties() | Properties | Gets a property store (for this script only) that all users can access within the open document, spreadsheet, or form. |
getScriptProperties() | Properties | Gets a property store that all users can access, but only within this script. |
getUserProperties() | Properties | Gets a property store that only the current user can access, and only within this script. |