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 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 را با شناسه مشخص شده برمی گرداند.
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 Checkbox Grid Validation()

نمونه‌ای از CheckboxGridValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی در یک Checkbox Grid Item استفاده شود.

بازگشت

Checkbox Grid Validation Builder


create Checkbox Validation()

نمونه‌ای از CheckboxValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی در Checkbox Item استفاده شود.

بازگشت

Checkbox Validation Builder


create Feedback()

نمونه‌ای از QuizFeedbackBuilder را برمی‌گرداند که می‌توان از آن برای تنظیم بازخورد در مورد یک Item درجه‌بندی‌شده استفاده کرد.

بازگشت

Quiz Feedback Builder


create Grid Validation()

نمونه ای از GridValidationBuilder را برمی گرداند که می تواند برای تنظیم اعتبار سنجی روی یک Grid Item استفاده شود.

بازگشت

Grid Validation Builder


create Paragraph Text Validation()

نمونه‌ای از یک ParagraphTextValidationBuilder را برمی‌گرداند که می‌تواند برای تنظیم اعتبارسنجی روی یک Paragraph Text Item استفاده شود.

بازگشت

Paragraph Text Validation Builder


create Text Validation()

نمونه ای از TextValidationBuilder را برمی گرداند که می تواند برای تنظیم اعتبار سنجی روی یک Text Item استفاده شود.

بازگشت

Text Validation Builder


get Active Form()

فرمی را که اسکریپت به آن محدود شده است برمی‌گرداند. برای تعامل با فرم‌هایی که اسکریپت به آن‌ها محدود نمی‌شود، از open By Id(id) یا open By Url(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

get Ui()

نمونه‌ای از محیط رابط کاربری ویرایشگر فرم را برمی‌گرداند که به اسکریپت اجازه می‌دهد ویژگی‌هایی مانند منوها، دیالوگ‌ها و نوارهای جانبی را اضافه کند. یک اسکریپت فقط می تواند برای نمونه فعلی یک ویرایشگر فرم باز (نه دیدگاهی که پاسخ دهنده می بیند) با UI تعامل داشته باشد و فقط در صورتی که اسکریپت به فرم متصل باشد. برای اطلاعات بیشتر، به راهنمای منوها ، گفتگوها و نوارهای جانبی مراجعه کنید.

// 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 - نمونه ای از محیط رابط کاربری این فرم


open By Id(id)

Form را با شناسه مشخص شده برمی گرداند. در صورتی که شناسه نامعتبر باشد یا کاربر مجوز باز کردن فرم را نداشته باشد، یک استثنا ایجاد می کند.

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

پارامترها

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

بازگشت

Form - فرم با شناسه داده شده

پرتاب می کند

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

مجوز

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

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

open By Url(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