Diese Seite wurde von der Cloud Translation API übersetzt.

Class Properties

Das Properties-Objekt dient als Schnittstelle für den Zugriff auf Nutzer-, Dokument- oder Skripteigenschaften. Die Property-Typ hängt davon ab, welche der drei PropertiesService-Methoden der Script mit dem Namen: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() oder PropertiesService.getScriptProperties(). Eigenschaften können nicht von mehreren Skripts gemeinsam genutzt werden. Weitere Informationen zu Attributtypen finden Sie in der 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 jeweiligen Objekt im aktuellen `Properties`-Speicher fest.
`setProperties(properties, deleteAllOthers)`	`Properties`	Legt alle Schlüssel/Wert-Paare aus dem jeweiligen Objekt im aktuellen `Properties`-Speicher fest. können Sie optional alle anderen Properties im Store löschen.
`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();

Rückflug

Properties – Properties-Shop, verkettet

`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

Rückflug

Properties – Properties-Shop, verkettet

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

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 Feld zurückgegebenes Objekt ist keine Live-Ansicht des Geschäfts. Entsprechend fällt das Ändern der Eigenschaften des werden diese nicht automatisch im Speicher aktualisiert oder 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]);
}

Rückflug

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

Rückflug

String – Der Wert, der dem jeweiligen Schlüssel im aktuellen Properties-Speicher zugeordnet ist

`setProperties(properties)`

Legt alle Schlüssel/Wert-Paare aus dem jeweiligen 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 mit den Schlüssel/Wert-Paaren, die festgelegt werden sollen.

Rückflug

Properties – Properties-Shop, verkettet

`setProperties(properties, deleteAllOthers)`

Legt alle Schlüssel/Wert-Paare aus dem jeweiligen Objekt im aktuellen Properties-Speicher fest. können Sie optional alle anderen Properties im Store löschen.

// 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 mit den Schlüssel/Wert-Paaren, die festgelegt werden sollen.
`deleteAllOthers`	`Boolean`	`true`, um alle anderen Schlüssel/Wert-Paare in den Attributen zu löschen Objekt; `false` bis nicht

Rückflug

Properties – Properties-Shop, verkettet

`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 die Eigenschaft
`value`	`String`	Wert, der mit dem Schlüssel verknüpft werden soll

Rückflug

Properties – Properties-Shop, verkettet