Properties Service

Properties

Mit diesem Dienst können Strings in Scripts als Schlüssel/Wert-Paare gespeichert werden, die auf ein Script, einen Nutzer eines Scripts oder ein Dokument beschränkt sind, in dem ein Editor-Add-on verwendet wird. Weitere Informationen dazu, wann Sie welchen Property-Typ verwenden sollten, finden Sie im Leitfaden zum Properties-Dienst.

Classes

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

Properties

Methoden

MethodeRückgabetypKurzbeschreibung
deleteAllProperties()PropertiesAlle Properties im aktuellen Properties-Shop werden gelöscht.
deleteProperty(key)PropertiesLöscht die Property mit dem angegebenen Schlüssel im aktuellen Properties-Shop.
getKeys()String[]Ruft alle Schlüssel im aktuellen Properties-Shop 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, oder null, wenn kein solcher Schlüssel vorhanden ist.
setProperties(properties)PropertiesHiermit werden alle Schlüssel/Wert-Paare aus dem angegebenen Objekt im aktuellen Properties-Speicher festgelegt.
setProperties(properties, deleteAllOthers)PropertiesHiermit 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)PropertiesLegt das angegebene Schlüssel/Wert-Paar im aktuellen Properties-Shop fest.

PropertiesService

Methoden

MethodeRückgabetypKurzbeschreibung
getDocumentProperties()PropertiesRuft ein Property-Store (nur für dieses Script) ab, auf das alle Nutzer im geöffneten Dokument, in der geöffneten Tabelle oder im geöffneten Formular zugreifen können.
getScriptProperties()PropertiesRuft ein Property-Store ab, auf das alle Nutzer zugreifen können, aber nur innerhalb dieses Scripts.
getUserProperties()PropertiesRuft ein Property-Store ab, auf das nur der aktuelle Nutzer und nur innerhalb dieses Scripts zugreifen kann.

ScriptProperties

UserProperties