Class FormApp

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 يمكن استخدامه لضبط عملية التحقّق من صحة 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 يمكن استخدامه لضبط عملية التحقّق من صحة 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