به یک اسکریپت اجازه می دهد یک Form
موجود را باز کند یا یک فرم جدید ایجاد کند.
// Open a form by ID. var existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Create and open a form. var newForm = FormApp.create('Form Name');
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
Alignment | Alignment | شمارشی از انواع هم ترازی تصویر. |
DestinationType | DestinationType | شمارشی از انواع مقصدهایی که می توانند پاسخ های فرم را ذخیره کنند. |
FeedbackType | FeedbackType | شمارشی از انواع فرم Feedbacks . |
ItemType | ItemType | شمارشی از انواع Items فرم . |
PageNavigationType | PageNavigationType | شمارشی از رفتارهای ممکن برای پیمایش صفحات. |
مواد و روش ها
روش | نوع برگشت | توضیح مختصر |
---|---|---|
create(title) | 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. var form = FormApp.create('Form Name');
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
title | String | نام فرم جدید |
برگشت
Form
- فرم جدید
پرتاب می کند
Error
- اگر عنوان داده شده null
یا خالی باشد
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/forms
createCheckboxGridValidation()
نمونهای از CheckboxGridValidationBuilder را برمیگرداند که میتواند برای تنظیم اعتبارسنجی در CheckboxGridItem
استفاده شود.
برگشت
createCheckboxValidation()
نمونهای از CheckboxValidationBuilder را برمیگرداند که میتواند برای تنظیم اعتبارسنجی در یک CheckboxItem
استفاده شود.
برگشت
createFeedback()
نمونهای از QuizFeedbackBuilder را برمیگرداند که میتوان از آن برای تنظیم بازخورد در مورد یک Item
درجهبندیشده استفاده کرد.
برگشت
createGridValidation()
نمونه ای از GridValidationBuilder را برمی گرداند که می تواند برای تنظیم اعتبار در یک GridItem
استفاده شود.
برگشت
createParagraphTextValidation()
نمونهای از یک ParagraphTextValidationBuilder را برمیگرداند که میتواند برای تنظیم اعتبار در یک ParagraphTextItem
استفاده شود.
برگشت
createTextValidation()
نمونه ای از TextValidationBuilder را برمی گرداند که می تواند برای تنظیم اعتبارسنجی روی TextItem
استفاده شود.
برگشت
getActiveForm()
فرمی را که اسکریپت به آن محدود شده است برمیگرداند. برای تعامل با فرم هایی که اسکریپت به آنها محدود نمی شود، به جای آن از openById(id)
یا openByUrl(url)
استفاده کنید.
// Get the form to which this script is bound. var form = FormApp.getActiveForm();
برگشت
Form
- فرمی که اسکریپت به آن صحافی شده است، یا اگر اسکریپت به یک فرم محدود نشده باشد null
.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getUi()
نمونهای از محیط رابط کاربری ویرایشگر فرم را برمیگرداند که به اسکریپت اجازه میدهد ویژگیهایی مانند منوها، دیالوگها و نوارهای جانبی را اضافه کند. یک اسکریپت فقط می تواند برای نمونه فعلی یک ویرایشگر فرم باز (نه دیدگاهی که پاسخ دهنده می بیند) با 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
- نمونه ای از محیط رابط کاربری این فرم
openById(id)
Form
با شناسه مشخص شده برمی گرداند. در صورتی که شناسه نامعتبر باشد یا کاربر مجوز باز کردن فرم را نداشته باشد، یک استثنا ایجاد می کند.
// Open a form by ID. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
id | String | شناسه فرم برای باز کردن |
برگشت
Form
- فرم با شناسه داده شده
پرتاب می کند
Error
- اگر شناسه داده شده نامعتبر باشد یا کاربر مجوزهای کافی نداشته باشد
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/forms
openByUrl(url)
Form
با URL مشخص شده برمی گرداند. در صورتی که URL نامعتبر باشد یا کاربر مجوز باز کردن فرم را نداشته باشد، یک استثنا ایجاد می کند.
// Open a form by URL. var form = FormApp.openByUrl( 'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit' );
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
url | String | آدرس فرم برای باز کردن |
برگشت
Form
- فرم با URL داده شده
پرتاب می کند
Error
- اگر URL داده شده نامعتبر باشد یا کاربر مجوزهای کافی نداشته باشد
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/forms