Class Properties

Properties

Das Properties-Objekt dient als Schnittstelle für den Zugriff auf Nutzer-, Dokument- oder Scripteigenschaften. Der spezifische Attributtyp hängt davon ab, welche der drei Methoden von PropertiesService das Script aufgerufen hat: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() oder PropertiesService.getScriptProperties(). Eigenschaften können nicht zwischen Scripts geteilt werden. Weitere Informationen zu Property-Typen finden Sie im Leitfaden zum Properties-Dienst.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
deleteAllProperties()	Properties	Alle Properties im aktuellen Properties-Shop werden gelöscht.
deleteProperty(key)	Properties	Löscht die Property mit dem angegebenen Schlüssel im aktuellen Properties-Shop.
getKeys()	String[]	Ruft alle Schlüssel im aktuellen Properties-Shop ab.
getProperties()	Object	Ruft eine Kopie aller Schlüssel/Wert-Paare im aktuellen Properties-Speicher ab.
getProperty(key)	String	Ruft den Wert ab, der dem angegebenen Schlüssel im aktuellen Properties-Speicher zugeordnet ist, oder null, wenn kein solcher Schlüssel vorhanden ist.
setProperties(properties)	Properties	Hiermit werden alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties-Speicher festgelegt.
setProperties(properties, deleteAllOthers)	Properties	Hiermit werden alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties-Speicher festgelegt. Optional werden alle anderen Properties im Speicher gelöscht.
setProperty(key, value)	Properties	Legt das angegebene Schlüssel/Wert-Paar im aktuellen Properties-Shop fest.

Detaillierte Dokumentation

deleteAllProperties()

Alle Properties im aktuellen Properties-Shop werden gelöscht.

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

Rückflug

Properties – dieser Properties-Shop, für die Verkettung

---

deleteProperty(key)

Löscht die Property mit dem angegebenen Schlüssel im aktuellen Properties-Shop.

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

Parameter

Name	Typ	Beschreibung
key	String	der Schlüssel für die zu löschende Property

Rückflug

Properties – dieser Properties-Shop, für die Verkettung

---

getKeys()

Ruft alle Schlüssel im aktuellen Properties-Shop ab.

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

Rückflug

String[]: ein Array aller Schlüssel im aktuellen Properties-Speicher

---

getProperties()

Ruft eine Kopie aller Schlüssel/Wert-Paare im aktuellen Properties-Speicher ab. Das zurückgegebene Objekt ist kein Livebild des Geschäfts. Wenn Sie also die Eigenschaften des zurückgegebenen Objekts ändern, werden sie nicht automatisch im Speicher aktualisiert. Das gilt auch umgekehrt.

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

Rückflug

Object: eine Kopie aller Schlüssel/Wert-Paare im aktuellen Properties-Speicher

---

getProperty(key)

Ruft den Wert ab, der dem angegebenen Schlüssel im aktuellen Properties-Speicher zugeordnet ist, oder null, wenn kein solcher Schlüssel vorhanden ist.

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

Parameter

Name	Typ	Beschreibung
key	String	der Schlüssel für den abzurufenden Property-Wert

Rückflug

String: Der Wert, der dem angegebenen Schlüssel im aktuellen Properties-Speicher zugeordnet ist.

---

setProperties(properties)

Hiermit werden alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties-Speicher festgelegt.

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

Parameter

Name	Typ	Beschreibung
properties	Object	ein Objekt mit Schlüssel/Wert-Paaren, die festgelegt werden sollen

Rückflug

Properties – dieser Properties-Shop, für die Verkettung

---

setProperties(properties, deleteAllOthers)

Hiermit werden alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties-Speicher festgelegt. Optional werden alle anderen Properties im Speicher gelöscht.

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

Parameter

Name	Typ	Beschreibung
properties	Object	ein Objekt mit Schlüssel/Wert-Paaren, die festgelegt werden sollen
deleteAllOthers	Boolean	true, um alle anderen Schlüssel/Wert-Paare im Properties-Objekt zu löschen, false, um das nicht zu tun

Rückflug

Properties – dieser Properties-Shop, für die Verkettung

---

setProperty(key, value)

Legt das angegebene Schlüssel/Wert-Paar im aktuellen Properties-Shop fest.

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

Parameter

Name	Typ	Beschreibung
key	String	den Schlüssel für die Property
value	String	den Wert, der dem Schlüssel zugeordnet werden soll

Rückflug

Properties – dieser Properties-Shop, für die Verkettung