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، للسلسلة