Служба свойств позволяет хранить простые данные в парах «ключ-значение», привязанных к одному скрипту, одному пользователю скрипта или одному документу, в котором используется надстройка . Обычно он используется для хранения конфигурации разработчика или предпочтений пользователя. Свойства никогда не используются совместно скриптами.
Чтобы просмотреть дневные квоты и ограничения хранилища для службы свойств, см. Квоты для служб Google .
Сравнение магазинов недвижимости
Глобальный объект PropertiesService
предлагает три метода, каждый из которых возвращает аналогичный объект Properties
, но с разными правами доступа, как показано в следующей таблице:
Свойства скрипта | Свойства пользователя | Свойства документа | |
---|---|---|---|
Метод доступа | getScriptProperties() | getUserProperties() | getDocumentProperties() |
Данные, которыми обмениваются | Все пользователи скрипта, надстройки или веб-приложения. | Текущий пользователь скрипта, надстройки или веб-приложения. | Все пользователи дополнения в открытом документе |
Обычно используется для | Данные конфигурации всего приложения, такие как имя пользователя и пароль для внешней базы данных разработчика. | Пользовательские настройки, такие как метрические или британские единицы измерения. | Данные, относящиеся к документу, например исходный URL-адрес встроенной диаграммы. |
Формат данных
Служба свойств хранит все данные в виде строк в парах ключ-значение. Типы данных, которые еще не являются строками, автоматически преобразуются в строки, включая методы, содержащиеся в сохраненных объектах.
Сохранение данных
Чтобы сохранить одно значение, вызовите метод Properties.setProperty(key, value)
соответствующего хранилища, как показано в следующем примере:
Чтобы сохранить данные массово, передайте карту пар ключ-значение в Properties.setProperties(properties)
. Каждая пара ключ-значение объекта в параметре сохраняется как отдельное свойство:
Чтение данных
Чтобы получить одно сохраненное ранее значение, вызовите Properties.getProperty(key)
:
Чтобы получить все значения в текущем хранилище свойств, вызовите Properties.getProperties()
:
Изменение данных
Методы getProperty()
и getProperties()
возвращают копию сохраненных данных, а не представление в реальном времени, поэтому изменение возвращаемого объекта не приведет к обновлению значения в хранилище свойств. Чтобы обновить данные в магазине, просто сохраните их еще раз:
Удаление данных
Чтобы удалить одно значение, вызовите Properties.deleteProperty(key)
:
Чтобы удалить все свойства в текущем хранилище, вызовите Properties.deleteAllProperties()
:
Управление свойствами скрипта вручную
Вы можете вручную добавить до пятидесяти пользовательских свойств в виде строк в парах ключ-значение на странице настроек проекта. Чтобы добавить более пятидесяти свойств, необходимо добавить их программно, используя методы, описанные выше в разделе Сохранение данных . Когда вы устанавливаете свойства скрипта на странице настроек проекта, вы не можете ссылаться на переменные скрипта.
Добавить свойства скрипта
- Откройте проект Apps Script.
- Слева нажмите «Настройки проекта» .
.
- Чтобы добавить первое свойство, в разделе «Свойства сценария» нажмите «Добавить свойство сценария» .
- Чтобы добавить второе и последующие свойства, в разделе «Свойства сценария» нажмите «Изменить свойства сценария» > «Добавить свойство сценария» .
- В поле «Свойство» введите имя ключа.
- В поле «Значение» введите значение ключа.
- (Необязательно) Чтобы добавить дополнительные свойства, нажмите «Добавить свойство скрипта» .
- Нажмите Сохранить свойства скрипта .
Редактировать свойства скрипта
- Откройте проект Apps Script.
- Слева нажмите «Настройки проекта» .
.
- В разделе «Свойства сценария» нажмите «Изменить свойства сценария» .
- Внесите изменения в имя ключа и значение ключа для каждого свойства, которое вы хотите изменить.
- Нажмите Сохранить свойства сценария .
Удалить свойства скрипта
- Откройте проект Apps Script.
- Слева нажмите «Настройки проекта» .
.
- В разделе «Свойства сценария» нажмите «Изменить свойства сценария» .
- Рядом с ресурсом, который вы хотите удалить, нажмите Удалить».
- Нажмите Сохранить свойства сценария .