Class Form

טופס

טופס שמכיל נכסים ופריטים כלליים. המאפיינים כוללים את השם, ההגדרות ואת המיקום שבו התשובות מאוחסנות. פריטים כוללים פריטים של שאלות, כמו תיבות סימון או לחצני בחירה, ואילו פריטים של פריסה מתייחסים לדברים כמו הפסקות דף. אפשר לגשת לטפסים או ליצור אותם דרך FormApp.

// Open a form by ID and create a new spreadsheet.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const ss = SpreadsheetApp.create('Spreadsheet Name');

// Update form properties via chaining.
form.setTitle('Form Name')
    .setDescription('Description of form')
    .setConfirmationMessage('Thanks for responding!')
    .setAllowResponseEdits(true)
    .setAcceptingResponses(false);

// Update the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

Methods

שיטהסוג הערך המוחזרתיאור קצר
addCheckboxGridItem()CheckboxGridItemהוספת פריט שאלה חדש, שמוצג כמרשת של עמודות ושורות, ומאפשר למשתמש לבחור מספר אפשרויות בכל שורה מתוך רצף של תיבות סימון.
addCheckboxItem()CheckboxItemהוספת פריט שאלה חדש שמאפשר למשתמש לבחור תיבת סימון אחת או יותר, וגם שדה 'אחר' אופציונלי.
addDateItem()DateItemהוספת פריט שאלה חדש שמאפשר למשתמש לציין תאריך.
addDateTimeItem()DateTimeItemהוספת פריט שאלה חדש שמאפשר לנשאל לציין תאריך ושעה.
addDurationItem()DurationItemהוספת פריט שאלה חדש שמאפשר למשתמש לציין משך זמן.
addEditor(emailAddress)Formהוספת המשתמש הנתון לרשימת העורכים של Form.
addEditor(user)Formהוספת המשתמש הנתון לרשימת העורכים של Form.
addEditors(emailAddresses)Formהוספת מערך המשתמשים הנתון לרשימת העורכים של Form.
addGridItem()GridItemהוספת פריט שאלה חדש, שמוצג כמרקע של עמודות ושורות, ומאפשר למשתמש לבחור אפשרות אחת לכל שורה מתוך רצף של לחצני בחירה.
addImageItem()ImageItemהוספת פריט פריסה חדש שמוצגת בו תמונה.
addListItem()ListItemהוספת פריט שאלה חדש שמאפשר למשתמש לבחור אפשרות אחת מתוך רשימה נפתחת.
addMultipleChoiceItem()MultipleChoiceItemהוספת פריט שאלה חדש שמאפשר למשתמש לבחור אפשרות אחת מתוך רשימת לחצני רדיו או שדה 'אחר' אופציונלי.
addPageBreakItem()PageBreakItemהוספה של פריט פריסה חדש שמסמן את תחילת הדף.
addParagraphTextItem()ParagraphTextItemהוספת פריט שאלה חדש שמאפשר למשתמש להזין קטע טקסט.
addScaleItem()ScaleItemהוספת פריט שאלה חדש שמאפשר למשתמש לבחור אפשרות אחת מתוך רצף ממוספר של לחצני בחירה.
addSectionHeaderItem()SectionHeaderItemהוספת פריט פריסה חדש שמציין באופן חזותי את תחילת הקטע.
addTextItem()TextItemהוספת פריט שאלה חדש שמאפשר לנשאל להזין שורה אחת של טקסט.
addTimeItem()TimeItemהוספת פריט שאלה חדש שמאפשר למשתמש לציין שעה ביום.
addVideoItem()VideoItemהוספת פריט פריסה חדש שבו מוצג סרטון.
canEditResponse()Booleanקובע אם יוצג בטופס קישור לעריכת תגובה אחרי שליחתה.
collectsEmail()Booleanקובע אם הטופס אוסף את כתובות האימייל של המשיבים.
createResponse()FormResponseיצירת תשובה חדשה לטופס.
deleteAllResponses()Formהמחיקה של כל התשובות שנשלחו מאחסון התשובות של הטופס.
deleteItem(index)voidמחיקה של הפריט במדד נתון מבין כל הפריטים בטופס.
deleteItem(item)voidמחיקה של הפריט הנתון.
deleteResponse(responseId)Formמחיקה של תשובה אחת מאחסון התגובות של הטופס.
getConfirmationMessage()Stringהפונקציה מקבלת את הודעת האישור של הטופס.
getCustomClosedFormMessage()Stringהפונקציה מקבלת את ההודעה בהתאמה אישית שמוצגת אם הטופס לא מקבל תגובות, או מחרוזת ריקה אם לא הוגדרה הודעה בהתאמה אישית.
getDescription()Stringהפונקציה מקבלת את תיאור הטופס.
getDestinationId()Stringהפונקציה מקבלת את המזהה של יעד התשובות של הטופס.
getDestinationType()DestinationTypeהפונקציה מקבלת את הסוג של היעד לתשובות של הטופס.
getEditUrl()Stringהפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי לגשת למצב העריכה של הטופס.
getEditors()User[]הפונקציה מקבלת את רשימת העורכים של Form הזה.
getId()Stringהפונקציה מקבלת את המזהה של הטופס.
getItemById(id)Itemאחזור הפריט עם המזהה הנתון.
getItems()Item[]הפונקציה מקבלת מערך של כל הפריטים בטופס.
getItems(itemType)Item[]הפונקציה מקבלת מערך של כל הפריטים מסוג נתון.
getPublishedUrl()Stringהפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי להשיב לטופס.
getResponse(responseId)FormResponseהפונקציה מקבלת תשובה אחת לטופס על סמך מזהה התשובה שלה.
getResponses()FormResponse[]הפונקציה מקבלת מערך של כל התגובות לטופס.
getResponses(timestamp)FormResponse[]הפונקציה מקבלת מערך של כל התגובות לטופס אחרי תאריך ושעה נתונים.
getShuffleQuestions()Booleanקובעת אם הסדר של השאלות בכל דף בטופס יהיה אקראי.
getSummaryUrl()Stringהפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי להציג סיכום של התשובות לטופס.
getTitle()Stringהפונקציה מקבלת את כותרת הטופס.
hasLimitOneResponsePerUser()Booleanקובע אם הטופס יאפשר שליחת תשובה אחת בלבד לכל משתתף.
hasProgressBar()Booleanקובע אם יוצג סרגל התקדמות בטופס.
hasRespondAgainLink()Booleanההגדרה קובעת אם יוצג בטופס קישור לשליחת תגובה נוספת אחרי שהמשיב ימלא את הטופס.
isAcceptingResponses()Booleanהפונקציה קובעת אם הטופס מקבל כרגע תשובות.
isPublishingSummary()Booleanקובע אם יוצג בטופס קישור להצגת סיכום של התשובות אחרי שהמשיב ימלא את הטופס.
isQuiz()Booleanקובע אם הטופס הוא בוחן.
moveItem(from, to)Itemהעברת פריט במיקום נתון מבין כל הפריטים בטופס למיקום נתון אחר.
moveItem(item, toIndex)Itemהעברת פריט נתון למיקום נתון בתוך כל הפריטים בטופס.
removeDestination()Formביטול הקישור של הטופס ליעד הנוכחי לתשובות.
removeEditor(emailAddress)Formהסרת המשתמש הנתון מרשימת העורכים של Form.
removeEditor(user)Formהסרת המשתמש הנתון מרשימת העורכים של Form.
setAcceptingResponses(enabled)Formמגדיר אם הטופס מקבל כרגע תשובות.
setAllowResponseEdits(enabled)Formההגדרה קובעת אם יוצג בטופס קישור לעריכת תשובה אחרי שליחתה.
setCollectEmail(collect)Formמגדיר אם הטופס אוסף כתובות אימייל של המשיבים.
setConfirmationMessage(message)Formהגדרת הודעת האישור של הטופס.
setCustomClosedFormMessage(message)Formהגדרת ההודעה שתוצג אם לא ניתן לשלוח תשובות לטופס.
setDescription(description)Formהגדרת התיאור של הטופס.
setDestination(type, id)Formהגדרת היעד שבו נשמרות התשובות לטופס.
setIsQuiz(enabled)Formקובע אם הטופס הוא בוחן.
setLimitOneResponsePerUser(enabled)Formמגדיר אם הטופס יאפשר לשלוח רק תשובה אחת לכל משתתף.
setProgressBar(enabled)Formקובע אם סרגל ההתקדמות יופיע בטופס.
setPublishingSummary(enabled)Formההגדרה קובעת אם יוצג בטופס קישור לצפייה בסיכום התשובות אחרי שהמשיב ישלח את הטופס.
setShowLinkToRespondAgain(enabled)Formההגדרה קובעת אם יוצג בטופס קישור לשליחת תגובה נוספת אחרי שהמשיב ימלא את הטופס.
setShuffleQuestions(shuffle)Formההגדרה קובעת אם הסדר של השאלות בכל דף בטופס יהיה אקראי.
setTitle(title)Formהגדרת שם הטופס.
shortenFormUrl(url)Stringהמרת כתובת URL ארוכה של טופס לכתובת URL קצרה.
submitGrades(responses)Formשליחת ציונים עבור התשובות לטופס.

מסמכים מפורטים

addCheckboxGridItem()

הוספת פריט שאלה חדש, שמוצג כמרשת של עמודות ושורות, ומאפשר למשתמש לבחור מספר אפשרויות בכל שורה מתוך רצף של תיבות סימון.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a checkbox grid item.
const item = form.addCheckboxGridItem();

item.setTitle('Where did you celebrate New Year\'s?');

// Sets the grid's rows and columns.
item.setRows(['New York', 'San Francisco', 'London']).setColumns([
  '2014', '2015', '2016', '2017'
]);

חזרה

CheckboxGridItem – הפריט החדש שנוצר.

אישור

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

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

addCheckboxItem()

הוספת פריט שאלה חדש שמאפשר למשתמש לבחור תיבת סימון אחת או יותר, וגם שדה 'אחר' אופציונלי.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a checkbox item.
const item = form.addCheckboxItem();

// Sets the title of the checkbox item to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the choices.
item.setChoiceValues(['Cats', 'Dogs']);

חזרה

CheckboxItem – הפריט החדש שנוצר.

אישור

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

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

addDateItem()

הוספת פריט שאלה חדש שמאפשר למשתמש לציין תאריך.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a date item.
const item = form.addDateItem();

// Sets the title to 'When were you born?'
item.setTitle('When were you born?');

// Sets the description for the date item.
item.setHelpText('Some helper text.');

חזרה

DateItem – הפריט החדש שנוצר.

אישור

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

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

addDateTimeItem()

הוספת פריט שאלה חדש שמאפשר לנשאל לציין תאריך ושעה.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a question with date and time inputs.
const item = form.addDateTimeItem();

// Sets the title to 'When were you born?'
item.setTitle('When were you born?');

// Sets the question as required.
item.setRequired(true);

חזרה

DateTimeItem – הפריט החדש שנוצר.

אישור

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

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

addDurationItem()

הוספת פריט שאלה חדש שמאפשר למשתמש לציין משך זמן.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a question with a duration input.
const item = form.addDurationItem();

// Sets the title to 'How long can you hold your breath?'
item.setTitle('How long can you hold your breath?');

// Sets the question as required.
item.setRequired(true);

חזרה

DurationItem – הפריט החדש שנוצר.

אישור

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

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

addEditor(emailAddress)

הוספת המשתמש הנתון לרשימת העורכים של Form. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש שרוצים להוסיף.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

addEditor(user)

הוספת המשתמש הנתון לרשימת העורכים של Form. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שרוצים להוסיף.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

addEditors(emailAddresses)

הוספת מערך המשתמשים הנתון לרשימת העורכים של Form. אם אחד מהמשתמשים כבר נכלל ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

שםסוגתיאור
emailAddressesString[]מערך של כתובות האימייל של המשתמשים שרוצים להוסיף.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

addGridItem()

הוספת פריט שאלה חדש, שמוצג כמרקע של עמודות ושורות, ומאפשר למשתמש לבחור אפשרות אחת לכל שורה מתוך רצף של לחצני בחירה.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a multiple choice grid.
const item = form.addGridItem();

// Sets the title to 'Rate your interests.'
item.setTitle('Rate your interests');

// Sets the grid's rows and columns.
item.setRows(['Cars', 'Computers', 'Celebrities']).setColumns([
  'Boring', 'So-so', 'Interesting'
]);

חזרה

GridItem – הפריט החדש שנוצר.

אישור

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

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

addImageItem()

הוספת פריט פריסה חדש שמוצגת בו תמונה.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds an image item.
const item = form.addImageItem();

// Gets the Google icon to use as the image.
const img = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/googleg/v6/web-24dp/logo_googleg_color_1x_web_24dp.png',
);

// Sets the image, title, and description for the item.
item.setTitle('Google icon').setHelpText('Google icon').setImage(img);

חזרה

ImageItem – הפריט החדש שנוצר.

אישור

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

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

addListItem()

הוספת פריט שאלה חדש שמאפשר למשתמש לבחור אפשרות אחת מתוך רשימה נפתחת.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a dropdown list to the form.
const item = form.addListItem();

// Sets the title to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the description to 'This is description text...'
item.setHelpText('This is description text...');

// Creates and adds choices to the dropdown list.
item.setChoices([item.createChoice('dog'), item.createChoice('cat')]);

חזרה

ListItem – הפריט החדש שנוצר.

אישור

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

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

addMultipleChoiceItem()

הוספת פריט שאלה חדש שמאפשר למשתמש לבחור אפשרות אחת מתוך רשימת לחצני רדיו או שדה 'אחר' אופציונלי.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a multiple choice item to the form.
const item = form.addMultipleChoiceItem();

// Sets the title.
item.setTitle('What is your favorite ice cream flavor?');

// Creates some choice items.
const vanilla = item.createChoice('vanilla');
const chocolate = item.createChoice('chocolate');
const strawberry = item.createChoice('strawberry');

// Sets the choices.
item.setChoices([vanilla, chocolate, strawberry]);

חזרה

MultipleChoiceItem – הפריט החדש שנוצר.

אישור

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

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

addPageBreakItem()

הוספה של פריט פריסה חדש שמסמן את תחילת הדף.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds page break items to create a second and third page for the form.
const pageTwo = form.addPageBreakItem();
const pageThree = form.addPageBreakItem();

// Sets the titles for the pages.
pageTwo.setTitle('Page two');
pageThree.setTitle('Page three');

// Upon completion of the first page, sets the form to navigate to the third
// page.
pageTwo.setGoToPage(pageThree);

// Upon completion of the second page, sets the form to navigate back to the
// first page.
pageThree.setGoToPage(FormApp.PageNavigationType.RESTART);

חזרה

PageBreakItem – הפריט החדש שנוצר.

אישור

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

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

addParagraphTextItem()

הוספת פריט שאלה חדש שמאפשר למשתמש להזין קטע טקסט.

// Opens the form by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds the paragraph text item.
const item = form.addParagraphTextItem();

// Sets the title to 'What is your address?'
item.setTitle('What is your address?');

חזרה

ParagraphTextItem – הפריט החדש שנוצר.

אישור

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

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

addScaleItem()

הוספת פריט שאלה חדש שמאפשר למשתמש לבחור אפשרות אחת מתוך רצף ממוספר של לחצני בחירה.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds the scale item.
const item = form.addScaleItem();

// Sets the title of the scale item to 'Choose a number.'
item.setTitle('Choose a number');

// Sets the scale to 1-5.
item.setBounds(1, 5);

// Sets the label for the lower and upper bounds.
item.setLabels('Lowest', 'Highest');

חזרה

ScaleItem – הפריט החדש שנוצר.

אישור

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

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

addSectionHeaderItem()

הוספת פריט פריסה חדש שמציין באופן חזותי את תחילת הקטע.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds the section heading item.
const item = form.addSectionHeaderItem();

// Sets the title to 'Title of new section.'
item.setTitle('Title of new section');

// Sets the description.
item.setHelpText('Description of new section');

חזרה

SectionHeaderItem – הפריט החדש שנוצר.

אישור

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

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

addTextItem()

הוספת פריט שאלה חדש שמאפשר לנשאל להזין שורה אחת של טקסט.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a single-line text item.
const item = form.addTextItem();

// Sets the title to 'What is your name?'
item.setTitle('What is your name?');

חזרה

TextItem – הפריט החדש שנוצר.

אישור

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

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

addTimeItem()

הוספת פריט שאלה חדש שמאפשר למשתמש לציין שעה ביום.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a question with a time input.
const item = form.addTimeItem();

// Sets the title to 'What time do you usually wake up in the morning?'
item.setTitle('What time do you usually wake up in the morning?');

חזרה

TimeItem – הפריט החדש שנוצר.

אישור

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

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

addVideoItem()

הוספת פריט פריסה חדש שבו מוצג סרטון.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Adds a video item.
const item = form.addVideoItem();

// Sets the title, description, and video.
item.setTitle('YouTube video')
    .setHelpText('Send content automatically via Google Sheets and Apps Script')
    .setVideoUrl('https://youtu.be/xxgQr-jSu9o');

// Sets the alignment to the center.
item.setAlignment(FormApp.Alignment.CENTER);

חזרה

VideoItem – הפריט החדש שנוצר.

אישור

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

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

canEditResponse()

קובע אם יוצג בטופס קישור לעריכת תגובה אחרי שליחתה.

ללא קשר להגדרה הזו, השיטה FormResponse.getEditResponseUrl() מאפשרת למחבר סקריפט שיש לו גישת עריכה לטופס ליצור כתובת URL שאפשר להשתמש בה כדי לערוך תשובה.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Checks if the form displays a link to edit a response after submitting it.
// The default is false. To let people edit their responses, use
// form.setAllowResponseEdits(true).
const edit = form.canEditResponse();

// If the form doesn't let people edit responses, logs false to the console.
console.log(edit);

חזרה

Booleantrue אם בטופס מופיע הקישור 'עריכת התשובה', false אם לא.

אישור

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

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

collectsEmail()

קובע אם הטופס אוסף את כתובות האימייל של המשיבים.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form to not collect respondents' email addresses.
form.setCollectEmail(false);

// Checks whether the form collects respondents' email addresses and logs it to
// the console.
const bool = form.collectsEmail();

console.log(bool);

חזרה

Booleantrue אם הטופס אוסף כתובות אימייל, false אם לא.

אישור

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

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

createResponse()

יצירת תשובה חדשה לטופס. כדי להשיב לפריט שאלה, יוצרים ItemResponse מהפריט ומצרפים אותו לתשובה בטופס באמצעות קריאה ל-FormResponse.withItemResponse(response). כדי לשמור את התשובה המורכבת, קוראים לפונקציה FormResponse.submit().

חזרה

FormResponse – התשובה החדשה שנוצרה בטופס.

אישור

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

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

deleteAllResponses()

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

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

deleteItem(index)

מחיקה של הפריט במדד נתון מבין כל הפריטים בטופס. אם אין פריט באינדקס הנתון, הפונקציה גורמת להשלכת חריגה בזמן הרצת הסקריפט.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets all the items from the form.
const items = form.getItems();

// Finds the index of a paragraph text item and deletes it by the item's index.
const index = items.findIndex(
    (item) => item.getType() === FormApp.ItemType.PARAGRAPH_TEXT,
);
if (index !== -1) {
  form.deleteItem(index);
}

פרמטרים

שםסוגתיאור
indexIntegerהמדד של הפריט מבין כל הפריטים בטופס.

זריקות

Error – אם אין פריט באינדקס הנתון

אישור

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

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

deleteItem(item)

מחיקה של הפריט הנתון. אם הפריט כבר נמחק, מתבצעת הטלת חריגה בזמן הרצת הסקריפט.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets all of the items from the form.
const items = form.getItems();

// Finds a paragraph text item and deletes it.
const item = items.find(
    (item) => item.getType() === FormApp.ItemType.PARAGRAPH_TEXT,
);
if (item) {
  form.deleteItem(item);
}

פרמטרים

שםסוגתיאור
itemItemהפריט שרוצים למחוק.

זריקות

Error – אם הפריט לא קיים בטופס

אישור

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

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

deleteResponse(responseId)

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

פרמטרים

שםסוגתיאור
responseIdStringהמזהה של התגובה לטופס שרוצים למחוק.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

getConfirmationMessage()

הפונקציה מקבלת את הודעת האישור של הטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the confirmation message to display after someone submits the form.
form.setConfirmationMessage('You successfully submitted the form.');

// Gets the confirmation message and logs it to the console.
const message = form.getConfirmationMessage();

console.log(message);

חזרה

String – הודעת האישור של הטופס.

אישור

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

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

getCustomClosedFormMessage()

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

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets a custom closed form message to display to the user when the form
// no longer accepts responses.
form.setCustomClosedFormMessage('The form is no longer accepting responses.');

// Gets the custom message set for the form and logs it to the console.
const message = form.getCustomClosedFormMessage();

console.log(message);

חזרה

String — ההודעה בהתאמה אישית שתוצג אם הטופס לא מקבל תשובות, או מחרוזת ריקה אם לא הוגדרה הודעה בהתאמה אישית.

אישור

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

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

getDescription()

הפונקציה מקבלת את תיאור הטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form description.
form.setDescription('This is the form description.');

// Gets the form description and logs it to the console.
const description = form.getDescription();

console.log(description);

חזרה

String – התיאור של הטופס.

אישור

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

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

getDestinationId()

הפונקציה מקבלת את המזהה של יעד התשובות של הטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Creates a spreadsheet to use as the response destination.
const ss = SpreadsheetApp.create('Test_Spreadsheet');

// Updates the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

// Gets the ID of the form's response destination and logs it to the console.
const destinationId = form.getDestinationId();

console.log(destinationId);

חזרה

String – המזהה של היעד לתשובות של הטופס.

אישור

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

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

getDestinationType()

הפונקציה מקבלת את הסוג של היעד לתשובות של הטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc1234556/edit',
);

// Gets the type of the form's response destination and logs it to the console.
const destinationType = form.getDestinationType().name();

console.log(destinationType);

חזרה

DestinationType – הסוג של היעד לתשובות מהטופס.

אישור

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

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

getEditUrl()

הפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי לגשת למצב העריכה של הטופס.

// Opens the form by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the URL that accesses the form's edit mode and logs it to the console.
const url = form.getEditUrl();

console.log(url);

חזרה

String – כתובת ה-URL לעריכת הטופס.

אישור

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

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

getEditors()

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

חזרה

User[] – מערך של משתמשים עם הרשאת עריכה.

אישור

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

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

getId()

הפונקציה מקבלת את המזהה של הטופס.

// Opens the form by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the ID of the form and logs it to the console.
const id = form.getId();

console.log(id);

חזרה

String – המזהה של הטופס.

אישור

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

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

getItemById(id)

אחזור הפריט עם המזהה הנתון. הפונקציה מחזירה את הערך null אם המזהה לא תואם לפריט בטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the ID of the first item on the form.
const itemId = form.getItems()[0].getId();

// Gets the item from the ID.
const item = form.getItemById(itemId);

// Gets the name of the item type and logs it to the console.
const type = item.getType().name();

console.log(type);

פרמטרים

שםסוגתיאור
idIntegerהמזהה של הפריט.

חזרה

Item – הפריט עם המזהה הנתון, או null אם הפריט לא קיים בטופס.

אישור

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

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

getItems()

הפונקציה מקבלת מערך של כל הפריטים בטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the list of items in the form.
const items = form.getItems();

// Gets the type for each item and logs them to the console.
const types = items.map((item) => item.getType().name());

console.log(types);

חזרה

Item[] – מערך של כל הפריטים בטופס.

אישור

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

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

getItems(itemType)

הפונקציה מקבלת מערך של כל הפריטים מסוג נתון.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets a list of all checkbox items on the form.
const items = form.getItems(FormApp.ItemType.CHECKBOX);

// Gets the title of each checkbox item and logs them to the console.
const checkboxItemsTitle = items.map(
    (item) => item.asCheckboxItem().getTitle(),
);
console.log(checkboxItemsTitle);

פרמטרים

שםסוגתיאור
itemTypeItemTypeסוג הפריטים לאחזור.

חזרה

Item[] – מערך של כל הפריטים מהסוג הזה.

אישור

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

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

getPublishedUrl()

הפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי להשיב לטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the URL to respond to the form and logs it to the console.
const url = form.getPublishedUrl();
console.log(url);

חזרה

String – כתובת ה-URL להשלמת הטופס.

אישור

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

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

getResponse(responseId)

הפונקציה מקבלת תשובה אחת לטופס על סמך מזהה התשובה שלה. אפשר לאחזר את מזהי התשובות מ-FormResponse.getId().

פרמטרים

שםסוגתיאור
responseIdStringהמזהה של התשובה לטופס.

חזרה

FormResponse – התשובה לטופס.

זריקות

Error – אם התשובה לא קיימת

אישור

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

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

getResponses()

הפונקציה מקבלת מערך של כל התגובות לטופס.

חזרה

FormResponse[] – מערך של כל התשובות לטופס.

אישור

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

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

getResponses(timestamp)

הפונקציה מקבלת מערך של כל התגובות לטופס אחרי תאריך ושעה נתונים.

פרמטרים

שםסוגתיאור
timestampDateהתאריך והשעה המוקדם ביותר שבהם צריך להחזיר את התשובות מהטופס.

חזרה

FormResponse[] – רשימת התגובות לטופס.

אישור

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

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

getShuffleQuestions()

קובעת אם הסדר של השאלות בכל דף בטופס יהיה אקראי.

חזרה

Booleantrue אם סדר השאלות בכל דף בטופס הוא אקראי, false אם לא.

אישור

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

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

getSummaryUrl()

הפונקציה מקבלת את כתובת ה-URL שאפשר להשתמש בה כדי להציג סיכום של התשובות לטופס. אלא אם הערך של setPublishingSummary(enabled) מוגדר כ-true, רק משתמשים עם הרשאת עריכה בטופס יוכלו לגשת לכתובת ה-URL.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// Opens the form by its URL.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the URL to view a summary of the form's responses and logs it to the
// console.
const url = form.getSummaryUrl();
console.log(url);

חזרה

String – כתובת ה-URL שבה מוצג סיכום התשובות.

אישור

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

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

getTitle()

הפונקציה מקבלת את כותרת הטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the title of the form to 'For_Testing.'
form.setTitle('For_Testing');

// Gets the title of the form and logs it to the console.
const title = form.getTitle();
console.log(title);

חזרה

String – כותרת הטופס.

אישור

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

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

hasLimitOneResponsePerUser()

קובע אם הטופס יאפשר שליחת תשובה אחת בלבד לכל משתתף. אם הערך הוא true, הסקריפט לא יכול לשלוח תגובות לטופס בכלל.

חזרה

Booleantrue אם הטופס מאפשר לשלוח רק תשובה אחת לכל משיב, false אם לא.

אישור

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

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

hasProgressBar()

קובע אם יוצג סרגל התקדמות בטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// Opens the form by its URL.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Displays the progress bar on the form.
form.setProgressBar(true);

// Checks if the form displays a progress bar and logs it to the console.
console.log(form.hasProgressBar());

חזרה

Booleantrue אם מוצג סרגל התקדמות בטופס, false אם לא.

אישור

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

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

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

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form to display a link to submit another
// response after someone submits the form.
form.setShowLinkToRespondAgain(true);

// Checks if the form displays a 'Submit another response' link and logs it to
// the console.
console.log(form.hasRespondAgainLink());

חזרה

Booleantrue אם בטופס מופיע הקישור 'שליחת תגובה נוספת', false אם הוא לא מופיע.

אישור

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

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

isAcceptingResponses()

הפונקציה קובעת אם הטופס מקבל כרגע תשובות.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form to accept responses.
form.setAcceptingResponses(true);

// Checks if the form is accepting responses or not and logs it to the console.
const accepting = form.isAcceptingResponses();
console.log(accepting);

חזרה

Booleantrue אם אפשר לשלוח תשובות לטופס, false אם לא.

אישור

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

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

isPublishingSummary()

קובע אם יוצג בטופס קישור להצגת סיכום של התשובות אחרי שהמשיב ימלא את הטופס.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form to display a link to a summary of
// the responses after someone submits the form.
form.setPublishingSummary(true);

// Checks if the form displays a "See previous responses" link and logs it to
// the console.
const publishingLink = form.isPublishingSummary();
console.log(publishingLink);

חזרה

Booleantrue אם בטופס מופיע הקישור 'הצגת התשובות הקודמות', false אם לא.

אישור

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

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

isQuiz()

קובע אם הטופס הוא בוחן.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form as a quiz.
form.setIsQuiz(true);

// Checks if the form is a quiz or not and logs it to the console.
console.log(form.isQuiz());

חזרה

Booleantrue אם אפשר לשלוח תשובות לטופס, false אם לא.

אישור

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

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

moveItem(from, to)

העברת פריט במיקום נתון מבין כל הפריטים בטופס למיקום נתון אחר. גורמת לחריגה בסקריפט אם האינדקס to חורג מהטווח.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Moves the first item to be the last item.
form.moveItem(0, form.getItems().length - 1);

פרמטרים

שםסוגתיאור
fromIntegerהמדד הנוכחי של הפריט מבין כל הפריטים בטופס.
toIntegerהמדד החדש של הפריט מבין כל הפריטים בטופס.

חזרה

Item — הפריט שהועברו.

זריקות

Error – אם אחד מהאינדקסים חורג מהטווח.

אישור

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

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

moveItem(item, toIndex)

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

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the first item.
const item = form.getItems()[0];

// Moves the item to be the last item.
form.moveItem(item, form.getItems().length - 1);

פרמטרים

שםסוגתיאור
itemItemהפריט שרוצים להעביר.
toIndexIntegerהמדד החדש של הפריט מבין כל הפריטים בטופס.

חזרה

Item — הפריט שהועברו.

זריקות

Error – אם האינדקס חורג מהטווח.

אישור

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

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

removeDestination()

ביטול הקישור של הטופס ליעד הנוכחי לתשובות. היעד הקודם שלא נותק עדיין שומר עותק של כל התשובות הקודמות. בכל הטפסים, כולל אלה שלא הוגדר להם יעד באופן מפורש, שומרים עותק של התשובות במאגר התשובות של הטופס. אם הטופס לא מכיל כרגע יעד לתגובה, לשימוש בשיטה הזו אין השפעה.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Opens a spreadsheet to use for the response destination.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Updates the form's response destination to the spreadsheet.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

// Unlinks the form from the spreadsheet.
form.removeDestination();

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

removeEditor(emailAddress)

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

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש שרוצים להסיר.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

removeEditor(user)

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

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שרוצים להסיר.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setAcceptingResponses(enabled)

מגדיר אם הטופס מקבל כרגע תשובות. ברירת המחדל של טפסים חדשים היא true.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form to accept responses.
form.setAcceptingResponses(true);

// Checks whether the form is accepting responses or not and logs it to the
// console.
console.log(form.isAcceptingResponses());

פרמטרים

שםסוגתיאור
enabledBooleantrue אם הטופס יקבל תשובות, false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setAllowResponseEdits(enabled)

ההגדרה קובעת אם יוצג בטופס קישור לעריכת תשובה אחרי שליחתה. ברירת המחדל של טפסים חדשים היא false.

ללא קשר להגדרה הזו, השיטה FormResponse.getEditResponseUrl() מאפשרת לכותב סקריפט שיש לו הרשאת עריכה בטופס ליצור כתובת URL שאפשר להשתמש בה כדי לערוך תשובה.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Shows "Edit your response" link after someone submits the form.
form.setAllowResponseEdits(true);

// Checks whether the option to edit the form after a user submits it is set to
// true or not and logs it to the console.
console.log(form.canEditResponse());

פרמטרים

שםסוגתיאור
enabledBooleantrue אם בטופס יוצג הקישור 'עריכת התשובה', false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setCollectEmail(collect)

מגדיר אם הטופס אוסף כתובות אימייל של המשיבים. ברירת המחדל של טפסים חדשים היא false.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form to collect respondents' email addresses.
form.setCollectEmail(true);

// Checks whether the value is set to true or false and logs it to the console.
const collect = form.collectsEmail();
console.log(collect);

פרמטרים

שםסוגתיאור
collectBooleantrue אם הטופס אמור לאסוף כתובות אימייל, false אם הוא לא אמור לעשות זאת.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setConfirmationMessage(message)

הגדרת הודעת האישור של הטופס.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets a custom confirmation message to display after someone submits the form.
form.setConfirmationMessage('Your form has been successfully submitted.');

// Gets the confirmation message set for the form and logs it to the console.
const message = form.getConfirmationMessage();
console.log(message);

פרמטרים

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

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setCustomClosedFormMessage(message)

הגדרת ההודעה שתוצג אם לא ניתן לשלוח תשובות לטופס. אם לא תגדירו הודעה, המערכת תשתמש בהודעת ברירת מחדל בטופס.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Sets the form to not accept responses.
form.setAcceptingResponses(false);

// Sets a custom closed form message to display to the user.
form.setCustomClosedFormMessage('The form is no longer accepting responses.');

// Gets the custom message set for the form and logs it to the console.
const message = form.getCustomClosedFormMessage();
console.log(message);

פרמטרים

שםסוגתיאור
messageStringההודעה שתוצג אם לא ניתן לשלוח תשובות לטופס.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setDescription(description)

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

פרמטרים

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

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setDestination(type, id)

הגדרת היעד שבו נשמרות התשובות לטופס. בכל הטפסים, כולל אלה שלא מוגדר להם יעד באופן מפורש, נשמר עותק של התגובות במאגר התגובות של הטופס.

פרמטרים

שםסוגתיאור
typeDestinationTypeהסוג של היעד לתשובות מהטופס.
idStringהמזהה של היעד לתשובות של הטופס.

חזרה

Form — השדה Form, לצורך קישור.

זריקות

Error – אם מזהה היעד שצוין לא תקין

אישור

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

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

setIsQuiz(enabled)

קובע אם הטופס הוא בוחן. ברירת המחדל של טפסים חדשים היא false.

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

ההגדרות של הבוחנים זמינות רק בממשק המשתמש החדש של Forms. אם הופכים טופס לבוחן, הוא עובר לממשק המשתמש החדש.

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Makes the form a quiz.
form.setIsQuiz(true);

// Checks whether the form is a quiz or not and logs it to the console.
console.log(form.isQuiz());

פרמטרים

שםסוגתיאור
enabledBooleantrue אם צריך להפעיל את התכונות של הבוחן בטופס, false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setLimitOneResponsePerUser(enabled)

מגדיר אם הטופס יאפשר לשלוח רק תשובה אחת לכל משתתף. ברירת המחדל של טפסים חדשים היא false. אם הערך מוגדר כ-true, הסקריפט לא יכול לשלוח תשובות לטופס בכלל.

פרמטרים

שםסוגתיאור
enabledBooleantrue אם הטופס יאפשר לשלוח רק תשובה אחת לכל משיב, או false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setProgressBar(enabled)

קובע אם סרגל ההתקדמות יופיע בטופס. ברירת המחדל של טפסים חדשים היא false.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Displays the progress bar on the form.
form.setProgressBar(true);

// Checks whether the form has a progress bar and logs it to the console.
console.log(form.hasProgressBar());

פרמטרים

שםסוגתיאור
enabledBooleantrue אם מוצג סרגל התקדמות בטופס, false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setPublishingSummary(enabled)

ההגדרה קובעת אם יוצג בטופס קישור לצפייה בסיכום התשובות אחרי שהמשיב ישלח את הטופס. ברירת המחדל של טפסים חדשים היא false.

פרמטרים

שםסוגתיאור
enabledBooleantrue אם בטופס יוצג הקישור 'הצגת התשובות הקודמות', false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setShowLinkToRespondAgain(enabled)

ההגדרה קובעת אם יוצג בטופס קישור לשליחת תגובה נוספת אחרי שהמשיב ימלא את הטופס. ברירת המחדל של טפסים חדשים היא true.

פרמטרים

שםסוגתיאור
enabledBooleantrue אם בטופס יוצג הקישור 'שליחת תגובה נוספת', false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setShuffleQuestions(shuffle)

ההגדרה קובעת אם הסדר של השאלות בכל דף בטופס יהיה אקראי.

פרמטרים

שםסוגתיאור
shuffleBooleantrue אם סדר השאלות בכל דף בטופס צריך להיות אקראי, false אם לא.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

setTitle(title)

הגדרת שם הטופס.

פרמטרים

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

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

shortenFormUrl(url)

המרת כתובת URL ארוכה של טופס לכתובת URL קצרה. גורמת להשלכת חריגה אם כתובת ה-URL הארוכה לא שייכת ל-Google Forms.

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL שרוצים לקצר.

חזרה

String – כתובת URL בפורמט http://goo.gl/forms/1234.

אישור

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

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

submitGrades(responses)

שליחת ציונים עבור התשובות לטופס.

אם הקוד כולל טריגר onFormSubmit, קריאה ל-submitGrades() מפעילה את התנאי onFormSubmit וגורמת ללולאה אינסופית. כדי למנוע את הלולאה האינסופית, מוסיפים קוד שבודק אם כבר יש ציונים לפני שמפעילים את submitGrades().

פרמטרים

שםסוגתיאור
responsesFormResponse[]מערך של כל התשובות בטופס.

חזרה

Form — השדה Form, לצורך קישור.

אישור

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

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

שיטות שהוצאו משימוש