Class FormApp

FormApp

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

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

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

תכונות

נכסתיאורהתיאור
AlignmentAlignmentספירה של סוגים של יישור תמונה.
DestinationTypeDestinationTypeספירה של סוגי יעדים שבהם אפשר לשמור תשובות לטופס.
FeedbackTypeFeedbackTypeספירה של סוגי הטופס Feedbacks.
ItemTypeItemTypeספירה של סוגי הטופס Items.
PageNavigationTypePageNavigationTypeרשימת התנהגויות אפשריות לניווט בדפים.

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
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');

פרמטרים

שםתיאורהתיאור
titleStringשם הטופס החדש

החזרות

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

פרמטרים

שםתיאורהתיאור
idStringהמזהה של הטופס שצריך לפתוח

החזרות

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

פרמטרים

שםתיאורהתיאור
urlStringכתובת ה-URL של הטופס שצריך לפתוח

החזרות

Form - הטופס עם כתובת האתר הנתונה

קליעות

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

הרשאות

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

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