Class UserProperties
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Свойства пользователя Устарело. Этот класс устарел и не должен использоваться в новых сценариях.
Свойства пользователя — это пары ключ-значение, уникальные для пользователя. Свойства пользователя ограничены для каждого пользователя; любой сценарий, запущенный под именем пользователя, может получить доступ к свойствам пользователя только для этого пользователя.
Устаревшие методы
delete All Properties()
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Удаляет все свойства.
UserProperties.deleteAllProperties();
Возвращаться
User Properties
См. также
delete Property(key)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Удаляет свойство с заданным ключом.
UserProperties.deleteProperty('special');
Параметры
| Имя | Тип | Описание |
|---|
key | String | ключ для свойства, которое нужно удалить |
Возвращаться
User Properties
См. также
get Keys()
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Получите все доступные ключи.
Возвращаться
String[]
get Properties()
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Получите все доступные свойства одновременно.
Это дает копию, а не просмотр в реальном времени, поэтому изменение свойств возвращаемого объекта не приведет к их обновлению в хранилище, и наоборот.
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]);
}
Возвращаться
Object — копия свойств, содержащая пары ключ-значение.
get Property(key)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Возвращает значение, связанное с предоставленным ключом, или значение NULL, если такого значения нет.
const specialValue = UserProperties.getProperty('special'); Параметры
| Имя | Тип | Описание |
|---|
key | String | ключ для значения, которое нужно получить |
Возвращаться
String — значение, связанное с ключом
См. также
set Properties(properties)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Массовая установка всех свойств, извлеченных из данного объекта.
UserProperties.setProperties({special: 'sauce', 'meaning': 42});
Параметры
| Имя | Тип | Описание |
|---|
properties | Object | объект, содержащий свойства, которые необходимо установить. |
Возвращаться
User Properties
См. также
set Properties(properties, deleteAllOthers)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Массовая установка всех свойств, извлеченных из данного объекта.
// This deletes all other properties
UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true); Параметры
| Имя | Тип | Описание |
|---|
properties | Object | объект, содержащий свойства, которые необходимо установить. |
delete All Others | Boolean | следует ли удалять все существующие свойства. |
Возвращаться
User Properties
См. также
set Property(key, value)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Сохраняет указанное значение с предоставленным ключом. Любое существующее значение, связанное с этим ключом, будет перезаписано.
UserProperties.setProperty('special', 'sauce');
Параметры
| Имя | Тип | Описание |
|---|
key | String | ключ от собственности |
value | String | значение, которое можно связать с ключом |
Возвращаться
User Properties
См. также
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-24 UTC.
[null,null,["Последнее обновление: 2025-07-24 UTC."],[[["\u003cp\u003e\u003ccode\u003eUserProperties\u003c/code\u003e is deprecated and should not be used in new scripts.\u003c/p\u003e\n"],["\u003cp\u003eUser Properties are key-value pairs unique to a user, accessible only by scripts running under that user's identity.\u003c/p\u003e\n"],["\u003cp\u003eAll methods within \u003ccode\u003eUserProperties\u003c/code\u003e are deprecated, including those for setting, getting, and deleting properties.\u003c/p\u003e\n"],["\u003cp\u003eDespite being deprecated, \u003ccode\u003eUserProperties\u003c/code\u003e provides functionalities like \u003ccode\u003egetProperties()\u003c/code\u003e which returns a copy of the properties, and \u003ccode\u003edeleteAllProperties()\u003c/code\u003e to remove all properties.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should avoid using \u003ccode\u003eUserProperties\u003c/code\u003e and explore alternative solutions for managing user-specific data in new scripts.\u003c/p\u003e\n"]]],[],null,["# Class UserProperties\n\nUserProperties\n\n\n**Deprecated.** This class is deprecated and should not be used in new scripts.\n\nUser Properties are key-value pairs unique to a user. User Properties are scoped per user; any\nscript running under the identity of a user can access User Properties for that user only. \n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------------------------|---------------------|----------------------------------------------------------------------------------------|\n| [deleteAllProperties()](#deleteAllProperties()) | [UserProperties](#) | Deletes all properties. |\n| [deleteProperty(key)](#deleteProperty(String)) | [UserProperties](#) | Deletes the property with the given key. |\n| [getKeys()](#getKeys()) | `String[]` | Get all of the available keys. |\n| [getProperties()](#getProperties()) | `Object` | Get all of the available properties at once. |\n| [getProperty(key)](#getProperty(String)) | `String` | Returns the value associated with the provided key, or null if there is no such value. |\n| [setProperties(properties)](#setProperties(Object)) | [UserProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperties(properties, deleteAllOthers)](#setProperties(Object,Boolean)) | [UserProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperty(key, value)](#setProperty(String,String)) | [UserProperties](#) | Persists the specified in value with the provided key. |\n\nDeprecated methods\n------------------\n\n### `delete``All``Properties()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes all properties.\n\n```javascript\nUserProperties.deleteAllProperties();\n```\n\n#### Return\n\n\n[UserProperties](#) --- this object, for chaining\n\n#### See also\n\n- [deleteProperty(key)](#deleteProperty(String))\n\n*** ** * ** ***\n\n### `delete``Property(key)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes the property with the given key.\n\n```javascript\nUserProperties.deleteProperty('special');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|----------------------------|\n| `key` | `String` | key for property to delete |\n\n#### Return\n\n\n[UserProperties](#) --- this object, for chaining\n\n#### See also\n\n- [deleteAllProperties()](#deleteAllProperties())\n\n*** ** * ** ***\n\n### `get``Keys()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGet all of the available keys.\n\n#### Return\n\n\n`String[]`\n\n*** ** * ** ***\n\n### `get``Properties()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGet all of the available properties at once.\n\nThis gives a copy, not a live view, so changing the properties on the returned object won't\nupdate them in storage and vice versa.\n\n```javascript\nUserProperties.setProperties({\n \"cow\" : \"moo\",\n \"sheep\" : \"baa\",\n \"chicken\" : \"cluck\"\n});\n\n// Logs \"A cow goes: moo\"\nLogger.log(\"A cow goes: %s\", UserProperties.getProperty(\"cow\"));\n\n// This makes a copy. Any changes that happen here will not\n// be written back to properties.\nvar animalSounds = UserProperties.getProperties();\n\n// Logs:\n// A chicken goes cluck!\n// A cow goes moo!\n// A sheep goes baa!\nfor(var kind in animalSounds) {\n Logger.log(\"A %s goes %s!\", kind, animalSounds[kind]);\n}\n```\n\n#### Return\n\n\n`Object` --- a copy of the properties containing key-value pairs\n\n*** ** * ** ***\n\n### `get``Property(key)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nReturns the value associated with the provided key, or null if there is no such value.\n\n```javascript\nconst specialValue = UserProperties.getProperty('special');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|-------------------------------|\n| `key` | `String` | key for the value to retrieve |\n\n#### Return\n\n\n`String` --- the value associated with the key\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Properties(properties)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nBulk-sets all the properties drawn from the given object.\n\n```javascript\nUserProperties.setProperties({special: 'sauce', 'meaning': 42});\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|---------------------------------------------|\n| `properties` | `Object` | an object containing the properties to set. |\n\n#### Return\n\n\n[UserProperties](#) --- this object, for chaining\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Properties(properties, deleteAllOthers)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nBulk-sets all the properties drawn from the given object.\n\n```javascript\n// This deletes all other properties\nUserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------------|-----------|---------------------------------------------|\n| `properties` | `Object` | an object containing the properties to set. |\n| `delete``All``Others` | `Boolean` | whether to delete all existing properties. |\n\n#### Return\n\n\n[UserProperties](#) --- this object, for chaining\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Property(key, value)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nPersists the specified in value with the provided key. Any existing value associated with this\nkey will be overwritten.\n\n```javascript\nUserProperties.setProperty('special', 'sauce');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|---------------------------------|\n| `key` | `String` | key for property |\n| `value` | `String` | value to associate with the key |\n\n#### Return\n\n\n[UserProperties](#) --- this object, for chaining\n\n#### See also\n\n- [getProperty(key)](#getProperty(String))"]]
