Obiekt właściwości pełni funkcję interfejsu umożliwiającego dostęp do właściwości użytkownika, dokumentów i skryptów.
zależy od tego, która z 3 metod funkcji PropertiesService
skrypt o nazwie PropertiesService.getDocumentProperties()
, PropertiesService.getUserProperties()
lub PropertiesService.getScriptProperties()
.
Właściwości nie można współdzielić między skryptami. Więcej informacji o typach usług znajdziesz w
zapoznaniu się z usługą Właściwości.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
deleteAllProperties() | Properties | Usuwa wszystkie właściwości w bieżącym magazynie Properties . |
deleteProperty(key) | Properties | Usuwa usługę o podanym kluczu w bieżącym magazynie Properties . |
getKeys() | String[] | Pobiera wszystkie klucze w obecnym magazynie Properties . |
getProperties() | Object | Pobiera kopię wszystkich par klucz-wartość w bieżącym magazynie Properties . |
getProperty(key) | String | Pobiera wartość powiązaną z danym kluczem w bieżącym magazynie Properties lub null , jeśli taki klucz nie istnieje. |
setProperties(properties) | Properties | Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym magazynie Properties . |
setProperties(properties, deleteAllOthers) | Properties | Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym magazynie Properties ,
opcjonalnie usuwając wszystkie pozostałe usługi w magazynie. |
setProperty(key, value) | Properties | Ustawia daną parę klucz-wartość w bieżącym magazynie Properties . |
Szczegółowa dokumentacja
deleteAllProperties()
Usuwa wszystkie właściwości w bieżącym magazynie Properties
.
// Deletes all user properties. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteAllProperties();
Powrót
Properties
– sklep Properties
, sieciowy
deleteProperty(key)
Usuwa usługę o podanym kluczu w bieżącym magazynie Properties
.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
Parametry
Nazwa | Typ | Opis |
---|---|---|
key | String | klucz do usunięcia usługi |
Powrót
Properties
– sklep Properties
, sieciowy
getKeys()
Pobiera wszystkie klucze w obecnym magazynie Properties
.
// Sets several properties, then logs the value of each key. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); var keys = scriptProperties.getKeys(); Logger.log('Animals known:'); for (var i = 0; i < keys.length; i++) { Logger.log(keys[i]); }
Powrót
String[]
– tablica wszystkich kluczy w bieżącym magazynie Properties
getProperties()
Pobiera kopię wszystkich par klucz-wartość w bieżącym magazynie Properties
. Pamiętaj, że parametr
zwrócony obiekt nie jest podglądem na żywo magazynu. W związku z tym zmiana właściwości w
zwrócony obiekt nie będzie automatycznie aktualizować go w pamięci (i odwrotnie).
// Sets several script properties, then retrieves them and logs them. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); var animalSounds = scriptProperties.getProperties(); // Logs: // A chicken goes cluck! // A cow goes moo! // A sheep goes baa! for (var kind in animalSounds) { Logger.log('A %s goes %s!', kind, animalSounds[kind]); }
Powrót
Object
– kopia wszystkich par klucz-wartość w bieżącym magazynie Properties
getProperty(key)
Pobiera wartość powiązaną z danym kluczem w bieżącym magazynie Properties
lub null
, jeśli taki klucz nie istnieje.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var nickname = userProperties.getProperty('nickname'); Logger.log(nickname);
Parametry
Nazwa | Typ | Opis |
---|---|---|
key | String | klucz wartości właściwości do pobrania |
Powrót
String
– wartość powiązana z danym kluczem w bieżącym magazynie Properties
.
setProperties(properties)
Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym magazynie Properties
.
// Sets multiple user properties at once. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties);
Parametry
Nazwa | Typ | Opis |
---|---|---|
properties | Object | obiekt zawierający pary klucz-wartość do ustawienia |
Powrót
Properties
– sklep Properties
, sieciowy
setProperties(properties, deleteAllOthers)
Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym magazynie Properties
,
opcjonalnie usuwając wszystkie pozostałe usługi w magazynie.
// Sets multiple user properties at once while deleting all other user properties. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties, true);
Parametry
Nazwa | Typ | Opis |
---|---|---|
properties | Object | obiekt zawierający pary klucz-wartość do ustawienia |
deleteAllOthers | Boolean | true , aby usunąć wszystkie pozostałe pary klucz-wartość we właściwościach
obiektu; Z: false na nie |
Powrót
Properties
– sklep Properties
, sieciowy
setProperty(key, value)
Ustawia daną parę klucz-wartość w bieżącym magazynie Properties
.
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
Parametry
Nazwa | Typ | Opis |
---|---|---|
key | String | klucz usługi |
value | String | wartość do powiązania z kluczem |
Powrót
Properties
– sklep Properties
, sieciowy