Returns all stored key-value pairs.
class PropertiesService method .getProperties()
PropertiesService is the Apps Script service.
.getProperties() is the method name you will see after a dot in your code.
What it does
Why it's used
- Dump all settings for a backup or debug screen.
- Migrate config to a new sheet or environment.
Common errors
- Forgetting parentheses on getProperties. Write PropertiesService.getProperties(), not PropertiesService.getProperties or getProperties by itself.
- Skipping dots between chained calls. Each step needs a dot, like PropertiesService.getProperties().
- Adding spaces where they do not belong. Write PropertiesService.getProperties(), not PropertiesService .getProperties(), PropertiesService.getProperties (), or PropertiesService . getProperties().
- Wrong capitalization. Use PropertiesService and getProperties, not propertiesservice or getproperties.
Explore
Related methods
-
.getUserProperties()
Returns key-value storage private to the current user.
-
.setProperties()
Saves multiple key-value pairs at once.
-
.getProperty()
Reads a single stored value by key.
-
.getDocumentProperties()
Returns key-value storage tied to the current spreadsheet or doc.
-
.getScriptProperties()
Returns key-value storage shared by everyone using the script.
More Apps Script
Better Sheets tutorials
No tagged tutorials yet. Fetch Apps Script from the harvest table and this page fills automatically.