Class Properties

خواص

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

مستندات دقیق

deleteAllProperties()

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

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

بازگشت

Properties - این فروشگاه Properties ، برای زنجیره‌سازی

deleteProperty(key)

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

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

پارامترها

نام نوع توضیحات
key String کلید حذف ویژگی

بازگشت

Properties - این فروشگاه Properties ، برای زنجیره‌سازی

getKeys()

تمام کلیدهای موجود در مخزن 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 فعلی

getProperties()

یک کپی از تمام جفت‌های کلید-مقدار موجود در مخزن 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 فعلی

getProperty(key)

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

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

پارامترها

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

بازگشت

String - مقداری که با کلید داده شده در مخزن Properties فعلی مرتبط است.

setProperties(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 ، برای زنجیره‌سازی

setProperties(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 ، برای زنجیره‌سازی

setProperty(key, value)

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

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

پارامترها

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

بازگشت

Properties - این فروشگاه Properties ، برای زنجیره‌سازی