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

Class FormApp

סקריפט יכול לפתוח Form קיים או ליצור סקריפט חדש.

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

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

נכסים

מאפיין (property)	סוג	תיאור
`Alignment`	`Alignment`	ספירה של סוגים של יישור תמונות.
`DestinationType`	`DestinationType`	רשימה של סוגי יעדים שיכולים לאחסן תגובות בטפסים.
`FeedbackType`	`FeedbackType`	מספר סוגי הטפסים `Feedbacks`.
`ItemType`	`ItemType`	מספר סוגי הטפסים `Items`.
`PageNavigationType`	`PageNavigationType`	מספר של התנהגויות אפשריות לניווט בדפים.

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
`create(title)`	`Form`	יצירה והחזרה של `Form` חדש.
`createCheckboxGridValidation()`	`CheckboxGridValidationBuilder`	מחזירה מופע של CheckboxGridVerificationBuilder שיכול לשמש להגדרת אימות ב-`CheckboxGridItem`.
`createCheckboxValidation()`	`CheckboxValidationBuilder`	מחזירה מופע של CheckboxVerificationBuilder שיכול לשמש להגדרת אימות ב-`CheckboxItem`.
`createFeedback()`	`QuizFeedbackBuilder`	מחזירה מופע של QuizTakeBuilder שיכול לשמש להגדרת משוב בציון ניתן לבדיקה.`Item`.
`createGridValidation()`	`GridValidationBuilder`	מחזירה מופע של GridVerificationBuilder שיכול לשמש להגדרת אימות ב-`GridItem`.
`createParagraphTextValidation()`	`ParagraphTextValidationBuilder`	מחזירה מופע של ParagraphTextVerificationBuilder שניתן להשתמש בו כדי להגדיר אימות ב-`ParagraphTextItem`.
`createTextValidation()`	`TextValidationBuilder`	מחזירה מופע של TextAuthenticationBuilder שיכול לשמש להגדרת אימות ב-`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()`

מחזירה מופע של CheckboxGridVerificationBuilder שיכול לשמש להגדרת אימות ב-CheckboxGridItem.

הלוך ושוב

CheckboxGridValidationBuilder

`createCheckboxValidation()`

מחזירה מופע של CheckboxVerificationBuilder שיכול לשמש להגדרת אימות ב-CheckboxItem.

הלוך ושוב

CheckboxValidationBuilder

`createFeedback()`

מחזירה מופע של QuizTakeBuilder שיכול לשמש להגדרת משוב בציון ניתן לבדיקה.Item.

הלוך ושוב

QuizFeedbackBuilder

`createGridValidation()`

מחזירה מופע של GridVerificationBuilder שיכול לשמש להגדרת אימות ב-GridItem.

הלוך ושוב

GridValidationBuilder

`createParagraphTextValidation()`

מחזירה מופע של ParagraphTextVerificationBuilder שניתן להשתמש בו כדי להגדיר אימות ב-ParagraphTextItem.

הלוך ושוב

ParagraphTextValidationBuilder

`createTextValidation()`

מחזירה מופע של TextAuthenticationBuilder שיכול לשמש להגדרת אימות ב-TextItem.

הלוך ושוב

TextValidationBuilder

`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()`

מחזירה מופע של סביבת ממשק המשתמש של עורך הטפסים, שמאפשרת לסקריפט להוסיף תכונות כמו תפריטים, תיבות דו-שיח וסרגלי צד. סקריפט יכול לבצע אינטראקציה עם ממשק המשתמש רק עבור המופע הנוכחי של עורך טפסים פתוח (לא עבור התצוגה המפורטת שמגיב רואה), ורק אם הסקריפט משויך לטופס. למידע נוסף, מומלץ לעיין במדריכים בנושא תפריטים ודיאלוגים וסרגלי צד.

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

הלוך ושוב

Form — הטופס עם כתובת ה-URL הנתונה

זריקות

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

הרשאה

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

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