Usługa właściwości umożliwia przechowywanie prostych danych w parach klucz-wartość ograniczonych do jednego skryptu, jednego użytkownika skryptu lub dokumentu, w którym jest używany dodatek. Zwykle służy do przechowywania konfiguracji dewelopera lub ustawień użytkownika. Właściwości nigdy nie są współdzielone przez skrypty.
Dzienne limity miejsca i limitów miejsca na dane w usłudze Właściwości znajdziesz w artykule Limity dla usług Google.
Porównanie sklepów nieruchomości
Obiekt globalny PropertiesService
udostępnia 3 metody, z których każda zwraca podobny obiekt Properties
, ale z innymi prawami dostępu, jak pokazano w tej tabeli:
Właściwości skryptu | Właściwości użytkownika | Właściwości dokumentu | |
---|---|---|---|
Sposób uzyskania 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 |
Typowe zastosowanie | dane konfiguracyjne obejmujące całą aplikację, takie jak nazwa użytkownika i hasło do zewnętrznej bazy danych dewelopera; | Ustawienia dla konkretnego użytkownika, np. jednostki metryczne lub jednostki imperialne | dane dotyczące konkretnego dokumentu, takie jak źródłowy adres URL wykresu umieszczonego na stronie; |
Format danych
Usługa Właściwości przechowuje wszystkie dane jako ciągi znaków w parach klucz-wartość. Typy danych, które nie są jeszcze ciągami znaków, są automatycznie konwertowane na ciągi znaków, w tym metody zawarte w zapisanych obiektach.
Zapisuję dane
Aby zapisać pojedynczą wartość, wywołaj metodę Properties.setProperty(key,
value)
odpowiedniego sklepu, jak w tym przykładzie:
Aby zbiorczo zapisywać dane, przekaż mapę par klucz-wartość do funkcji Properties.setProperties(properties)
.
Każda para klucz-wartość obiektu w parametrze jest przechowywana jako osobna właściwość:
Odczyt danych
Aby pobrać jedną zapisaną wcześniej wartość, wywołaj Properties.getProperty(key)
:
Aby pobrać wszystkie wartości z bieżącego magazynu właściwości, wywołaj Properties.getProperties()
:
Modyfikowanie danych
Metody getProperty()
i getProperties()
zwracają kopię zapisanych danych, a nie widok na żywo, dlatego zmiana zwróconego obiektu nie spowoduje aktualizacji wartości w magazynie właściwości. Aby zaktualizować dane w sklepie, po prostu zapisz je ponownie:
Usuwanie danych
Aby usunąć pojedynczą wartość, wywołaj Properties.deleteProperty(key)
:
Aby usunąć wszystkie właściwości w bieżącym magazynie, wywołaj 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 w postaci ciągów w parach klucz-wartość. Aby dodać więcej niż 50 usług, musisz dodać je automatycznie, korzystając z metod opisanych powyżej w sekcji Zapisywanie danych. Po ustawieniu właściwości skryptu na stronie ustawień projektu nie możesz odwoływać się do zmiennych skryptu.
Dodaj właściwości skryptu
- Otwórz projekt Apps Script.
- Po lewej stronie kliknij Ustawienia projektu .
- Aby dodać pierwszą właściwość, 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.
Edytuj 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.
- Zmień nazwę i wartość klucza w przypadku każdej właściwości, którą chcesz zmienić.
- Kliknij Zapisz właściwości skryptu.
Usuń 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 usługi, którą chcesz usunąć, kliknij Usuń .
- Kliknij Zapisz właściwości skryptu.