Class Properties

Характеристики

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

Методы

Метод Тип возвращаемого значения Краткое описание
delete All Properties() Properties Удаляет все свойства в текущем хранилище Properties .
delete Property(key) Properties Удаляет свойство с заданным ключом из текущего хранилища Properties .
get Keys() String[] Получает все ключи из текущего хранилища Properties .
get Properties() Object Получает копию всех пар ключ-значение в текущем хранилище Properties .
get Property(key) String Получает значение, связанное с заданным ключом в текущем хранилище Properties , или null если такого ключа не существует.
set Properties(properties) Properties Устанавливает все пары ключ-значение из заданного объекта в текущем хранилище Properties .
set Properties(properties, deleteAllOthers) Properties Устанавливает все пары ключ-значение из заданного объекта в текущем хранилище Properties , при необходимости удаляя все остальные свойства из хранилища.
set Property(key, value) Properties Устанавливает заданную пару ключ-значение в текущем хранилище Properties .

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

deleteAllProperties()

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

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

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

Properties — этот магазин Properties предназначен для создания цепочек сделок.

deleteProperty(key)

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

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

Параметры

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

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

Properties — этот магазин Properties предназначен для создания цепочек сделок.

getKeys()

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

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

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

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

getProperties()

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

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

const animalSounds = scriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for (const kind in animalSounds) {
  Logger.log('A %s goes %s!', kind, animalSounds[kind]);
}

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

Object — копия всех пар ключ-значение в текущем хранилище Properties .

getProperty(key)

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

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

Параметры

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

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

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

setProperties(properties)

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

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const 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.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties, true);

Параметры

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

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

Properties — этот магазин Properties предназначен для создания цепочек сделок.

setProperty(key, value)

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

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

Параметры

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

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

Properties — этот магазин Properties предназначен для создания цепочек сделок.