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