Stay organized with collections Save and categorize content based on your preferences.
ListItemA question item that allows the respondent to select one choice from a drop-down list. Items can be accessed or created from a Form.
// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
item.createChoice('Cats'), item.createChoice('Dogs')
]); Methods Method Return type Brief description createChoice(value) Choice Creates a new choice. createChoice(value, isCorrect) Choice Creates a new choice. createChoice(value, navigationItem) Choice Creates a new choice with a page-navigation option that jumps to a given page-break item. createChoice(value, navigationType) Choice Creates a new choice with a page-navigation option. createResponse(response) ItemResponse Creates a new ItemResponse for this list item. duplicate() ListItem Creates a copy of this item and appends it to the end of the form. getChoices() Choice[] Gets all choices for an item. getFeedbackForCorrect() QuizFeedback Returns the feedback that is shown to respondents when they respond correctly to a question. getFeedbackForIncorrect() QuizFeedback Returns the feedback that is shown to respondents when they respond incorrectly to a question. getHelpText() String Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems). getId() Integer Gets the item's unique identifier. getIndex() Integer Gets the index of the item among all the items in the form. getPoints() Integer Returns the point value of a gradeable item. getTitle() String Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem). getType() ItemType Gets the item's type, represented as an ItemType. isRequired() Boolean Determines whether the respondent must answer the question. setChoiceValues(values) ListItem Sets the choices for an item from an array of strings. setChoices(choices) ListItem Sets an array of choices for an item. setFeedbackForCorrect(feedback) ListItem Sets the feedback to be shown to respondents when they respond correctly to a question. setFeedbackForIncorrect(feedback) ListItem Sets the feedback to be shown to respondents when they respond incorrectly to a question. setHelpText(text) ListItem Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems). setPoints(points) ListItem Sets the number of points a gradeable item is worth. setRequired(enabled) ListItem Sets whether the respondent must answer the question. setTitle(title) ListItem Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem). Detailed documentation createChoice(value)
Creates a new choice.
Parameters Name Type Descriptionvalue String the choice's value, which respondents see as a label when viewing the form Return
Choice — the new choice
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formscreateChoice(value, isCorrect)
Creates a new choice.
Parameters Name Type Descriptionvalue String the choice's value, which respondents see as a label when viewing the form isCorrect Boolean whether the choice is a correct answer Return
Choice — the new choice
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formscreateChoice(value, navigationItem)
Creates a new choice with a page-navigation option that jumps to a given page-break item. This is equivalent to createChoice(value, navigationType) with navigationType set to FormApp.PageNavigationType.GO_TO_PAGE. Choices that use page navigation cannot be combined in the same item with choices that do not use page navigation.
The page navigation occurs after the respondent completes a page that contains the option, and only if the respondent chose that option. If the respondent chose multiple options with page-navigation instructions on the same page, only the last navigation option has any effect. Page navigation also has no effect on the last page of a form.
Parameters Name Type Descriptionvalue String the choice's value, which respondents see as a label when viewing the form navigationItem PageBreakItem the item to navigate to Return
Choice — the new choice
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formscreateChoice(value, navigationType)
Creates a new choice with a page-navigation option. Choices that use page navigation cannot be combined in the same item with choices that do not use page navigation.
The page navigation occurs after the respondent completes a page that contains the option, and only if the respondent chose that option. If the respondent chose multiple options with page-navigation instructions on the same page, only the last navigation option has any effect. Page navigation also has no effect on the last page of a form.
Parameters Name Type Descriptionvalue String the choice's value, which respondents see as a label when viewing the form navigationType PageNavigationType the choice's navigation type Return
Choice — the new choice
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formscreateResponse(response)
Creates a new ItemResponse for this list item. Throws an exception if the response argument does not match a valid choice for this item.
response String a valid answer for this list item Return
ItemResponse — the item response
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsduplicate()
Creates a copy of this item and appends it to the end of the form.
ReturnListItem — a duplicate of this ListItem, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetChoices()
Gets all choices for an item.
ReturnChoice[] — an array of choices
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetFeedbackForCorrect()
Returns the feedback that is shown to respondents when they respond correctly to a question.
ReturnQuizFeedback — the feedback, if any.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetFeedbackForIncorrect()
Returns the feedback that is shown to respondents when they respond incorrectly to a question.
ReturnQuizFeedback — the feedback, if any.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetHelpText()
Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
String — the item's help text or description text
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetId()
Gets the item's unique identifier.
ReturnInteger — the item's ID
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetIndex()
Gets the index of the item among all the items in the form.
ReturnInteger — the index of the item
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetPoints()
Returns the point value of a gradeable item.
ReturnInteger — the number of points a question is worth.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetTitle()
Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem).
String — the item's title or header text
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsgetType()
Gets the item's type, represented as an ItemType.
ItemType — the item's type
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsisRequired()
Determines whether the respondent must answer the question.
ReturnBoolean — whether the respondent must answer the question
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetChoiceValues(values)
Sets the choices for an item from an array of strings. Throws an exception if the given array is empty.
// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']); Parameters Name Type Description values String[] the array of choice values, which respondents see as labels when viewing the form Return
ListItem — this ListItem, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetChoices(choices)
Sets an array of choices for an item. Throws an exception if the given array is empty or contains a null element.
// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]); Parameters Name Type Description choices Choice[] an array of choices Return
ListItem — this ListItem, for chaining
Error — if the given array is null, empty, or contains a null element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetFeedbackForCorrect(feedback)
Sets the feedback to be shown to respondents when they respond correctly to a question.
// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
item.createChoice('Dogs', true),
item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
FormApp.createFeedback().setDisplayText('Dogs rule, cats drool.').build(),
); Parameters Name Type Description feedback QuizFeedback the new feedback. A null value will clear the feedback. Return
ListItem — this ListItem, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetFeedbackForIncorrect(feedback)
Sets the feedback to be shown to respondents when they respond incorrectly to a question.
Parameters Name Type Descriptionfeedback QuizFeedback the new feedback Return
ListItem — this ListItem, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetHelpText(text)
Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
text String the new help text Return
ListItem — this ListItem, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetPoints(points)
Sets the number of points a gradeable item is worth. The default for new items is 0.
Parameters Name Type Descriptionpoints Integer the number of a points a question item is worth Return
ListItem — this ListItem, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetRequired(enabled)
Sets whether the respondent must answer the question.
Parameters Name Type Descriptionenabled Boolean whether the respondent must answer the question Return
ListItem — the current item (for chaining)
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formssetTitle(title)
Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem).
title String the new title or header text Return
ListItem — this ListItem, for chaining
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/formsExcept as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-02 UTC."],[[["Google Apps Script's ListItem object enables the creation of single-choice, drop-down list questions within Google Forms."],["Developers can utilize various ListItem methods for customization, including setting choices, feedback, help text, and points."],["Choices within a ListItem can be linked to specific form pages for navigation control."],["ListItem questions are ideal for collecting single selections from a predefined list of options, making them suitable for surveys or quizzes."],["Authorization with specific Google Forms scopes is necessary when using ListItem methods in scripts."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4