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 zur Verwendung der einzelnen Property-Typen finden Sie im Leitfaden zum Properties-Dienst.

Kurse

NameKurzbeschreibung
PropertiesDas Eigenschaftenobjekt dient als Schnittstelle für den Zugriff auf Nutzer-, Dokument- oder Skripteigenschaften.
PropertiesServiceErmöglicht Skripts das Speichern einfacher Daten in Schlüssel/Wert-Paaren für ein Skript, einen Nutzer eines Skripts oder ein Dokument, in dem ein Add-on verwendet wird.
ScriptPropertiesSkripteigenschaften sind Schlüssel/Wert-Paare, die von einem Skript in einem nichtflüchtigen Speicher gespeichert werden.
UserPropertiesNutzereigenschaften sind eindeutige Schlüssel/Wert-Paare für einen Nutzer.

Properties

Methoden

MethodeRückgabetypKurzbeschreibung
deleteAllProperties()PropertiesLöscht alle Properties im aktuellen Properties-Speicher.
deleteProperty(key)PropertiesLöscht das Attribut 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 mit dem angegebenen Schlüssel im aktuellen Properties-Speicher verknüpft ist, oder null, wenn kein solcher Schlüssel vorhanden ist.
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. Optional werden alle anderen Attribute im Speicher gelöscht.
setProperty(key, value)PropertiesLegt das angegebene Schlüssel/Wert-Paar im aktuellen Properties-Speicher fest.

PropertiesService

Methoden

MethodeRückgabetypKurzbeschreibung
getDocumentProperties()PropertiesRuft einen Eigenschaftenspeicher (nur für dieses Skript) ab, auf den alle Nutzer innerhalb des geöffneten Dokuments, der Tabelle oder des Formulars zugreifen können.
getScriptProperties()PropertiesRuft einen Property-Speicher ab, auf den alle Nutzer zugreifen können, jedoch nur innerhalb dieses Skripts.
getUserProperties()PropertiesRuft einen Eigenschaftenspeicher ab, auf den nur der aktuelle Nutzer und nur innerhalb dieses Skripts zugreifen kann.

ScriptProperties

UserProperties