Class Properties

Usługi

Obiekt properties służy jako interfejs dostępu do właściwości użytkownika, dokumentu lub skryptu. Rodzaj właściwości zależy od tego, którą z 3 metod PropertiesService wywołał skrypt: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() lub PropertiesService.getScriptProperties(). Właściwości nie można udostępniać między skryptami. Więcej informacji o typach usług znajdziesz w przewodniku po usłudze 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 właściwość o podanym kluczu z bieżącego Properties.
getKeys()	String[]	Pobiera wszystkie klucze w bieżącym sklepie Properties.
getProperties()	Object	Pobiera kopię wszystkich par klucz-wartość w bieżącym Properties.
getProperty(key)	String	Pobiera wartość powiązaną z podanym kluczem w bieżącym sklepie Properties lub null, jeśli taki klucz nie istnieje.
setProperties(properties)	Properties	Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym Properties.
setProperties(properties, deleteAllOthers)	Properties	Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym Properties sklepie, opcjonalnie usuwając wszystkie inne właściwości w sklepie.
setProperty(key, value)	Properties	Ustawia podaną parę klucz-wartość w bieżącym sklepie Properties.

Szczegółowa dokumentacja

deleteAllProperties()

Usuwa wszystkie właściwości w bieżącym magazynie Properties.

// Deletes all user properties.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

Powrót

Properties – ten sklep Properties, do łączenia w łańcuch

---

deleteProperty(key)

Usuwa właściwość o podanym kluczu z bieżącego Properties.

// Deletes the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

Parametry

Nazwa	Typ	Opis
key	String	klucz usługi do usunięcia;

Powrót

Properties – ten sklep Properties, do łączenia w łańcuch

---

getKeys()

Pobiera wszystkie klucze w bieżącym sklepie Properties.

// Sets several properties, then logs the value of each key.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});
const keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (let 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 Properties. Pamiętaj, że zwrócony obiekt nie jest widokiem na żywo sklepu. W związku z tym zmiana właściwości zwróconego obiektu nie spowoduje automatycznej aktualizacji tych właściwości w pamięci i odwrotnie.

// Sets several script properties, then retrieves them and logs them.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});

const animalSounds = scriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for (const kind in animalSounds) {
  Logger.log('A %s goes %s!', kind, animalSounds[kind]);
}

Powrót

Object – kopia wszystkich par klucz-wartość w bieżącym sklepie Properties.

---

getProperty(key)

Pobiera wartość powiązaną z podanym kluczem w bieżącym sklepie Properties lub null, jeśli taki klucz nie istnieje.

// Gets the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
const 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 Properties.

---

setProperties(properties)

Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym Properties.

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const 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 – ten sklep Properties, do łączenia w łańcuch

---

setProperties(properties, deleteAllOthers)

Ustawia wszystkie pary klucz-wartość z danego obiektu w bieżącym Properties sklepie, opcjonalnie usuwając wszystkie inne właściwości w sklepie.

// Sets multiple user properties at once while deleting all other user
// properties.
const userProperties = PropertiesService.getUserProperties();
const 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 inne pary klucz-wartość w obiekcie właściwości; false – aby nie

Powrót

Properties – ten sklep Properties, do łączenia w łańcuch

---

setProperty(key, value)

Ustawia podaną parę klucz-wartość w bieżącym sklepie Properties.

// Sets the user property 'nickname' to 'Bobby'.
const userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

Parametry

Nazwa	Typ	Opis
key	String	klucz usługi,
value	String	wartość, którą chcesz powiązać z kluczem.

Powrót

Properties – ten sklep Properties, do łączenia w łańcuch