Class Choice

A single choice associated with a type of Item that supports choices, like CheckboxItem, ListItem, or MultipleChoiceItem.

// Create a new form and add a multiple-choice item.
var form = FormApp.create('Form Name');
var item = 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.
var choices = item.getChoices();
for (var i = 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
`getGotoPage()`	`PageBreakItem`	Gets the `PageBreakItem` set as a `GO_TO_PAGE` destination if the responder selects this choice and completes the current page.
`getPageNavigationType()`	`PageNavigationType`	Gets the `PageNavigationType` that occurs if the responder selects this choice and completes the current page.
`getValue()`	`String`	Gets the choice's value, which respondents see as a label when viewing the form.
`isCorrectAnswer()`	`Boolean`	Gets whether the choice is a correct answer for the question.

Detailed documentation

`getGotoPage()`

Gets the PageBreakItem set as a GO_TO_PAGE destination if the responder selects this choice and completes the current page. This method applies only to choices associated with MultipleChoiceItems; for other choices, it returns null.

Return

PageBreakItem — the GO_TO_PAGE destination for this choice, or null if there is none

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

`getPageNavigationType()`

Gets the PageNavigationType that occurs if the responder selects this choice and completes the current page. This method applies only to choices associated with MultipleChoiceItems; for other choices, it returns null.

Return

PageNavigationType — the navigation action for this choice, or null if there is none

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/forms.currentonly
https://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 following scopes:

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

`isCorrectAnswer()`

Gets whether the choice is a correct answer for the question. This method only applies to questions 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 following scopes:

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