Class Properties

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
المواقع

يعمل كائن الخصائص كواجهة للوصول إلى خصائص المستخدم أو المستند أو النص البرمجي. ويعتمد نوع السمة المحدّد على الطرق الثلاث التي يتم استخدامها في النص البرمجي PropertiesService والمُسمى: PropertiesService.getDocumentProperties() أو PropertiesService.getUserProperties() أو PropertiesService.getScriptProperties(). لا يمكن مشاركة المواقع بين النصوص البرمجية. لمزيد من المعلومات عن أنواع المواقع، اطّلِع على دليل استخدام المواقع.

الطُرق

الطريقةنوع الإرجاعوصف قصير
deleteAllProperties()Propertiesحذف جميع المواقع في متجر Properties الحالي.
deleteProperty(key)Propertiesيتم حذف الموقع باستخدام المفتاح المحدد في متجر Properties الحالي.
getKeys()String[]الحصول على جميع المفاتيح في متجر Properties الحالي
getProperties()Objectالحصول على نسخة من جميع أزواج المفتاح/القيمة في متجر Properties الحالي.
getProperty(key)Stringتحصل على القيمة المرتبطة بالمفتاح المحدّد في متجر Properties الحالي، أو null في حال عدم توفّر هذا المفتاح.
setProperties(properties)Propertiesلضبط جميع أزواج المفتاح/القيمة من العنصر المحدَّد في متجر Properties الحالي.
setProperties(properties, deleteAllOthers)Propertiesلضبط جميع أزواج المفتاح/القيمة من العنصر المحدّد في متجر Properties الحالي، ويمكنك اختياريًا حذف جميع المواقع الأخرى في المتجر.
setProperty(key, value)Propertiesلضبط زوج المفتاح/القيمة المحدَّد في متجر Properties الحالي.

المستندات التفصيلية

deleteAllProperties()

حذف جميع المواقع في متجر Properties الحالي.

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

تذكرة ذهاب وعودة

Properties - هذا المتجر Properties، لسلسلة الكتب


deleteProperty(key)

يتم حذف الموقع باستخدام المفتاح المحدد في متجر Properties الحالي.

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

المعلّمات

الاسمالنوعالوصف
keyStringالمفتاح الذي سيحذفه الموقع

تذكرة ذهاب وعودة

Properties - هذا المتجر Properties، لسلسلة الكتب


getKeys()

الحصول على جميع المفاتيح في متجر Properties الحالي

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

تذكرة ذهاب وعودة

String[]: مصفوفة من جميع المفاتيح في متجر Properties الحالي


getProperties()

الحصول على نسخة من جميع أزواج المفتاح/القيمة في متجر Properties الحالي. يُرجى العِلم بأنّ العنصر المرتَجع ليس عرضًا مباشرًا للمتجر. وبالتالي، لن يؤدي تغيير السمات في العنصر المعروض إلى تعديلها تلقائيًا في مساحة التخزين أو العكس.

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

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 — نسخة من كل أزواج المفتاح/القيمة في متجر Properties الحالي


getProperty(key)

تحصل على القيمة المرتبطة بالمفتاح المحدّد في متجر Properties الحالي، أو null في حال عدم توفّر هذا المفتاح.

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

المعلّمات

الاسمالنوعالوصف
keyStringمفتاح قيمة الموقع لاسترداده

تذكرة ذهاب وعودة

String: القيمة المرتبطة بالمفتاح المحدّد في متجر Properties الحالي


setProperties(properties)

لضبط جميع أزواج المفتاح/القيمة من العنصر المحدَّد في متجر Properties الحالي.

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

المعلّمات

الاسمالنوعالوصف
propertiesObjectعنصر يحتوي على أزواج المفتاح/القيمة المطلوب تحديدها

تذكرة ذهاب وعودة

Properties - هذا المتجر Properties، لسلسلة الكتب


setProperties(properties, deleteAllOthers)

لضبط جميع أزواج المفتاح/القيمة من العنصر المحدّد في متجر Properties الحالي، ويمكنك اختياريًا حذف جميع المواقع الأخرى في المتجر.

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

المعلّمات

الاسمالنوعالوصف
propertiesObjectعنصر يحتوي على أزواج المفتاح/القيمة المطلوب تحديدها
deleteAllOthersBooleantrue لحذف جميع أزواج المفتاح/القيمة الأخرى في كائن المواقع، false أم لا

تذكرة ذهاب وعودة

Properties - هذا المتجر Properties، لسلسلة الكتب


setProperty(key, value)

لضبط زوج المفتاح/القيمة المحدَّد في متجر Properties الحالي.

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

المعلّمات

الاسمالنوعالوصف
keyStringالمفتاح للموقع
valueStringالقيمة المطلوب ربطها بالمفتاح

تذكرة ذهاب وعودة

Properties - هذا المتجر Properties، لسلسلة الكتب