Class FormApp

FormApp

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

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

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

מאפיינים

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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
create(title)Formיוצרת ומחזירה Form חדש.
create(title, isPublished)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');

פרמטרים

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

חזרה

Form — יציבת הריצה החדשה.

מקפיצה את הודעות השגיאה (Throws)

Error – אם השם שצוין הוא null או ריק

אישור

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

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

create(title, isPublished)

יוצר ומחזיר Form חדש במצב הפרסום המבוקש. מופעלת חריגה אם הכותרת שצוינה היא null או ריקה.

// Create, publish and open a form.
const form = FormApp.create('Form Name', true);

פרמטרים

שםסוגתיאור
titleStringהשם של הטופס החדש.
isPublishedBooleanהאם הטופס צריך להתפרסם.

חזרה

Form — יציבת הריצה החדשה.

מקפיצה את הודעות השגיאה (Throws)

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

פרמטרים

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

חזרה

Form – הטופס עם המזהה שצוין

מקפיצה את הודעות השגיאה (Throws)

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

פרמטרים

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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