Class Properties

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Характеристики

Объект свойств действует как интерфейс для доступа к свойствам пользователя, документа или скрипта. Конкретный тип свойства зависит от того, какой из трех методов PropertiesService вызвал скрипт: PropertiesService.getDocumentProperties() , PropertiesService.getUserProperties() или PropertiesService.getScriptProperties() . Свойства не могут использоваться совместно скриптами. Дополнительные сведения о типах свойств см. в руководстве по службе свойств .

Методы

Метод Тип возврата Краткое описание
deleteAllProperties() Properties Удаляет все свойства в текущем хранилище Properties .
deleteProperty(key) Properties Удаляет свойство с заданным ключом в текущем хранилище Properties .
getKeys() String[] Получает все ключи в текущем хранилище Properties .
getProperties() Object Получает копию всех пар ключ-значение в текущем хранилище Properties .
getProperty(key) String Получает значение, связанное с данным ключом в текущем хранилище Properties , или null , если такой ключ не существует.
setProperties(properties) Properties Устанавливает все пары ключ-значение из данного объекта в текущем хранилище Properties .
setProperties(properties, deleteAllOthers) Properties Устанавливает все пары ключ-значение из данного объекта в текущем хранилище Properties , при необходимости удаляя все остальные свойства в хранилище.
setProperty(key, value) Properties Устанавливает заданную пару ключ-значение в текущем хранилище Properties .

Подробная документация

deleteAllProperties()

Удаляет все свойства в текущем хранилище Properties .

// Deletes all user properties.
var userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

Возвращаться

Properties — это хранилище Properties , для цепочки


deleteProperty(key)

Удаляет свойство с заданным ключом в текущем хранилище Properties .

// Deletes the user property 'nickname'.
var userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

Параметры

Имя Тип Описание
key String ключ для свойства, которое нужно удалить

Возвращаться

Properties — это хранилище Properties , для цепочки


getKeys()

Получает все ключи в текущем хранилище Properties .

// Sets several properties, then logs the value of each key.
var scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  'cow': 'moo',
  'sheep': 'baa',
  'chicken': 'cluck'
});
var keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (var i = 0; i < keys.length; i++) {
  Logger.log(keys[i]);
}

Возвращаться

String[] — массив всех ключей в текущем хранилище Properties


getProperties()

Получает копию всех пар ключ-значение в текущем хранилище Properties . Обратите внимание, что возвращенный объект не является живым представлением магазина. Следовательно, изменение свойств возвращаемого объекта не приведет к их автоматическому обновлению в хранилище или наоборот.

// Sets several script properties, then retrieves them and logs them.
var scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  'cow': 'moo',
  'sheep': 'baa',
  'chicken': 'cluck'
});

var animalSounds = scriptProperties.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 — копия всех пар ключ-значение в текущем хранилище Properties .


getProperty(key)

Получает значение, связанное с данным ключом в текущем хранилище Properties , или null , если такой ключ не существует.

// Gets the user property 'nickname'.
var userProperties = PropertiesService.getUserProperties();
var nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

Параметры

Имя Тип Описание
key String ключ для значения свойства, которое нужно получить

Возвращаться

String — значение, связанное с данным ключом в текущем хранилище Properties .


setProperties(properties)

Устанавливает все пары ключ-значение из данного объекта в текущем хранилище Properties .

// Sets multiple user properties at once.
var userProperties = PropertiesService.getUserProperties();
var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'};
userProperties.setProperties(newProperties);

Параметры

Имя Тип Описание
properties Object объект, содержащий пары ключ-значение для установки

Возвращаться

Properties — это хранилище Properties , для цепочки


setProperties(properties, deleteAllOthers)

Устанавливает все пары ключ-значение из данного объекта в текущем хранилище Properties , при необходимости удаляя все остальные свойства в хранилище.

// Sets multiple user properties at once while deleting all other user properties.
var userProperties = PropertiesService.getUserProperties();
var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'};
userProperties.setProperties(newProperties, true);

Параметры

Имя Тип Описание
properties Object объект, содержащий пары ключ-значение для установки
deleteAllOthers Boolean Значение true , чтобы удалить все другие пары ключ-значение в объекте свойств; false , чтобы не

Возвращаться

Properties — это хранилище Properties , для цепочки


setProperty(key, value)

Устанавливает заданную пару ключ-значение в текущем хранилище Properties .

// Sets the user property 'nickname' to 'Bobby'.
var userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

Параметры

Имя Тип Описание
key String ключ от собственности
value String значение для связи с ключом

Возвращаться

Properties — это хранилище Properties , для цепочки