Class ScriptProperties
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
ویژگی های اسکریپت منسوخ شده است. این کلاس منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
ویژگی های اسکریپت جفت های کلید-مقدار هستند که توسط یک اسکریپت در یک فروشگاه دائمی ذخیره می شوند. ویژگی‌های اسکریپت بر اساس اسکریپت مشخص می‌شوند، صرف نظر از اینکه کدام کاربر اسکریپت را اجرا می‌کند.
روش های منسوخ شده
delete All Properties()
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
تمام خواص را حذف می کند.
ScriptProperties.deleteAllProperties();
بازگشت
Script Properties
همچنین ببینید
delete Property(key)
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
ویژگی را با کلید داده شده حذف می کند.
ScriptProperties.deleteProperty('special');
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
key | String | کلید برای حذف ملک |
بازگشت
Script Properties
همچنین ببینید
get Keys()
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
تمام کلیدهای موجود را دریافت کنید.
بازگشت
String[]
get Properties()
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
همه املاک موجود را یکجا دریافت کنید.
این یک کپی می دهد، نه یک نمای زنده، بنابراین تغییر ویژگی ها در شیء برگشتی آنها را در ذخیره سازی به روز نمی کند و بالعکس.
ScriptProperties.setProperties({
"cow" : "moo",
"sheep" : "baa",
"chicken" : "cluck"
});
// Logs "A cow goes: moo"
Logger.log("A cow goes: %s", ScriptProperties.getProperty("cow"));
// This makes a copy. Any changes that happen here will not
// be written back to properties.
var animalSounds = ScriptProperties.getProperties();
// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for(var kind in animalSounds) {
Logger.log("A %s goes %s!", kind, animalSounds[kind]);
}
بازگشت
Object - یک کپی از ویژگی های حاوی جفت های کلید-مقدار
get Property(key)
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
مقدار مرتبط با کلید ارائه شده را برمی‌گرداند یا اگر چنین مقداری وجود نداشته باشد، null را برمی‌گرداند.
const specialValue = ScriptProperties.getProperty('special'); پارامترها
| نام | تایپ کنید | توضیحات |
|---|
key | String | کلید برای بازیابی مقدار |
بازگشت
String - مقدار مرتبط با کلید
همچنین ببینید
set Properties(properties)
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
properties | Object | یک شی حاوی خصوصیات برای تنظیم. |
بازگشت
Script Properties
همچنین ببینید
set Properties(properties, deleteAllOthers)
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.
// This deletes all other properties
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true); پارامترها
| نام | تایپ کنید | توضیحات |
|---|
properties | Object | یک شی حاوی خصوصیات برای تنظیم. |
delete All Others | Boolean | آیا برای حذف تمام ویژگی های موجود. |
بازگشت
Script Properties
همچنین ببینید
set Property(key, value)
منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.
مقدار مشخص شده را با کلید ارائه شده حفظ می کند. هر مقدار موجود مرتبط با این کلید بازنویسی خواهد شد.
ScriptProperties.setProperty('special', 'sauce');
پارامترها
| نام | تایپ کنید | توضیحات |
|---|
key | String | کلید ملک |
value | String | ارزش برای ارتباط با کلید |
بازگشت
Script Properties
همچنین ببینید
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eScriptProperties is deprecated and should not be used in new scripts, serving as a persistent key-value store scoped per script.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for setting, getting, and deleting properties, but these are all deprecated.\u003c/p\u003e\n"],["\u003cp\u003eDespite offering functionalities like bulk operations and property retrieval, developers should refrain from using them in new projects.\u003c/p\u003e\n"],["\u003cp\u003eThe class is primarily for legacy scripts and should be replaced with more modern alternatives for data persistence.\u003c/p\u003e\n"]]],[],null,["# Class ScriptProperties\n\nScriptProperties\n\n\n**Deprecated.** This class is deprecated and should not be used in new scripts.\n\nScript Properties are key-value pairs stored by a script in a persistent store. Script Properties\nare scoped per script, regardless of which user runs the script. \n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------------------------|-----------------------|----------------------------------------------------------------------------------------|\n| [deleteAllProperties()](#deleteAllProperties()) | [ScriptProperties](#) | Deletes all properties. |\n| [deleteProperty(key)](#deleteProperty(String)) | [ScriptProperties](#) | Deletes the property with the given key. |\n| [getKeys()](#getKeys()) | `String[]` | Get all of the available keys. |\n| [getProperties()](#getProperties()) | `Object` | Get all of the available properties at once. |\n| [getProperty(key)](#getProperty(String)) | `String` | Returns the value associated with the provided key, or null if there is no such value. |\n| [setProperties(properties)](#setProperties(Object)) | [ScriptProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperties(properties, deleteAllOthers)](#setProperties(Object,Boolean)) | [ScriptProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperty(key, value)](#setProperty(String,String)) | [ScriptProperties](#) | Persists the specified in value with the provided key. |\n\nDeprecated methods\n------------------\n\n### `delete``All``Properties()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes all properties.\n\n```javascript\nScriptProperties.deleteAllProperties();\n```\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [deleteProperty(key)](#deleteProperty(String))\n\n*** ** * ** ***\n\n### `delete``Property(key)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes the property with the given key.\n\n```javascript\nScriptProperties.deleteProperty('special');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|----------------------------|\n| `key` | `String` | key for property to delete |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [deleteAllProperties()](#deleteAllProperties())\n\n*** ** * ** ***\n\n### `get``Keys()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGet all of the available keys.\n\n#### Return\n\n\n`String[]`\n\n*** ** * ** ***\n\n### `get``Properties()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGet all of the available properties at once.\n\nThis gives a copy, not a live view, so changing the properties on the returned object won't\nupdate them in storage and vice versa.\n\n```javascript\nScriptProperties.setProperties({\n \"cow\" : \"moo\",\n \"sheep\" : \"baa\",\n \"chicken\" : \"cluck\"\n});\n\n// Logs \"A cow goes: moo\"\nLogger.log(\"A cow goes: %s\", ScriptProperties.getProperty(\"cow\"));\n\n// This makes a copy. Any changes that happen here will not\n// be written back to properties.\nvar animalSounds = ScriptProperties.getProperties();\n\n// Logs:\n// A chicken goes cluck!\n// A cow goes moo!\n// A sheep goes baa!\nfor(var kind in animalSounds) {\n Logger.log(\"A %s goes %s!\", kind, animalSounds[kind]);\n}\n```\n\n#### Return\n\n\n`Object` --- a copy of the properties containing key-value pairs\n\n*** ** * ** ***\n\n### `get``Property(key)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nReturns the value associated with the provided key, or null if there is no such value.\n\n```javascript\nconst specialValue = ScriptProperties.getProperty('special');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|-------------------------------|\n| `key` | `String` | key for the value to retrieve |\n\n#### Return\n\n\n`String` --- the value associated with the key\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Properties(properties)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nBulk-sets all the properties drawn from the given object.\n\n```javascript\nScriptProperties.setProperties({special: 'sauce', 'meaning': 42});\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|---------------------------------------------|\n| `properties` | `Object` | an object containing the properties to set. |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Properties(properties, deleteAllOthers)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nBulk-sets all the properties drawn from the given object.\n\n```javascript\n// This deletes all other properties\nScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------------|-----------|---------------------------------------------|\n| `properties` | `Object` | an object containing the properties to set. |\n| `delete``All``Others` | `Boolean` | whether to delete all existing properties. |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Property(key, value)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nPersists the specified in value with the provided key. Any existing value associated with this\nkey will be overwritten.\n\n```javascript\nScriptProperties.setProperty('special', 'sauce');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|---------------------------------|\n| `key` | `String` | key for property |\n| `value` | `String` | value to associate with the key |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [getProperty(key)](#getProperty(String))"]]
