Class FormApp

FormApp

מאפשר לסקריפט לפתוח Form קיים או ליצור 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 – הטופס עם כתובת ה-URL הנתונה

קליעות

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

אישור

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

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