Служба свойств позволяет хранить простые данные в парах «ключ-значение», ограниченных одним скриптом, одним пользователем скрипта или одним документом, в котором используется надстройка . Обычно она используется для хранения конфигурации разработчика или пользовательских настроек. Свойства никогда не используются совместно разными скриптами.
Чтобы просмотреть ежедневные квоты и лимиты хранилища для службы «Свойства», см. раздел Квоты для служб 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.
- Слева нажмите «Настройки проекта» .
.
- В разделе «Свойства скрипта» нажмите «Изменить свойства скрипта» .
- Рядом с объектом, который вы хотите удалить, нажмите Удалить и .
- Нажмите Сохранить свойства скрипта .