يعمل عنصر الخصائص كواجهة للوصول إلى خصائص المستخدم أو المستند أو النص البرمجي. يعتمد نوع السمة المحدّد على إحدى الطرق الثلاث التي استدعتها الدالة PropertiesService في النص البرمجي، وهي: PropertiesService.getDocumentProperties() أو PropertiesService.getUserProperties() أو PropertiesService.getScriptProperties().
لا يمكن مشاركة الخصائص بين النصوص البرمجية. لمزيد من المعلومات عن أنواع السمات، راجِع دليل خدمة السمات.
الطُرق
| الطريقة | نوع القيمة التي تم إرجاعها | وصف قصير |
|---|---|---|
delete | Properties | لحذف جميع أماكن الإقامة في متجر Properties الحالي |
delete | Properties | تحذف هذه الطريقة السمة التي لها المفتاح المحدّد في مخزن Properties الحالي. |
get | String[] | تعرض هذه السمة جميع المفاتيح في Properties المتجر الحالي. |
get | Object | تعرض هذه الطريقة نسخة من جميع أزواج المفتاح/القيمة في مخزن Properties الحالي. |
get | String | تعرض هذه الدالة القيمة المرتبطة بالمفتاح المحدّد في متجر Properties الحالي، أو null إذا لم يكن هذا المفتاح متوفّرًا. |
set | Properties | يضبط جميع أزواج المفتاح/القيمة من العنصر المحدّد في متجر Properties الحالي. |
set | Properties | تضبط هذه الطريقة جميع أزواج المفتاح/القيمة من العنصر المحدّد في مخزن Properties الحالي، مع إمكانية حذف جميع السمات الأخرى في المخزن. |
set | 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 | 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 هذا، لتسلسل العمليات