Properties Service

خواص

این سرویس به اسکریپت‌ها اجازه می‌دهد رشته‌ها را به صورت جفت‌های کلید-مقدار ذخیره کنند که در محدوده یک اسکریپت، یک کاربر اسکریپت یا یک سند که در آن از افزونه ویرایشگر استفاده شده است، قرار دارند. برای اطلاعات بیشتر در مورد زمان استفاده از هر نوع ویژگی، به راهنمای سرویس Properties مراجعه کنید.

کلاس‌ها

نام شرح مختصر
Properties شیء properties به عنوان رابطی برای دسترسی به ویژگی‌های کاربر، سند یا اسکریپت عمل می‌کند.
Properties Service به اسکریپت‌ها اجازه می‌دهد داده‌های ساده را در جفت‌های کلید-مقدار ذخیره کنند که به یک اسکریپت، یک کاربر اسکریپت یا یک سند که در آن یک افزونه استفاده می‌شود، محدود می‌شوند.
Script Properties ویژگی‌های اسکریپت، جفت‌های کلید-مقدار هستند که توسط یک اسکریپت در یک حافظه دائمی ذخیره می‌شوند.
User Properties ویژگی‌های کاربر، جفت‌های کلید-مقدار منحصر به فرد برای یک کاربر هستند.

Properties

روش‌ها

روش نوع بازگشتی شرح مختصر
delete All Properties() Properties تمام ویژگی‌های موجود در مخزن Properties فعلی را حذف می‌کند.
delete Property(key) Properties ویژگی را با کلید داده شده در مخزن Properties فعلی حذف می‌کند.
get Keys() String[] تمام کلیدهای موجود در مخزن Properties فعلی را دریافت می‌کند.
get Properties() Object یک کپی از تمام جفت‌های کلید-مقدار موجود در مخزن Properties فعلی دریافت می‌کند.
get Property(key) String مقدار مرتبط با کلید داده شده را در مخزن Properties فعلی برمی‌گرداند، یا اگر چنین کلیدی وجود نداشته باشد null برمی‌گرداند.
set Properties(properties) Properties تمام جفت‌های کلید-مقدار را از شیء داده شده در فروشگاه Properties فعلی تنظیم می‌کند.
set Properties(properties, deleteAllOthers) Properties تمام جفت‌های کلید-مقدار را از شیء داده شده در فروشگاه Properties فعلی تنظیم می‌کند و به صورت اختیاری تمام ویژگی‌های دیگر موجود در فروشگاه را حذف می‌کند.
set Property(key, value) Properties جفت کلید-مقدار داده شده را در مخزن Properties فعلی تنظیم می‌کند.

PropertiesService

روش‌ها

روش نوع بازگشتی شرح مختصر
get Document Properties() Properties یک مخزن ویژگی (property store) دریافت می‌کند (فقط برای این اسکریپت) که همه کاربران می‌توانند در سند، صفحه گسترده یا فرم باز به آن دسترسی داشته باشند.
get Script Properties() Properties یک فروشگاه املاک دریافت می‌کند که همه کاربران می‌توانند به آن دسترسی داشته باشند، اما فقط درون این اسکریپت.
get User Properties() Properties یک مخزن ویژگی دریافت می‌کند که فقط کاربر فعلی یا مؤثر می‌تواند به آن دسترسی داشته باشد، و فقط درون این اسکریپت.

ScriptProperties

UserProperties