Устарело. Этот класс устарел и не должен использоваться в новых скриптах.
Свойства пользователя представляют собой пары «ключ-значение», уникальные для каждого пользователя. Свойства пользователя имеют область видимости для каждого пользователя; любой скрипт, работающий под учетной записью этого пользователя, может получить доступ к свойствам пользователя только для этого пользователя.
Устаревшие методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
| | Удаляет все свойства. |
| | Удаляет свойство с заданным ключом. |
| String[] | Получите все доступные ключи. |
| Object | Получите все доступные объекты недвижимости сразу. |
| String|null | Возвращает значение, связанное с предоставленным ключом, или null если такое значение отсутствует. |
| | Задает все свойства, полученные из заданного объекта, в пакетном режиме. |
| | Задает все свойства, полученные из заданного объекта, в пакетном режиме. |
| | Сохраняет указанное значение с помощью предоставленного ключа. |
Устаревшие методы
delete All Properties()
delete All Properties()Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Удаляет все свойства.
UserProperties .deleteAllProperties();
Возвращаться
— этот объект используется для создания цепочек.User Properties
См. также
delete Property(key)
delete Property(key)Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Удаляет свойство с заданным ключом.
UserProperties .deleteProperty('special');
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | String | ключ для удаления свойства |
Возвращаться
— этот объект используется для создания цепочек.User Properties
См. также
get Keys()
get Keys()Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Получите все доступные ключи.
Возвращаться
String[]
get Properties()
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)
get Property(key)Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Возвращает значение, связанное с предоставленным ключом, или null если такое значение отсутствует.
const specialValue = UserProperties.getProperty('special');
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | String | ключ для получения значения |
Возвращаться
String|null — значение, связанное с ключом
См. также
set Properties(properties)
set Properties(properties)Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Задает все свойства, полученные из заданного объекта, в пакетном режиме.
UserProperties .setProperties({special: 'sauce', 'meaning': 42});
Параметры
| Имя | Тип | Описание |
|---|---|---|
properties | Object | Объект, содержащий свойства, которые необходимо установить. |
Возвращаться
— этот объект используется для создания цепочек.User Properties
См. также
set Properties(properties, deleteAllOthers)
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)
set Property(key, value)Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Сохраняет указанное значение с помощью предоставленного ключа. Любое существующее значение, связанное с этим ключом, будет перезаписано.
UserProperties .setProperty('special', 'sauce');
Параметры
| Имя | Тип | Описание |
|---|---|---|
key | String | ключ от недвижимости |
value | String | значение, которое нужно связать с ключом |
Возвращаться
— этот объект используется для создания цепочек.User Properties