Properties Service

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

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

Классы

Имя	Краткое описание
Properties	Объект properties выступает в качестве интерфейса для доступа к свойствам пользователя, документа или скрипта.
Properties Service	Позволяет скриптам хранить простые данные в парах «ключ-значение», ограниченных одним скриптом, одним пользователем скрипта или одним документом, в котором используется надстройка.
Script Properties	Свойства скрипта представляют собой пары ключ-значение, хранящиеся скриптом в постоянном хранилище.
User Properties	Свойства пользователя представляют собой пары ключ-значение, уникальные для каждого пользователя.

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 .

PropertiesService

Методы

Метод	Тип возвращаемого значения	Краткое описание
get Document Properties()	Properties	Создает хранилище свойств (только для этого скрипта), к которому все пользователи могут получить доступ в открытом документе, электронной таблице или форме.
get Script Properties()	Properties	Получает хранилище свойств, доступное всем пользователям, но только внутри этого скрипта.
get User Properties()	Properties	Получает хранилище свойств, доступ к которому имеет только текущий или фактический пользователь, и только в рамках этого скрипта.

ScriptProperties

UserProperties