Class Choice
Page Summary
A Choice represents a single option within form items like CheckboxItem, ListItem, or MultipleChoiceItem.
The
getGotoPage()method retrieves the PageBreakItem set as a GO_TO_PAGE destination for a choice in a MultipleChoiceItem.The
getPageNavigationType()method gets the PageNavigationType associated with a choice in a MultipleChoiceItem.The
getValue()method returns the string label that respondents see for a choice.The
isCorrectAnswer()method indicates if a choice is marked as a correct answer in a quiz form.
A single choice associated with a type ofItem that supports choices, likeCheckbox,List, orMultiple.
// Create a new form and add a multiple-choice item.constform=FormApp.create('Form Name');constitem=form.addMultipleChoiceItem();item.setTitle('Do you prefer cats or dogs?').setChoices([item.createChoice('Cats',FormApp.PageNavigationType.CONTINUE),item.createChoice('Dogs',FormApp.PageNavigationType.RESTART),]);// Add another page because navigation has no effect on the last page.form.addPageBreakItem().setTitle('You chose well!');// Log the navigation types that each choice results in.constchoices=item.getChoices();for(leti=0;i <choices.length;i++){Logger.log('If the respondent chooses "%s", the form will %s.',choices[i].getValue(),choices[i].getPageNavigationType(),);}
Methods
| Method | Return type | Brief description |
|---|---|---|
get | Page | Gets thePage set as aGO_TO_PAGE destinationif the responder selects this choice and completes the current page. |
get | Page | Gets thePage that occurs if the responder selects this choice andcompletes the current page. |
get | String | Gets the choice's value, which respondents see as a label when viewing the form. |
is | Boolean | Gets whether the choice is a correct answer for the question. |
Detailed documentation
getGotoPage()
Gets thePage set as aGO_TO_PAGE destinationif the responder selects this choice and completes the current page. This method applies onlyto choices associated withMultiple; for other choices,it returnsnull.
Return
Page — theGO_TO_PAGE destination for this choice, ornull if there is none
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getPageNavigationType()
Gets thePage that occurs if the responder selects this choice andcompletes the current page. This method applies only to choices associated withMultiple; for other choices, it returnsnull.
Return
Page — the navigation action for this choice, ornull if there is none
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getValue()
Gets the choice's value, which respondents see as a label when viewing the form.
Return
String — the choice's value
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
isCorrectAnswer()
Gets whether the choice is a correct answer for the question. This method only applies toquestions that are part of a quiz; for non-quiz forms, it returns false.
Return
Boolean — Whether the choice is a correct answer.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.