A question item that allows the respondent to choose one option from a numbered sequence of radio
buttons. Items can be accessed or created from a Form
. When used in a quiz, these items
are graded.
// Open a form by ID and add a new scale item. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); var item = form.addScaleItem(); item.setTitle('Pick a number between 1 and 10') .setBounds(1, 10);
Methods
Method | Return type | Brief description |
---|---|---|
createResponse(response) | ItemResponse | Creates a new ItemResponse for this scale item. |
duplicate() | ScaleItem | Creates a copy of this item and appends it to the end of the form. |
getGeneralFeedback() | QuizFeedback | Returns the feedback that is shown to respondents when they respond to a gradeable 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. |
getLeftLabel() | String | Gets the label for the scale's lower bound, if any. |
getLowerBound() | Integer | Gets the scale's lower bound. |
getPoints() | Integer | Returns the point value of a gradeable item. |
getRightLabel() | String | Gets the label for the scale's upper bound, if any. |
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 . |
getUpperBound() | Integer | Gets the scale's upper bound. |
isRequired() | Boolean | Determines whether the respondent must answer the question. |
setBounds(lower, upper) | ScaleItem | Sets the scale's lower and upper bounds. |
setGeneralFeedback(feedback) | ScaleItem | Sets the feedback to be shown to respondents when they respond to a gradeable question that doesn't have a correct or incorrect answer (ie questions that require manual grading). |
setHelpText(text) | ScaleItem | Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
setLabels(lower, upper) | ScaleItem | Sets labels for the scale's lower and upper bounds. |
setPoints(points) | ScaleItem | Sets the number of points a gradeable item is worth. |
setRequired(enabled) | ScaleItem | Sets whether the respondent must answer the question. |
setTitle(title) | ScaleItem | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
Detailed documentation
createResponse(response)
Creates a new ItemResponse
for this scale item. Throws an exception if the response
argument is outside the bounds set for the item.
Parameters
Name | Type | Description |
---|---|---|
response | Integer | a value answer for this scale item |
Return
ItemResponse
— the item response
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
duplicate()
Creates a copy of this item and appends it to the end of the form.
Return
ScaleItem
— a duplicate of this ScaleItem
, for chaining
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
getGeneralFeedback()
Returns the feedback that is shown to respondents when they respond to a gradeable question.
Return
QuizFeedback
— the feedback, if any.
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
getHelpText()
Gets the item's help text (sometimes called description text for layout items like ImageItems
, PageBreakItems
, and SectionHeaderItems
).
Return
String
— the item's help text or description text
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
getId()
Gets the item's unique identifier.
Return
Integer
— the item's ID
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
getIndex()
Gets the index of the item among all the items in the form.
Return
Integer
— the index of the item
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
getLeftLabel()
Gets the label for the scale's lower bound, if any.
Return
String
— the label for the scale's lower bound
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
getLowerBound()
Gets the scale's lower bound.
Return
Integer
— the scale's lower bound
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
getPoints()
Returns the point value of a gradeable item.
Return
Integer
— the number of points a question is worth.
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
getRightLabel()
Gets the label for the scale's upper bound, if any.
Return
String
— the label for the scale's upper bound
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
getTitle()
Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem
).
Return
String
— the item's title or header text
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
getType()
getUpperBound()
Gets the scale's upper bound.
Return
Integer
— the scale's upper bound
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
isRequired()
Determines whether the respondent must answer the question.
Return
Boolean
— whether the respondent must answer the question
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
setBounds(lower, upper)
Sets the scale's lower and upper bounds. The lower bound must be 0
or 1
. The
upper bound must be between 3
and 10
, inclusive. A new scale defaults to a
lower bound of 1
and an upper bound of 5
.
Throws a scripting exception if the given values are outside the permitted limits. Decimals are truncated to the preceding integer.
Parameters
Name | Type | Description |
---|---|---|
lower | Integer | the new lower bound |
upper | Integer | the new upper bound |
Return
ScaleItem
— this ScaleItem
, for chaining
Throws
Error
— if the lower or upper bound is invalid
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
setGeneralFeedback(feedback)
Sets the feedback to be shown to respondents when they respond to a gradeable question that doesn't have a correct or incorrect answer (ie questions that require manual grading).
Parameters
Name | Type | Description |
---|---|---|
feedback | QuizFeedback | the new feedback |
Return
ScaleItem
— this ScaleItem
, for chaining
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
setHelpText(text)
Sets the item's help text (sometimes called description text for layout items like ImageItems
, PageBreakItems
, and SectionHeaderItems
).
Parameters
Name | Type | Description |
---|---|---|
text | String | the new help text |
Return
ScaleItem
— this ScaleItem
, for chaining
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
setLabels(lower, upper)
Sets labels for the scale's lower and upper bounds.
Parameters
Name | Type | Description |
---|---|---|
lower | String | the new label for the lower bound |
upper | String | the new label for the upper bound |
Return
ScaleItem
— this ScaleItem
, for chaining
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
setPoints(points)
Sets the number of points a gradeable item is worth. The default for new items is 0.
Parameters
Name | Type | Description |
---|---|---|
points | Integer | the number of a points a question item is worth |
Return
ScaleItem
— this ScaleItem
, for chaining
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
setRequired(enabled)
Sets whether the respondent must answer the question.
Parameters
Name | Type | Description |
---|---|---|
enabled | Boolean | whether the respondent must answer the question |
Return
ScaleItem
— the current item (for chaining)
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
setTitle(title)
Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem
).
Parameters
Name | Type | Description |
---|---|---|
title | String | the new title or header text |
Return
ScaleItem
— this ScaleItem
, for chaining
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