Class Properties

Proprietà

L'oggetto Properties funge da interfaccia per accedere alle proprietà di utenti, documenti o script. Il tipo di proprietà specifico dipende da quale dei tre metodi di PropertiesService ha chiamato lo script: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() o PropertiesService.getScriptProperties(). Le proprietà non possono essere condivise tra gli script. Per saperne di più sui tipi di proprietà, consulta la guida al servizio proprietà.

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	Restituisce il valore associato alla chiave specificata nell'archivio Properties corrente o null se non esiste una chiave di questo tipo.
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.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

Indietro

Properties: questo datastore Properties, per il concatenamento

---

deleteProperty(key)

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

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

Parametri

Nome	Tipo	Descrizione
key	String	la chiave della proprietà da eliminare

Indietro

Properties: questo datastore Properties, per il concatenamento

---

getKeys()

Recupera tutte le chiavi nell'archivio Properties corrente.

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

Indietro

String[]: un array di tutte le chiavi nel datastore 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 tempo reale del negozio. Di conseguenza, la modifica delle proprietà dell'oggetto restituito non le aggiornerà automaticamente nello spazio di archiviazione e viceversa.

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

Indietro

Object: una copia di tutte le coppie chiave-valore nell'archivio Properties corrente

---

getProperty(key)

Restituisce il valore associato alla chiave specificata nell'archivio Properties corrente o null se non esiste una chiave di questo tipo.

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

Parametri

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

Indietro

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.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

Parametri

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

Indietro

Properties: questo datastore 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.
const userProperties = PropertiesService.getUserProperties();
const 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 properties; false per non

Indietro

Properties: questo datastore Properties, per il concatenamento

---

setProperty(key, value)

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

// Sets the user property 'nickname' to 'Bobby'.
const 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

Indietro

Properties: questo datastore Properties, per il concatenamento