Usługa Właściwości umożliwia przechowywanie prostych danych w parach klucz-wartość ograniczonych do jednego skryptu, jednego użytkownika skryptu lub jednego dokumentu, w którym używany jest dodatek. Jest on zwykle używany do przechowywania konfiguracji dewelopera lub preferencji użytkownika. Właściwości nigdy nie są udostępniane między skryptami.
Aby wyświetlić dzienne limity i limity miejsca na dane usługi Właściwości, zobacz Limity dla usług Google.
Porównanie sklepów usług
Obiekt globalny PropertiesService
udostępnia 3 metody, z których każda zwraca podobny obiekt Properties
, ale z różnymi uprawnieniami dostępu, jak pokazano w tabeli:
Właściwości skryptu | Właściwości użytkownika | Właściwości dokumentu | |
---|---|---|---|
Metoda dostępu | getScriptProperties() |
getUserProperties() |
getDocumentProperties() |
Dane udostępniane między | Wszyscy użytkownicy skryptu, dodatku lub aplikacji internetowej | bieżący użytkownik skryptu, dodatku lub aplikacji internetowej. | Wszyscy użytkownicy dodatku w otwartym dokumencie |
Zwykle używane do | dane konfiguracji dotyczące całej aplikacji, takie jak nazwa użytkownika i hasło do bazy danych zewnętrznej dewelopera; | Ustawienia dotyczące konkretnego użytkownika, np. jednostki metryczne lub imperialne | dane dotyczące dokumentu, takie jak źródłowy adres URL osadzonego wykresu; |
Format danych
Usługa Properties przechowuje wszystkie dane w postaci pary klucz-wartość. Typy danych, które nie są już ciągami znaków, są automatycznie konwertowane na ciągi znaków, w tym metody zawarte w zapisanych obiektach.
Zapisywanie danych
Aby zapisać pojedynczą wartość, wywołaj metodę Properties.setProperty(key,
value)
odpowiedniego sklepu, jak w tym przykładzie:
Aby zapisać dane zbiorczo, przekaż mapę par klucz-wartość do parametru Properties.setProperties(properties)
.
Każda para klucz-wartość obiektu w parametrze jest przechowywana jako osobna właściwość:
Odczytywanie danych
Aby pobrać pojedynczą wartość, która została wcześniej zapisana, wywołaj funkcję Properties.getProperty(key)
:
Aby pobrać wszystkie wartości w bieżącym magazynie właściwości, wywołaj funkcję Properties.getProperties()
:
Modyfikowanie danych
Metody getProperty()
i getProperties()
zwracają kopię przechowywanych danych, a nie widok na żywo, więc zmiana zwróconego obiektu nie spowoduje zaktualizowania wartości w magazynie właściwości. Aby zaktualizować dane w sklepie, po prostu je ponownie zapisz:
Usuwanie danych
Aby usunąć pojedynczą wartość, wywołaj funkcję Properties.deleteProperty(key)
:
Aby usunąć wszystkie usługi w bieżącym sklepie, wywołaj funkcję Properties.deleteAllProperties()
:
Ręczne zarządzanie właściwościami skryptu
Na stronie ustawień projektu możesz ręcznie dodać maksymalnie 50 właściwości niestandardowych jako ciągi znaków w parach klucz-wartość. Aby dodać więcej niż 50 właściwości, musisz je dodać programowo, korzystając z metod opisanych powyżej w sekcji Zapisywanie danych. Gdy ustawiasz właściwości skryptu na stronie ustawień projektu, nie możesz odwoływać się do zmiennych skryptu.
Dodawanie właściwości skryptu
- Otwórz projekt Apps Script.
- Po lewej stronie kliknij Ustawienia projektu .
- Aby dodać pierwszą usługę, w sekcji Właściwości skryptu kliknij Dodaj właściwość skryptu.
- Aby dodać drugą i kolejne właściwości, w sekcji Właściwości skryptu kliknij Edytuj właściwości skryptu > Dodaj właściwość skryptu.
- W polu Usługa wpisz nazwę klucza.
- W polu Wartość wpisz wartość klucza.
- (Opcjonalnie) Aby dodać więcej właściwości, kliknij Dodaj właściwość skryptu.
- Kliknij Zapisz właściwości skryptu.
Edytowanie właściwości skryptu
- Otwórz projekt Apps Script.
- Po lewej stronie kliknij Ustawienia projektu .
- W sekcji Właściwości skryptu kliknij Edytuj właściwości skryptu.
- Wprowadź zmiany w nazwie i wartości klucza w przypadku każdej usługi, którą chcesz zmienić.
- Kliknij Zapisz właściwości skryptu.
Usuwanie właściwości skryptu
- Otwórz projekt Apps Script.
- Po lewej stronie kliknij Ustawienia projektu .
- W sekcji Właściwości skryptu kliknij Edytuj właściwości skryptu.
- Obok właściwości, którą chcesz usunąć, kliknij Usuń .
- Kliknij Zapisz właściwości skryptu.