Class PropertiesService
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
PropertiesService
Ermö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. Eigenschaften können nicht zwischen Scripts geteilt werden.
Weitere Informationen dazu, wann Sie welchen Property-Typ verwenden sollten, finden Sie im Leitfaden zum Properties-Dienst.
// Sets three properties of different types.
const documentProperties = PropertiesService.getDocumentProperties();
const scriptProperties = PropertiesService.getScriptProperties();
const userProperties = PropertiesService.getUserProperties();
documentProperties.setProperty('DAYS_TO_FETCH', '5');
scriptProperties.setProperty(
'SERVER_URL',
'http://www.example.com/MyWeatherService/',
);
userProperties.setProperty('DISPLAY_UNITS', 'metric');
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
getDocumentProperties() | Properties | Ruft 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() | Properties | Ruft ein Property-Store ab, auf das alle Nutzer zugreifen können, aber nur innerhalb dieses Scripts. |
getUserProperties() | Properties | Ruft ein Property-Store ab, auf das nur der aktuelle Nutzer und nur innerhalb dieses Scripts zugreifen kann. |
Detaillierte Dokumentation
getDocumentProperties()
Ruft 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. Sie ist nur verfügbar, wenn das Script veröffentlicht und als Add-on ausgeführt wird oder wenn es mit einem Google-Dateityp gebunden ist. Wenn keine Dokumenteneigenschaften verfügbar sind, gibt diese Methode null zurück. Auf Dokumenteigenschaften, die von einem Script erstellt wurden, kann nicht außerhalb dieses Scripts zugegriffen werden, auch nicht von anderen Scripts, die auf dasselbe Dokument zugreifen.
Rückflug
Properties: Ein Property-Store nur für dieses Script, auf den alle Nutzer des aktuellen Dokuments zugreifen können, oder null, wenn das Script kein Add-on ist oder nicht an eine Google Workspace-Datei gebunden ist
getScriptProperties()
Ruft ein Property-Store ab, auf das alle Nutzer zugreifen können, aber nur innerhalb dieses Scripts.
Rückflug
Properties – ein Property-Store, auf den alle Nutzer des Scripts zugreifen können
getUserProperties()
Ruft ein Property-Store ab, auf das nur der aktuelle Nutzer und nur innerhalb dieses Scripts zugreifen kann.
Rückflug
Properties: Property-Store, auf den nur der aktuelle Nutzer des Scripts zugreifen kann
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003eThe Properties Service lets Apps Script store simple data as key-value pairs, with different scopes for scripts, users, and documents.\u003c/p\u003e\n"],["\u003cp\u003eIt offers three methods to access properties: \u003ccode\u003egetDocumentProperties()\u003c/code\u003e, \u003ccode\u003egetScriptProperties()\u003c/code\u003e, and \u003ccode\u003egetUserProperties()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetDocumentProperties()\u003c/code\u003e provides property storage accessible to all users within a specific document, spreadsheet, or form where the script is running.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetScriptProperties()\u003c/code\u003e allows storing properties accessible to all users, but only within the context of the current script.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetUserProperties()\u003c/code\u003e provides a property store specific to the current user and accessible only within the current script.\u003c/p\u003e\n"]]],["The `PropertiesService` stores data in key-value pairs, accessible via `getDocumentProperties`, `getScriptProperties`, and `getUserProperties`. `getDocumentProperties` stores data within a specific document, accessible to all users. `getScriptProperties` stores data within a script, accessible to all users. `getUserProperties` stores data for a single user within a script. The example code demonstrates setting properties using each method: `setProperty`. Each method returns a `Properties` object, which is a property store.\n"],null,["# Class PropertiesService\n\nPropertiesService\n\nAllows scripts to store simple data in key-value pairs scoped to one script, one user of a\nscript, or one document in which an add-on is used. Properties cannot be shared between scripts.\nFor more information about when to use each type of property, see the [guide to the Properties service](/apps-script/guides/properties).\n\n```javascript\n// Sets three properties of different types.\nconst documentProperties = PropertiesService.getDocumentProperties();\nconst scriptProperties = PropertiesService.getScriptProperties();\nconst userProperties = PropertiesService.getUserProperties();\n\ndocumentProperties.setProperty('DAYS_TO_FETCH', '5');\nscriptProperties.setProperty(\n 'SERVER_URL',\n 'http://www.example.com/MyWeatherService/',\n);\nuserProperties.setProperty('DISPLAY_UNITS', 'metric');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|\n| [getDocumentProperties()](#getDocumentProperties()) | [Properties](/apps-script/reference/properties/properties) | Gets a property store (for this script only) that all users can access within the open document, spreadsheet, or form. |\n| [getScriptProperties()](#getScriptProperties()) | [Properties](/apps-script/reference/properties/properties) | Gets a property store that all users can access, but only within this script. |\n| [getUserProperties()](#getUserProperties()) | [Properties](/apps-script/reference/properties/properties) | Gets a property store that only the current user can access, and only within this script. |\n\nDetailed documentation\n----------------------\n\n### `get``Document``Properties()`\n\nGets a property store (for this script only) that all users can access within the open\ndocument, spreadsheet, or form. It is only available if the script is published and executing\nas an add-on or if it is [bound](https://developers.google.com/apps-script/scripts_containers) to a Google file\ntype. When document properties are not available this method returns `null`. Document\nproperties created by a script are not accessible outside that script, even by other scripts\naccessing the same document.\n\n#### Return\n\n\n[Properties](/apps-script/reference/properties/properties) --- a property store for this script only that all users of the current document can\naccess, or `null` if the script is not either an add-on or bound to a Google\nWorkspace file\n\n*** ** * ** ***\n\n### `get``Script``Properties()`\n\nGets a property store that all users can access, but only within this script.\n\n#### Return\n\n\n[Properties](/apps-script/reference/properties/properties) --- a property store that all users of the script can access\n\n*** ** * ** ***\n\n### `get``User``Properties()`\n\nGets a property store that only the current user can access, and only within this script.\n\n#### Return\n\n\n[Properties](/apps-script/reference/properties/properties) --- a property store that only the current user of the script can access"]]
