Properties Service

Properties

Mit diesem Dienst können Skripts Strings als Schlüssel/Wert-Paare speichern, die auf ein Skript, einen Nutzer eines Skripts oder ein Dokument beschränkt sind, in dem ein Editor-Add-on verwendet wird. Weitere Informationen dazu, wann die einzelnen Arten von Properties verwendet werden sollten, finden Sie im Leitfaden zum Properties-Dienst.

Klassen

NameKurzbeschreibung
PropertiesDas Properties-Objekt dient als Schnittstelle für den Zugriff auf Nutzer-, Dokument- oder Skript-Properties.
PropertiesServiceErmöglicht Skripts, einfache Daten in Schlüssel/Wert-Paaren zu speichern, die auf ein Skript, einen Nutzer eines Skripts oder ein Dokument beschränkt sind, in dem ein Add-on verwendet wird.
ScriptPropertiesSkript-Properties sind Schlüssel/Wert-Paare, die von einem Skript in einem persistenten Speicher gespeichert werden.
UserPropertiesNutzer-Properties sind Schlüssel/Wert-Paare, die für einen Nutzer eindeutig sind.

Properties

Methoden

MethodeRückgabetypKurzbeschreibung
deleteAllProperties()PropertiesLöscht alle Properties im aktuellen Properties-Speicher.
deleteProperty(key)PropertiesLöscht die Property mit dem angegebenen Schlüssel im aktuellen Properties-Speicher.
getKeys()String[]Ruft alle Schlüssel im aktuellen Properties-Speicher ab.
getProperties()ObjectRuft eine Kopie aller Schlüssel/Wert-Paare im aktuellen Properties-Speicher ab.
getProperty(key)StringRuft den Wert ab, der dem angegebenen Schlüssel im aktuellen Properties-Speicher zugeordnet ist. Wenn kein solcher Schlüssel vorhanden ist, wird null zurückgegeben.
setProperties(properties)PropertiesLegt alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties-Speicher fest.
setProperties(properties, deleteAllOthers)PropertiesLegt alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties-Speicher fest und löscht optional alle anderen Properties im Speicher.
setProperty(key, value)PropertiesLegt das angegebene Schlüssel/Wert-Paar im aktuellen Properties-Speicher fest.

PropertiesService

Methoden

MethodeRückgabetypKurzbeschreibung
getDocumentProperties()PropertiesRuft einen Properties-Speicher (nur für dieses Skript) ab, auf den alle Nutzer im geöffneten Dokument, in der Tabelle oder im Formular zugreifen können.
getScriptProperties()PropertiesRuft einen Properties-Speicher ab, auf den alle Nutzer zugreifen können, aber nur in diesem Skript.
getUserProperties()PropertiesRuft einen Properties-Speicher ab, auf den nur der aktuelle oder effektive Nutzer zugreifen kann und nur in diesem Skript.

ScriptProperties

UserProperties