Class Properties

Proprietà

L'oggetto properties funge da interfaccia per accedere alle proprietà utente, del documento o dello script. Il tipo di proprietà specifico dipende da quale dei tre metodi di PropertiesService viene 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 Properties.

Metodi

Metodo	Tipo restituito	Breve descrizione
deleteAllProperties()	Properties	Consente di eliminare tutte le proprietà nello spazio di archiviazione Properties corrente.
deleteProperty(key)	Properties	Elimina la proprietà con la chiave specificata nello spazio di archiviazione Properties corrente.
getKeys()	String[]	Recupera tutte le chiavi nell'archivio Properties corrente.
getProperties()	Object	Recupera una copia di tutte le coppie chiave/valore nello store Properties corrente.
getProperty(key)	String	Restituisce il valore associato alla chiave specificata nell'Properties store corrente o null se non esiste una chiave di questo tipo.
setProperties(properties)	Properties	Imposta tutte le coppie chiave-valore dell'oggetto specificato nello spazio dei Properties correnti.
setProperties(properties, deleteAllOthers)	Properties	Imposta tutte le coppie chiave-valore dell'oggetto specificato nell'archivio Properties corrente, eventualmente eliminando tutte le altre proprietà dell'archivio.
setProperty(key, value)	Properties	Imposta la coppia chiave-valore specificata nello store Properties corrente.

Documentazione dettagliata

deleteAllProperties()

Consente di eliminare tutte le proprietà nello spazio di archiviazione Properties corrente.

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

Invio

Properties: questo negozio Properties, per l'accodamento

---

deleteProperty(key)

Elimina la proprietà con la chiave specificata nello spazio di archiviazione 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

Invio

Properties: questo negozio Properties, per l'accodamento

---

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

Invio

String[]: un array di tutte le chiavi nell'attuale negozio Properties

---

getProperties()

Recupera una copia di tutte le coppie chiave/valore nello store 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 in 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]);
}

Invio

Object: una copia di tutte le coppie chiave/valore nello store Properties corrente

---

getProperty(key)

Restituisce il valore associato alla chiave specificata nell'Properties store 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 del valore della proprietà da recuperare

Invio

String: il valore associato alla chiave specificata nello store Properties corrente

---

setProperties(properties)

Imposta tutte le coppie chiave-valore dell'oggetto specificato nello spazio dei Properties correnti.

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

Invio

Properties: questo negozio Properties, per l'accodamento

---

setProperties(properties, deleteAllOthers)

Imposta tutte le coppie chiave-valore dell'oggetto specificato nell'archivio Properties corrente, optionally deleting all other properties in the store. eventualmente eliminando 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 farlo

Invio

Properties: questo negozio Properties, per l'accodamento

---

setProperty(key, value)

Imposta la coppia chiave-valore specificata nello store 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 per la proprietà
value	String	il valore da associare alla chiave

Invio

Properties: questo negozio Properties, per l'accodamento