Questa pagina è stata tradotta dall'API Cloud Translation.

Class Properties

L'oggetto delle proprietà agisce come interfaccia per accedere alle proprietà utente, documento o script. Il tipo di proprietà specifico dipende da quale dei tre metodi di PropertiesService chiamati dallo script: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() o PropertiesService.getScriptProperties(). Le proprietà non possono essere condivise tra gli script. Per ulteriori informazioni sui tipi di proprietà, consulta la guida al servizio Properties.

Metodi

Metodo	Tipo restituito	Breve descrizione
`deleteAllProperties()`	`Properties`	Elimina tutte le proprietà nell'archivio `Properties` corrente.
`deleteProperty(key)`	`Properties`	Elimina la proprietà con la chiave specificata nell'archivio `Properties` corrente.
`getKeys()`	`String[]`	Recupera tutte le chiavi nell'archivio `Properties` corrente.
`getProperties()`	`Object`	Recupera una copia di tutte le coppie chiave-valore nell'archivio `Properties` corrente.
`getProperty(key)`	`String`	Recupera il valore associato alla chiave specificata nell'archivio `Properties` corrente oppure `null` se tale chiave non esiste.
`setProperties(properties)`	`Properties`	Imposta tutte le coppie chiave-valore dell'oggetto specificato nell'archivio `Properties` corrente.
`setProperties(properties, deleteAllOthers)`	`Properties`	Imposta tutte le coppie chiave-valore dell'oggetto specificato nell'archivio `Properties` corrente, eliminando facoltativamente tutte le altre proprietà nell'archivio.
`setProperty(key, value)`	`Properties`	Imposta la coppia chiave-valore specificata nell'archivio `Properties` corrente.

Documentazione dettagliata

`deleteAllProperties()`

Elimina tutte le proprietà nell'archivio Properties corrente.

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

Ritorni

Properties - questo negozio Properties, per il concatenamento

`deleteProperty(key)`

Elimina la proprietà con la chiave specificata nell'archivio Properties corrente.

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

Parametri

Nome	Tipo	Descrizione
`key`	`String`	la chiave della proprietà per eliminare

Ritorni

Properties - questo negozio Properties, per il concatenamento

`getKeys()`

Recupera tutte le chiavi nell'archivio Properties corrente.

// 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]);
}

Ritorni

String[]: un array di tutte le chiavi nell'archivio Properties corrente

`getProperties()`

Recupera una copia di tutte le coppie chiave-valore nell'archivio Properties corrente. Tieni presente che l'oggetto restituito non è una visualizzazione in diretta dell'archivio. Di conseguenza, la modifica delle proprietà dell'oggetto restituito non ne aggiorna automaticamente lo spazio di archiviazione e viceversa.

// 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]);
}

Ritorni

Object: una copia di tutte le coppie chiave-valore nell'attuale negozio Properties

`getProperty(key)`

Recupera il valore associato alla chiave specificata nell'archivio Properties corrente oppure null se tale chiave non esiste.

// Gets the user property 'nickname'.
var userProperties = PropertiesService.getUserProperties();
var nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

Parametri

Nome	Tipo	Descrizione
`key`	`String`	la chiave per il valore della proprietà da recuperare

Ritorni

String: il valore associato alla chiave specificata nell'archivio Properties corrente

`setProperties(properties)`

Imposta tutte le coppie chiave-valore dell'oggetto specificato nell'archivio Properties corrente.

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

Parametri

Nome	Tipo	Descrizione
`properties`	`Object`	un oggetto contenente coppie chiave-valore da impostare

Ritorni

Properties - questo negozio Properties, per il concatenamento

`setProperties(properties, deleteAllOthers)`

Imposta tutte le coppie chiave-valore dell'oggetto specificato nell'archivio Properties corrente, eliminando facoltativamente tutte le altre proprietà nell'archivio.

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

Parametri

Nome	Tipo	Descrizione
`properties`	`Object`	un oggetto contenente coppie chiave-valore da impostare
`deleteAllOthers`	`Boolean`	`true` per eliminare tutte le altre coppie chiave-valore nell'oggetto proprietà; `false` per non

Ritorni

Properties - questo negozio Properties, per il concatenamento

`setProperty(key, value)`

Imposta la coppia chiave-valore specificata nell'archivio Properties corrente.

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

Parametri

Nome	Tipo	Descrizione
`key`	`String`	la chiave della proprietà
`value`	`String`	il valore da associare alla chiave

Ritorni

Properties - questo negozio Properties, per il concatenamento