Class FormApp

فرم‌اپ

به یک اسکریپت اجازه می‌دهد تا یک Form موجود را باز کند یا یک فرم جدید ایجاد کند.

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

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

خواص

ملک نوع توضیحات
Alignment Alignment فهرستی از انواع ترازبندی تصویر.
Destination Type Destination Type فهرستی از انواع مقصدها که می‌توانند پاسخ‌های فرم را ذخیره کنند.
Feedback Type Feedback Type فهرستی از انواع Feedbacks فرم.
Item Type Item Type فهرستی از انواع Items فرم.
Page Navigation Type Page Navigation Type فهرستی از رفتارهای ممکن برای پیمایش صفحات.
Rating Icon Type Rating Icon Type فهرستی از انواع آیکون‌های Rating Icons

روش‌ها

روش نوع بازگشتی شرح مختصر
create(title) Form یک Form جدید ایجاد و برمی‌گرداند.
create(title, isPublished) Form یک Form جدید در حالت انتشار درخواستی ایجاد و برمی‌گرداند.
create Checkbox Grid Validation() Checkbox Grid Validation Builder نمونه‌ای از CheckboxGridValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی روی یک Checkbox Grid Item استفاده شود.
create Checkbox Validation() Checkbox Validation Builder یک نمونه از CheckboxValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی روی یک Checkbox Item استفاده شود.
create Feedback() Quiz Feedback Builder نمونه‌ای از QuizFeedbackBuilder را برمی‌گرداند که می‌تواند برای تنظیم بازخورد روی یک Item قابل نمره‌دهی استفاده شود.
create Grid Validation() Grid Validation Builder نمونه‌ای از GridValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی روی یک Grid Item استفاده شود.
create Paragraph Text Validation() Paragraph Text Validation Builder نمونه‌ای از ParagraphTextValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی روی یک Paragraph Text Item استفاده شود.
create Text Validation() Text Validation Builder نمونه‌ای از TextValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی روی یک Text Item استفاده شود.
get Active Form() Form فرمی را برمی‌گرداند که اسکریپت به آن متصل به کانتینر است.
get Ui() Ui نمونه‌ای از محیط رابط کاربری ویرایشگر فرم را برمی‌گرداند که به اسکریپت اجازه می‌دهد ویژگی‌هایی مانند منوها، کادرهای محاوره‌ای و نوارهای کناری را اضافه کند.
open By Id(id) Form Form را با شناسه (ID) مشخص شده برمی‌گرداند.
open By Url(url) Form Form را با URL مشخص شده برمی‌گرداند.

مستندات دقیق

create(title)

یک Form جدید ایجاد و برمی‌گرداند. اگر عنوان داده شده null یا خالی باشد، استثنا ایجاد می‌کند.

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

پارامترها

نام نوع توضیحات
title String نام فرم جدید.

بازگشت

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);

پارامترها

نام نوع توضیحات
title String نام فرم جدید.
is Published Boolean اینکه آیا فرم باید منتشر شود یا خیر.

بازگشت

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');

پارامترها

نام نوع توضیحات
id String شناسه فرمی که قرار است باز شود

بازگشت

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',
);

پارامترها

نام نوع توضیحات
url String آدرس اینترنتی فرمی که قرار است باز شود

بازگشت

Form - فرم با URL داده شده

پرتاب‌ها

Error - اگر URL داده شده نامعتبر باشد یا کاربر مجوزهای کافی نداشته باشد

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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