Class FormApp

تطبيقالنموذج

السماح لنص برمجي بفتح Form حالي أو إنشاء Form جديد 

// Open a form by ID.
const existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Create and open a form.
const newForm = FormApp.create('Form Name');

الخصائص

الموقعالنوعالوصف
AlignmentAlignmentقائمة بأنواع محاذاة الصور
DestinationTypeDestinationTypeقائمة بأنواع الوجهات التي يمكنها تخزين الردود على النماذج
FeedbackTypeFeedbackTypeقائمة بأنواع النموذج Feedbacks
ItemTypeItemTypeقائمة بأنواع النموذج Items
PageNavigationTypePageNavigationTypeقائمة بالسلوكيات المحتمَلة للتنقّل في الصفحات
RatingIconTypeRatingIconTypeقائمة بأنواع رموز التقييم RatingIcons

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
create(title)Formلإنشاء Form جديدة وإرجاعها
create(title, isPublished)Formتُنشئ هذه الدالة Form جديدة وتُرجعها في حالة النشر المطلوبة.
createCheckboxGridValidation()CheckboxGridValidationBuilderتعرِض هذه السمة مثيلًا لـ CheckboxGridValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق في CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderتعرِض مثيلًا من CheckboxValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق من صحة ملف CheckboxItem.
createFeedback()QuizFeedbackBuilderتعرِض هذه الدالة مثيلًا لـ QuizFeedbackBuilder يمكن استخدامه لضبط الملاحظات حول Item قابل للتصنيف.
createGridValidation()GridValidationBuilderتعرِض هذه السمة مثيلًا لـ GridValidationBuilder يمكن استخدامه لضبط عملية التحقّق في GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderتعرِض مثيلًا من ParagraphTextValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق من a ParagraphTextItem.
createTextValidation()TextValidationBuilderتعرِض هذه الدالة مثيلًا لـ TextValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق من الصحة في TextItem.
getActiveForm()Formلعرض النموذج الذي يكون النص البرمجي مرتبطًا به.
getUi()Uiتعرِض مثيلًا لواجهة مستخدم محرِّر النماذج الذي يسمح للنص البرمجي بإضافة ميزات مثل القوائم ومربّعات الحوار والأشرطة الجانبية.
openById(id)Formلعرض Form بالمعرّف المحدّد.
openByUrl(url)Formتعرِض هذه السمة Form مع عنوان URL المحدّد.

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

create(title)

لإنشاء Form جديدة وإرجاعها يُعرِض استثناءً إذا كان العنوان المحدَّد null أو فارغًا. 

// Create and open a form.
const form = FormApp.create('Form Name');

المعلمات

الاسمالنوعالوصف
titleStringاسم النموذج الجديد.

الإرجاع

Form: النموذج الجديد

عمليات الرمي

Error - إذا كان العنوان المحدَّد هو null أو فارغًا

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/forms

create(title, isPublished)

تُنشئ هذه الدالة Form جديدة وتُرجعها في حالة النشر المطلوبة. يُعرِض استثناءً إذا كان العنوان المحدَّد هو null أو فارغًا. 

// Create, publish and open a form.
const form = FormApp.create('Form Name', true);

المعلمات

الاسمالنوعالوصف
titleStringاسم النموذج الجديد.
isPublishedBooleanما إذا كان يجب نشر النموذج

الإرجاع

Form: النموذج الجديد

عمليات الرمي

Error - إذا كان العنوان المحدَّد هو null أو فارغًا

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/forms

createCheckboxGridValidation()

تعرِض هذه السمة مثيلًا لـ CheckboxGridValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق في CheckboxGridItem.

الإرجاع

CheckboxGridValidationBuilder

createCheckboxValidation()

تعرِض مثيلًا من CheckboxValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق من صحة ملف CheckboxItem.

الإرجاع

CheckboxValidationBuilder

createFeedback()

تعرِض هذه الدالة مثيلًا لـ QuizFeedbackBuilder يمكن استخدامه لضبط الملاحظات حول Item قابل للتصنيف.

الإرجاع

QuizFeedbackBuilder

createGridValidation()

تعرِض هذه السمة مثيلًا لـ GridValidationBuilder يمكن استخدامه لضبط عملية التحقّق في GridItem.

الإرجاع

GridValidationBuilder

createParagraphTextValidation()

تعرِض مثيلًا من ParagraphTextValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق من a ParagraphTextItem.

الإرجاع

ParagraphTextValidationBuilder

createTextValidation()

تعرِض هذه الدالة مثيلًا لـ TextValidationBuilder الذي يمكن استخدامه لضبط عملية التحقّق من الصحة في TextItem.

الإرجاع

TextValidationBuilder

getActiveForm()

لعرض النموذج الذي يكون النص البرمجي مرتبطًا به. للتفاعل مع النماذج التي ليس فيها ربط بين الرمز البرمجي والحاوية، استخدِم openById(id) أو openByUrl(url) بدلاً من ذلك. 

// Get the form to which this script is bound.
const form = FormApp.getActiveForm();

الإرجاع

Form: النموذج المرتبط بالنصوص البرمجية، أو null إذا لم تكن النصوص البرمجية مرتبطة بأحد النماذج

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getUi()

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

// Add a custom menu to the active form, including a separator and a sub-menu.
function onOpen(e) {
  FormApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          FormApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

الإرجاع

Ui - مثيل لبيئة واجهة مستخدِم هذا النموذج

openById(id)

لعرض Form بالمعرّف المحدّد. يُعرِض استثناءً إذا كان المعرّف غير صالح أو إذا لم يكن لدى العميل إذن بفتح النموذج. 

// Open a form by ID.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

المعلمات

الاسمالنوعالوصف
idStringرقم تعريف النموذج المطلوب فتحه

الإرجاع

Form - النموذج الذي يحمل المعرّف المحدّد

عمليات الرمي

Error - إذا كان المعرّف المقدَّم غير صالح أو لم يكن لدى المستخدم أذونات كافية

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/forms

openByUrl(url)

تعرِض هذه السمة Form مع عنوان URL المحدّد. يُعرِض استثناءً إذا كان عنوان URL غير صالح أو لم يكن لدى المستخدم إذن بفتح النموذج. 

// Open a form by URL.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

المعلمات

الاسمالنوعالوصف
urlStringعنوان URL للنموذج المطلوب فتحه

الإرجاع

Form: النموذج الذي يتضمّن عنوان URL المحدّد

عمليات الرمي

Error - إذا كان عنوان URL المحدَّد غير صالح أو لم يكن لدى المستخدم أذونات كافية

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/forms