Class PropertiesService
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
LayananProperti
Memungkinkan skrip menyimpan data sederhana dalam pasangan nilai kunci yang dicakup untuk satu skrip, satu pengguna skrip, atau satu dokumen tempat add-on digunakan. Properti tidak dapat dibagikan antar-skrip.
Untuk mengetahui informasi selengkapnya tentang kapan harus menggunakan setiap jenis properti, lihat panduan untuk layanan Properti.
// 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');
Metode
| Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
getDocumentProperties() | Properties | Mendapatkan penyimpanan properti (khusus skrip ini) yang dapat diakses oleh semua pengguna dalam dokumen, spreadsheet, atau formulir yang terbuka. |
getScriptProperties() | Properties | Mendapatkan penyimpanan properti yang dapat diakses oleh semua pengguna, tetapi hanya dalam skrip ini. |
getUserProperties() | Properties | Mendapatkan penyimpanan properti yang hanya dapat diakses oleh pengguna saat ini, dan hanya dalam skrip ini. |
Dokumentasi mendetail
getDocumentProperties()
Mendapatkan penyimpanan properti (khusus skrip ini) yang dapat diakses oleh semua pengguna dalam dokumen, spreadsheet, atau formulir yang terbuka. Fungsi ini hanya tersedia jika skrip dipublikasikan dan dijalankan sebagai add-on atau jika terikat dengan jenis file Google. Jika properti dokumen tidak tersedia, metode ini akan menampilkan null. Properti dokumen yang dibuat oleh skrip tidak dapat diakses di luar skrip tersebut, bahkan oleh skrip lain yang mengakses dokumen yang sama.
Pulang pergi
Properties — penyimpanan properti khusus untuk skrip ini yang dapat diakses oleh semua pengguna dokumen saat ini, atau null jika skrip bukan add-on atau terikat ke file Google Workspace
getScriptProperties()
Mendapatkan penyimpanan properti yang dapat diakses oleh semua pengguna, tetapi hanya dalam skrip ini.
Pulang pergi
Properties — penyimpanan properti yang dapat diakses oleh semua pengguna skrip
getUserProperties()
Mendapatkan penyimpanan properti yang hanya dapat diakses oleh pengguna saat ini, dan hanya dalam skrip ini.
Pulang pergi
Properties — penyimpanan properti yang hanya dapat diakses oleh pengguna skrip saat ini
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-26 UTC.
[null,null,["Terakhir diperbarui pada 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"]]
