Properties Service

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

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

Классы

Имя Краткое описание
Properties Объект свойств действует как интерфейс для доступа к свойствам пользователя, документа или скрипта.
PropertiesService Позволяет сценариям хранить простые данные в парах "ключ-значение" для одного сценария, одного пользователя сценария или одного документа, в котором используется надстройка.
ScriptProperties Свойства скрипта — это пары ключ-значение, хранящиеся скриптом в постоянном хранилище.
UserProperties Свойства пользователя — это пары ключ-значение, уникальные для пользователя.

Properties

Методы

Метод Тип возврата Краткое описание
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 .

PropertiesService

Методы

Метод Тип возврата Краткое описание
getDocumentProperties() Properties Получает хранилище свойств (только для этого скрипта), доступ к которому имеют все пользователи в открытом документе, электронной таблице или форме.
getScriptProperties() Properties Получает хранилище свойств, доступ к которому имеют все пользователи, но только в пределах этого скрипта.
getUserProperties() Properties Получает хранилище свойств, к которому может получить доступ только текущий пользователь и только в пределах этого скрипта.

ScriptProperties

UserProperties