Class ScaleItem
Page Summary
A ScaleItem is a question item in Google Forms that allows respondents to select one option from a numbered sequence of radio buttons.
ScaleItems can be created and accessed from a Form object and are graded when used in a quiz.
Key methods for ScaleItems include setting bounds, labels, title, help text, required status, and point values, as well as creating responses and duplicating the item.
A question item that allows the respondent to choose one option from a numbered sequence of radiobuttons. Items can be accessed or created from aForm. When used in a quiz, these itemsare graded.
// Open a form by ID and add a new scale item.constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');constitem=form.addScaleItem();item.setTitle('Pick a number between 1 and 10').setBounds(1,10);
Methods
| Method | Return type | Brief description |
|---|---|---|
create | Item | Creates a newItem for this scale item. |
duplicate() | Scale | Creates a copy of this item and appends it to the end of the form. |
get | Quiz | Returns the feedback that is shown to respondents when they respond to a gradeable question. |
get | String | Gets the item's help text (sometimes called description text for layout items likeImage,Page, andSection). |
get | Integer | Gets the item's unique identifier. |
get | Integer | Gets the index of the item among all the items in the form. |
get | String | Gets the label for the scale's lower bound, if any. |
get | Integer | Gets the scale's lower bound. |
get | Integer | Returns the point value of a gradeable item. |
get | String | Gets the label for the scale's upper bound, if any. |
get | String | Gets the item's title (sometimes called header text, in the case of aSection). |
get | Item | Gets the item's type, represented as anItem. |
get | Integer | Gets the scale's upper bound. |
is | Boolean | Determines whether the respondent must answer the question. |
set | Scale | Sets the scale's lower and upper bounds. |
set | Scale | Sets the feedback to be shown to respondents when they respond to a gradeable question thatdoesn't have a correct or incorrect answer (ie questions that require manual grading). |
set | Scale | Sets the item's help text (sometimes called description text for layout items likeImage,Page, andSection). |
set | Scale | Sets labels for the scale's lower and upper bounds. |
set | Scale | Sets the number of points a gradeable item is worth. |
set | Scale | Sets whether the respondent must answer the question. |
set | Scale | Sets the item's title (sometimes called header text, in the case of aSection). |
Detailed documentation
createResponse(response)
Creates a newItem for this scale item. Throws an exception if theresponse argument is outside the bounds set for the item.
Parameters
| Name | Type | Description |
|---|---|---|
response | Integer | a value answer for this scale item |
Return
Item — the item response
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
duplicate()
Creates a copy of this item and appends it to the end of the form.
Return
Scale — a duplicate of thisScale, for chaining
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
getGeneralFeedback()
Returns the feedback that is shown to respondents when they respond to a gradeable question.
Return
Quiz — the feedback, if any.
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
getHelpText()
Gets the item's help text (sometimes called description text for layout items likeImage,Page, andSection).
Return
String — the item's help text or description text
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
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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getTitle()
Gets the item's title (sometimes called header text, in the case of aSection).
Return
String — the item's title or header text
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
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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setBounds(lower, upper)
Sets the scale's lower and upper bounds. The lower bound must be0 or1. Theupper bound must be between3 and10, inclusive. A new scale defaults to alower bound of1 and an upper bound of5.
Throws a scripting exception if the given values are outside the permitted limits. Decimalsare truncated to the preceding integer.
Parameters
| Name | Type | Description |
|---|---|---|
lower | Integer | the new lower bound |
upper | Integer | the new upper bound |
Return
Scale — thisScale, 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 followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setGeneralFeedback(feedback)
Sets the feedback to be shown to respondents when they respond to a gradeable question thatdoesn't have a correct or incorrect answer (ie questions that require manual grading).
Parameters
| Name | Type | Description |
|---|---|---|
feedback | Quiz | the new feedback |
Return
Scale — thisScale, for chaining
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
setHelpText(text)
Sets the item's help text (sometimes called description text for layout items likeImage,Page, andSection).
Parameters
| Name | Type | Description |
|---|---|---|
text | String | the new help text |
Return
Scale — thisScale, for chaining
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
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
Scale — thisScale, for chaining
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
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
Scale — thisScale, for chaining
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
setRequired(enabled)
Sets whether the respondent must answer the question.
Parameters
| Name | Type | Description |
|---|---|---|
enabled | Boolean | whether the respondent must answer the question |
Return
Scale — the current item (for chaining)
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
setTitle(title)
Sets the item's title (sometimes called header text, in the case of aSection).
Parameters
| Name | Type | Description |
|---|---|---|
title | String | the new title or header text |
Return
Scale — thisScale, for chaining
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.