Stay organized with collections Save and categorize content based on your preferences.
UserPropertiesDeprecated. This class is deprecated and should not be used in new scripts.
User Properties are key-value pairs unique to a user. User Properties are scoped per user; any script running under the identity of a user can access User Properties for that user only.
Deprecated methodsdeleteAllProperties()
Deprecated. This function is deprecated and should not be used in new scripts.
Deletes all properties.
UserProperties.deleteAllProperties();Return
UserProperties
— this object, for chaining
deleteProperty(key)
Deprecated. This function is deprecated and should not be used in new scripts.
Deletes the property with the given key.
UserProperties.deleteProperty('special');Parameters Name Type Description
key
String
key for property to delete Return
UserProperties
— this object, for chaining
getKeys()
Deprecated. This function is deprecated and should not be used in new scripts.
Get all of the available keys.
ReturnString[]
getProperties()
Deprecated. This function is deprecated and should not be used in new scripts.
Get all of the available properties at once.
This gives a copy, not a live view, so changing the properties on the returned object won't update them in storage and vice versa.
UserProperties.setProperties({ "cow" : "moo", "sheep" : "baa", "chicken" : "cluck" }); // Logs "A cow goes: moo" Logger.log("A cow goes: %s", UserProperties.getProperty("cow")); // This makes a copy. Any changes that happen here will not // be written back to properties. var animalSounds = UserProperties.getProperties(); // Logs: // A chicken goes cluck! // A cow goes moo! // A sheep goes baa! for(var kind in animalSounds) { Logger.log("A %s goes %s!", kind, animalSounds[kind]); }Return
Object
— a copy of the properties containing key-value pairs
getProperty(key)
Deprecated. This function is deprecated and should not be used in new scripts.
Returns the value associated with the provided key, or null if there is no such value.
const specialValue = UserProperties.getProperty('special');Parameters Name Type Description
key
String
key for the value to retrieve Return
String
— the value associated with the key
setProperties(properties)
Deprecated. This function is deprecated and should not be used in new scripts.
Bulk-sets all the properties drawn from the given object.
UserProperties.setProperties({special: 'sauce', 'meaning': 42});Parameters Name Type Description
properties
Object
an object containing the properties to set. Return
UserProperties
— this object, for chaining
setProperties(properties, deleteAllOthers)
Deprecated. This function is deprecated and should not be used in new scripts.
Bulk-sets all the properties drawn from the given object.
// This deletes all other properties UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);Parameters Name Type Description
properties
Object
an object containing the properties to set. deleteAllOthers
Boolean
whether to delete all existing properties. Return
UserProperties
— this object, for chaining
setProperty(key, value)
Deprecated. This function is deprecated and should not be used in new scripts.
Persists the specified in value with the provided key. Any existing value associated with this key will be overwritten.
UserProperties.setProperty('special', 'sauce');Parameters Name Type Description
key
String
key for property value
String
value to associate with the key Return
UserProperties
— this object, for chaining
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-02 UTC."],[[["`UserProperties` is deprecated and should not be used in new scripts."],["User Properties are key-value pairs unique to a user, accessible only by scripts running under that user's identity."],["All methods within `UserProperties` are deprecated, including those for setting, getting, and deleting properties."],["Despite being deprecated, `UserProperties` provides functionalities like `getProperties()` which returns a copy of the properties, and `deleteAllProperties()` to remove all properties."],["Developers should avoid using `UserProperties` and explore alternative solutions for managing user-specific data in new scripts."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4