Class PropertiesService
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Usługi
Umożliwia skryptom przechowywanie prostych danych w parach klucz-wartość ograniczonych do jednego skryptu, jednego użytkownika skryptu lub jednego dokumentu, w którym używany jest dodatek. Właściwości nie mogą być współdzielone przez skrypty.
Więcej informacji o tym, kiedy należy używać poszczególnych typów właściwości, znajdziesz w przewodniku po usłudze Properties.
// 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');
Metody
Metoda | Zwracany typ | Krótki opis |
getDocumentProperties() | Properties | Pobiera z otwartego dokumentu, arkusza kalkulacyjnego lub formularza magazyn właściwości (tylko w przypadku tego skryptu), do którego mają dostęp wszyscy użytkownicy. |
getScriptProperties() | Properties | Pobiera z magazynu usługi dane, do których mają dostęp wszyscy użytkownicy, ale tylko w ramach tego skryptu. |
getUserProperties() | Properties | Pobiera magazyn właściwości, do którego dostęp ma tylko bieżący użytkownik i tylko w ramach tego skryptu. |
Szczegółowa dokumentacja
getDocumentProperties()
Pobiera z otwartego dokumentu, arkusza kalkulacyjnego lub formularza magazyn właściwości (tylko w przypadku tego skryptu), do którego mają dostęp wszyscy użytkownicy. Jest on dostępny tylko wtedy, gdy skrypt jest opublikowany i wykonuje się jako dodatek lub jest powiązany z typem pliku Google. Gdy właściwości dokumentu są niedostępne, ta metoda zwraca null
. Właściwości dokumentu utworzone przez skrypt są niedostępne poza tym skryptem, nawet przez inne skrypty, które mają dostęp do tego samego dokumentu.
Powrót
Properties
– przechowalnia właściwości tylko dla tego skryptu, do której mają dostęp wszyscy użytkownicy bieżącego dokumentu, lub null
, jeśli skrypt nie jest dodatkiem ani nie jest powiązany z plikiem Google Workspace;
getScriptProperties()
Pobiera z magazynu usługi dane, do których mają dostęp wszyscy użytkownicy, ale tylko w ramach tego skryptu.
Powrót
Properties
– repozytorium właściwości, do którego mają dostęp wszyscy użytkownicy skryptu.
getUserProperties()
Pobiera magazyn właściwości, do którego dostęp ma tylko bieżący użytkownik i tylko w ramach tego skryptu.
Powrót
Properties
– repozytorium właściwości, do którego dostęp ma tylko bieżący użytkownik skryptu.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-26 UTC.
[null,null,["Ostatnia aktualizacja: 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"]]