Class PropertiesService
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
PropertiesService
Komut dosyalarının basit verileri bir komut dosyasına, komut dosyasının bir kullanıcısına veya eklenti kullanılan bir dokümana özel anahtar/değer çiftlerinde depolamasına olanak tanır. Özellikler komut dosyaları arasında paylaşılamaz.
Her mülk türünün ne zaman kullanılacağı hakkında daha fazla bilgi için Özellikler hizmet kılavuzuna bakın.
// 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');
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
getDocumentProperties() | Properties | Açık doküman, e-tablo veya formda tüm kullanıcıların erişebileceği bir mülk mağazası (yalnızca bu komut dosyası için) alır. |
getScriptProperties() | Properties | Tüm kullanıcıların erişebileceği ancak yalnızca bu komut dosyası içinde erişebileceği bir mülk mağazası alır. |
getUserProperties() | Properties | Yalnızca mevcut kullanıcının erişebileceği ve yalnızca bu komut dosyası içinde kullanılabilen bir mülk mağazası alır. |
Ayrıntılı dokümanlar
getDocumentProperties()
Açık doküman, e-tablo veya formda tüm kullanıcıların erişebileceği bir mülk mağazası (yalnızca bu komut dosyası için) alır. Yalnızca komut dosyası yayınlanmış ve eklenti olarak yürütülüyorsa veya bir Google dosya türüne bağlıysa kullanılabilir. Doküman özellikleri mevcut olmadığında bu yöntem null
değerini döndürür. Bir komut dosyası tarafından oluşturulan doküman özelliklerine, aynı dokümana erişen diğer komut dosyaları tarafından bile bu komut dosyası dışından erişilemez.
Return
Properties
: Bu komut dosyası için yalnızca geçerli dokümanın tüm kullanıcılarının erişebileceği bir mülk mağazası veya komut dosyası bir eklenti değilse ya da bir Google Workspace dosyasına bağlı değilse null
getScriptProperties()
Tüm kullanıcıların erişebileceği ancak yalnızca bu komut dosyası içinde erişebileceği bir mülk mağazası alır.
Return
Properties
: Komut dosyasının tüm kullanıcılarının erişebileceği bir mülk mağazası
getUserProperties()
Yalnızca mevcut kullanıcının erişebileceği ve yalnızca bu komut dosyası içinde kullanılabilen bir mülk mağazası alır.
Return
Properties
: Yalnızca komut dosyasının mevcut kullanıcısının erişebileceği bir mülk mağazası
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-26 UTC.
[null,null,["Son güncelleme tarihi: 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"]]