Эта страница переведена с помощью Cloud Translation API.

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 , для связывания