Ta strona została przetłumaczona przez Cloud Translation API.

Class Properties

Obiekt właściwości działa jako interfejs uzyskujący dostęp do właściwości użytkownika, dokumentu lub skryptu. Typ właściwości zależy od tego, która z 3 metod PropertiesService wywołanych przez skrypt: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() czy PropertiesService.getScriptProperties(). Nie można udostępniać właściwości 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 usługi w bieżącym magazynie `Properties`.
`deleteProperty(key)`	`Properties`	Usuwa usługę o danym kluczu w bieżącej bazie `Properties`.
`getKeys()`	`String[]`	Pobiera wszystkie klucze z bieżącego magazynu `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 inne właściwości w magazynie.
`setProperty(key, value)`	`Properties`	Ustawia podaną parę klucz-wartość w bieżącym magazynie `Properties`.

Szczegółowa dokumentacja

`deleteAllProperties()`

Usuwa wszystkie usługi w bieżącym magazynie Properties.

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

Powroty

Properties – ten sklep Properties, do tworzenia sieci

`deleteProperty(key)`

Usuwa usługę o danym kluczu w bieżącej bazie Properties.

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

Parametry

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

Powroty

Properties – ten sklep Properties, do tworzenia sieci

`getKeys()`

Pobiera wszystkie klucze z bieżącego magazynu 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]);
}

Powroty

String[] – tablica wszystkich kluczy w bieżącym magazynie Properties.

`getProperties()`

Pobiera kopię wszystkich par klucz-wartość w bieżącym magazynie Properties. Pamiętaj, że zwrócony obiekt nie jest podglądem magazynu na żywo. W rezultacie zmiana właściwości zwróconego obiektu nie spowoduje ich automatycznego zaktualizowania 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]);
}

Powroty

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

Powroty

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

Powroty

Properties – ten sklep Properties, do tworzenia sieci

`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.
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ść w obiekcie właściwości; `false`, aby nie

Powroty

Properties – ten sklep Properties, do tworzenia sieci

`setProperty(key, value)`

Ustawia podaną 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

Powroty

Properties – ten sklep Properties, do tworzenia sieci