Class ScriptProperties

ویژگی های اسکریپت

منسوخ شده است. این کلاس منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

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

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

روش های منسوخ شده

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تمام خواص را حذف می کند.

ScriptProperties.deleteAllProperties();

بازگشت

Script Properties - این شی، برای زنجیر کردن

همچنین ببینید


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

ویژگی را با کلید داده شده حذف می کند.

ScriptProperties.deleteProperty('special');

پارامترها

نام تایپ کنید توضیحات
key String کلید برای حذف ملک

بازگشت

Script Properties - این شی، برای زنجیر کردن

همچنین ببینید


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

تمام کلیدهای موجود را دریافت کنید.

بازگشت

String[]


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

همه املاک موجود را یکجا دریافت کنید.

این یک کپی می دهد، نه یک نمای زنده، بنابراین تغییر ویژگی ها در شیء برگشتی آنها را در ذخیره سازی به روز نمی کند و بالعکس.

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 - یک کپی از ویژگی های حاوی جفت های کلید-مقدار


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مقدار مرتبط با کلید ارائه شده را برمی‌گرداند یا اگر چنین مقداری وجود نداشته باشد، null را برمی‌گرداند.

const specialValue = ScriptProperties.getProperty('special');

پارامترها

نام تایپ کنید توضیحات
key String کلید برای بازیابی مقدار

بازگشت

String - مقدار مرتبط با کلید

همچنین ببینید


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.

ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});

پارامترها

نام تایپ کنید توضیحات
properties Object یک شی حاوی خصوصیات برای تنظیم.

بازگشت

Script Properties - این شی، برای زنجیر کردن

همچنین ببینید


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

انبوه تمام خصوصیات استخراج شده از شی داده شده را تنظیم می کند.

// This deletes all other properties
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);

پارامترها

نام تایپ کنید توضیحات
properties Object یک شی حاوی خصوصیات برای تنظیم.
delete All Others Boolean آیا برای حذف تمام ویژگی های موجود.

بازگشت

Script Properties - این شی، برای زنجیر کردن

همچنین ببینید


منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

مقدار مشخص شده را با کلید ارائه شده حفظ می کند. هر مقدار موجود مرتبط با این کلید بازنویسی خواهد شد.

ScriptProperties.setProperty('special', 'sauce');

پارامترها

نام تایپ کنید توضیحات
key String کلید ملک
value String ارزش برای ارتباط با کلید

بازگشت

Script Properties - این شی، برای زنجیر کردن

همچنین ببینید