Das Eigenschaftenobjekt dient als Schnittstelle für den Zugriff auf Nutzer-, Dokument- oder Skripteigenschaften. Der jeweilige Attributtyp hängt davon ab, welche der drei PropertiesService
-Methoden des Skripts PropertiesService.getDocumentProperties()
, PropertiesService.getUserProperties()
oder PropertiesService.getScriptProperties()
aufgerufen wurde.
Properties können nicht von mehreren Skripts gemeinsam verwendet werden. Weitere Informationen zu Property-Typen finden Sie im Leitfaden zum Properties-Dienst.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
deleteAllProperties() | Properties | Löscht alle Properties im aktuellen Properties -Speicher. |
deleteProperty(key) | Properties | Löscht das Attribut mit dem angegebenen Schlüssel im aktuellen Properties -Speicher. |
getKeys() | String[] | Ruft alle Schlüssel im aktuellen Properties -Speicher ab. |
getProperties() | Object | Ruft eine Kopie aller Schlüssel/Wert-Paare im aktuellen Properties -Speicher ab. |
getProperty(key) | String | Ruft den Wert ab, der mit dem angegebenen Schlüssel im aktuellen Properties -Speicher verknüpft ist, oder null , wenn kein solcher Schlüssel vorhanden ist. |
setProperties(properties) | Properties | Legt alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties -Speicher fest. |
setProperties(properties, deleteAllOthers) | Properties | Legt alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties -Speicher fest. Optional werden alle anderen Attribute im Speicher gelöscht. |
setProperty(key, value) | Properties | Legt das angegebene Schlüssel/Wert-Paar im aktuellen Properties -Speicher fest. |
Detaillierte Dokumentation
deleteAllProperties()
Löscht alle Properties im aktuellen Properties
-Speicher.
// Deletes all user properties. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteAllProperties();
Return
Properties
– dieses Properties
-Geschäft zur Verkettung
deleteProperty(key)
Löscht das Attribut mit dem angegebenen Schlüssel im aktuellen Properties
-Speicher.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
Parameter
Name | Typ | Beschreibung |
---|---|---|
key | String | Den Schlüssel für das zu löschende Attribut |
Return
Properties
– dieses Properties
-Geschäft zur Verkettung
getKeys()
Ruft alle Schlüssel im aktuellen Properties
-Speicher ab.
// 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]); }
Return
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 keine Live-Ansicht des Geschäfts. Folglich werden die Eigenschaften des zurückgegebenen Objekts nicht automatisch im Speicher aktualisiert und umgekehrt.
// 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]); }
Return
Object
: eine Kopie aller Schlüssel/Wert-Paare im aktuellen Properties
-Speicher
getProperty(key)
Ruft den Wert ab, der mit dem angegebenen Schlüssel im aktuellen Properties
-Speicher verknüpft ist, oder null
, wenn kein solcher Schlüssel vorhanden ist.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var nickname = userProperties.getProperty('nickname'); Logger.log(nickname);
Parameter
Name | Typ | Beschreibung |
---|---|---|
key | String | den Schlüssel für den abzurufenden Eigenschaftswert |
Return
String
– der Wert, der dem angegebenen Schlüssel im aktuellen Properties
-Speicher zugeordnet ist
setProperties(properties)
Legt alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties
-Speicher fest.
// Sets multiple user properties at once. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties);
Parameter
Name | Typ | Beschreibung |
---|---|---|
properties | Object | ein Objekt, das Schlüssel/Wert-Paare enthält, die festgelegt werden sollen |
Return
Properties
– dieses Properties
-Geschäft zur Verkettung
setProperties(properties, deleteAllOthers)
Legt alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties
-Speicher fest. Optional werden alle anderen Attribute im Speicher gelöscht.
// 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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
properties | Object | ein Objekt, das Schlüssel/Wert-Paare enthält, die festgelegt werden sollen |
deleteAllOthers | Boolean | true , um alle anderen Schlüssel/Wert-Paare im Properties-Objekt zu löschen; false , um nicht |
Return
Properties
– dieses Properties
-Geschäft zur Verkettung
setProperty(key, value)
Legt das angegebene Schlüssel/Wert-Paar im aktuellen Properties
-Speicher fest.
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
Parameter
Name | Typ | Beschreibung |
---|---|---|
key | String | den Schlüssel für das Attribut |
value | String | Wert, der dem Schlüssel zugeordnet werden soll |
Return
Properties
– dieses Properties
-Geschäft zur Verkettung