Class Properties

Usługi

Obiekt properties działa jako interfejs do uzyskiwania dostępu do właściwości użytkownika, dokumentu lub skryptu. Konkretny typ właściwości zależy od tego, która z 3 metod PropertiesService została wywołana w skrypcie: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() lub PropertiesService.getScriptProperties(). Właściwości nie mogą być współdzielone przez skrypty. Więcej informacji o typach właściwości znajdziesz w przewodniku po usłudze Właściwości.

Metody

MetodaZwracany typKrótki opis
deleteAllProperties()PropertiesUsuwa wszystkie właściwości w bieżącym sklepie Properties.
deleteProperty(key)PropertiesUsuwa w bieżącym Properties Store usługę o danym kluczu.
getKeys()String[]Pobiera wszystkie klucze z bieżącego sklepu Properties.
getProperties()ObjectPobiera kopię wszystkich par klucz-wartość w bieżącym sklepie Properties.
getProperty(key)StringPobiera wartość powiązaną z danym kluczem w bieżącym Properties lub null, jeśli taki klucz nie istnieje.
setProperties(properties)PropertiesUstawia wszystkie pary klucz-wartość z danego obiektu w bieżącym magazynie Properties.
setProperties(properties, deleteAllOthers)PropertiesUstawia wszystkie pary klucz-wartość z danego obiektu w bieżącym magazynie Properties, opcjonalnie usuwając wszystkie inne właściwości w magazynie.
setProperty(key, value)PropertiesUstawia parę klucz-wartość w bieżącym magazynie Properties.

Szczegółowa dokumentacja

deleteAllProperties()

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

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

Powrót

Properties – ten sklep Properties, do którego należy sieć


deleteProperty(key)

Usuwa w bieżącym Properties Store usługę o danym kluczu.

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

Parametry

NazwaTypOpis
keyStringklucza usługi, którą chcesz usunąć;

Powrót

Properties – ten sklep Properties, do którego należy sieć


getKeys()

Pobiera wszystkie klucze z bieżącego sklepu 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 sklepie Properties


getProperties()

Pobiera kopię wszystkich par klucz-wartość w bieżącym sklepie 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 ich automatycznej aktualizacji w magazynie 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 danym kluczem w bieżącym 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

NazwaTypOpis
keyStringklucza wartości właściwości do pobrania;

Powrót

String – wartość powiązana z danym kluczem w bieżącym sklepie Properties


setProperties(properties)

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

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

Parametry

NazwaTypOpis
propertiesObjectobiekt zawierający pary klucz-wartość do ustawienia

Powrót

Properties – ten sklep Properties, do którego należy sieć


setProperties(properties, deleteAllOthers)

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

// 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

NazwaTypOpis
propertiesObjectobiekt zawierający pary klucz-wartość do ustawienia
deleteAllOthersBooleantrue, aby usunąć wszystkie inne pary klucz-wartość w obiekcie properties; false, aby tego nie robić.

Powrót

Properties – ten sklep Properties, do którego należy sieć;


setProperty(key, value)

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

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

Parametry

NazwaTypOpis
keyStringklucz właściwości,
valueStringwartość do powiązania z kluczem.

Powrót

Properties – ten sklep Properties, do którego należy sieć;