AI-generated Key Takeaways
-
The Properties service allows scripts to store key-value pairs with different scopes: script, user, or document.
-
The
Propertiesobject provides methods for accessing and managing key-value pairs within a specific property store. -
The
PropertiesServiceprovides methods to get property stores for the document, script, or user. -
ScriptPropertiesandUserPropertiesare types of persistent key-value stores with script-wide or user-specific scopes respectively.
Properties
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. |
Properties
|
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 |
|---|---|---|
Properties
|
Deletes all properties in the current Properties
store. |
|
Properties
|
Deletes the property with the given key in the current Properties
store. |
|
String[]
|
Gets all keys in the current Properties
store. |
|
Object
|
Gets a copy of all key-value pairs in the current Properties
store. |
|
String
|
Gets the value associated with the given key in the current Properties
store, or null
if no such key exists. |
|
Properties
|
Sets all key-value pairs from the given object in the current Properties
store. |
|
Properties
|
Sets all key-value pairs from the given object in the current Properties
store,
optionally deleting all other properties in the store. |
|
Properties
|
Sets the given key-value pair in the current Properties
store. |
Properties
Methods
| Method | Return type | Brief description |
|---|---|---|
Properties
|
Gets a property store (for this script only) that all users can access within the open document, spreadsheet, or form. | |
Properties
|
Gets a property store that all users can access, but only within this script. | |
Properties
|
Gets a property store that only the current user can access, and only within this script. |
Script
Script
User
User
