Class Properties

خواص

شی خواص به عنوان رابط برای دسترسی به ویژگی های کاربر، سند یا اسکریپت عمل می کند. نوع خاصیت خاص بستگی به این دارد که اسکریپت کدام یک از سه روش Properties Service را نامیده است: Properties Service.getDocumentProperties() , Properties Service.getUserProperties() یا Properties Service.getScriptProperties() . ویژگی ها را نمی توان بین اسکریپت ها به اشتراک گذاشت. برای اطلاعات بیشتر در مورد انواع املاک، به راهنمای سرویس 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 فعلی تنظیم می کند.

مستندات دقیق

delete All Properties()

تمام خصوصیات موجود در فروشگاه Properties فعلی را حذف می کند.

// Deletes all user properties.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

بازگشت

Properties - این فروشگاه Properties ، برای زنجیر کردن

delete Property(key)

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

// Deletes the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

پارامترها

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

بازگشت

Properties - این فروشگاه Properties ، برای زنجیر کردن

get Keys()

همه کلیدها را در فروشگاه Properties فعلی دریافت می کند.

// Sets several properties, then logs the value of each key.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});
const keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (let i = 0; i < keys.length; i++) {
  Logger.log(keys[i]);
}

بازگشت

String[] - آرایه ای از همه کلیدها در ذخیره Properties فعلی

get Properties()

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

// Sets several script properties, then retrieves them and logs them.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});

const animalSounds = scriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for (const kind in animalSounds) {
  Logger.log('A %s goes %s!', kind, animalSounds[kind]);
}

بازگشت

Object - یک کپی از تمام جفت‌های کلید-مقدار در ذخیره‌سازی فعلی Properties

get Property(key)

مقدار مربوط به کلید داده شده را در ذخیره سازی فعلی Properties دریافت می کند، یا اگر چنین کلیدی وجود نداشته باشد null .

// Gets the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
const nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

پارامترها

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

بازگشت

String - مقدار مرتبط با کلید داده شده در ذخیره Properties فعلی

set Properties(properties)

تمام جفت‌های کلید-مقدار را از شی داده شده در ذخیره‌سازی Properties فعلی تنظیم می‌کند.

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

پارامترها

نام تایپ کنید توضیحات
properties Object یک شی حاوی جفت کلید-مقدار برای تنظیم

بازگشت

Properties - این فروشگاه Properties ، برای زنجیر کردن

set Properties(properties, deleteAllOthers)

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

// Sets multiple user properties at once while deleting all other user
// properties.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties, true);

پارامترها

نام تایپ کنید توضیحات
properties Object یک شی حاوی جفت کلید-مقدار برای تنظیم
delete All Others Boolean true برای حذف تمام جفت های کلید-مقدار دیگر در شیء خواص؛ false به عدم

بازگشت

Properties - این فروشگاه Properties ، برای زنجیر کردن

set Property(key, value)

جفت کلید-مقدار داده شده را در فروشگاه Properties فعلی تنظیم می کند.

// Sets the user property 'nickname' to 'Bobby'.
const userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

پارامترها

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

بازگشت

Properties - این فروشگاه Properties ، برای زنجیر کردن