דף זה תורגם על ידי Cloud Translation API.

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`	אנטומציה של סוגי היישור של תמונות.
`DestinationType`	`DestinationType`	ספירה של סוגי היעדים שאפשר לאחסן בהם תשובות מהטפסים.
`FeedbackType`	`FeedbackType`	אנטומציה של סוגי הטפסים מסוג `Feedbacks`.
`ItemType`	`ItemType`	אנטומציה של סוגי הטפסים מסוג `Items`.
`PageNavigationType`	`PageNavigationType`	ספירה של התנהגויות אפשריות לניווט בדפים.
`RatingIconType`	`RatingIconType`	ספירה של סוגי סמלי הדירוג `RatingIcons`

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`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.
const form = FormApp.create('Form Name');

פרמטרים

שם	סוג	תיאור
`title`	`String`	שם הטופס החדש

חזרה

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`	כתובת ה-URL של הטופס שרוצים לפתוח

חזרה

Form – הטופס עם כתובת ה-URL שצוינה

זריקות

Error – אם כתובת ה-URL שצוינה לא חוקית או למשתמש אין מספיק הרשאות

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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