Class RatingItem
Page Summary
A RatingItem is a question type in Google Forms that allows respondents to provide a rating, and can be graded when used in a quiz.
You can access or create RatingItems from a Form object using Google Apps Script.
RatingItems have methods to get and set properties like the rating scale level, rating icon, title, and whether the question is required.
Methods are available to duplicate a RatingItem or create a response for it.
Authorization scopes like
https://www.googleapis.com/auth/formsare required to use these methods.
A question item that allows the respondent to give a rating. Items can be accessed or createdfrom aForm. When used in a quiz, these items are graded.
// Open a form by IDconstform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');// Get an existing rating item and access its properties.constexistingRatingItem=form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();constratingScaleLevel=existingRatingItem.getRatingScaleLevel();constratingIcon=existingRatingItem.getRatingIcon();// Create a new rating item.constratingItem=form.addRatingItem();// Update the rating item's properties via chaining.ratingItem.setRatingScaleLevel(7).setRatingIcon(FormApp.RatingIconType.HEART);
Methods
| Method | Return type | Brief description |
|---|---|---|
create | Item | Creates a newItem for this rating item. |
duplicate() | Rating | 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 | Integer | Returns the point value of a gradeable item. |
get | Rating | Gets the icon chosen for the rating. |
get | Integer | Gets the rating's scale level. |
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. |
is | Boolean | Determines whether the respondent must answer the question. |
set | Rating | 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 | Rating | Sets the item's help text (sometimes called description text for layout items likeImage,Page, andSection). |
set | Rating | Sets the number of points a gradeable item is worth. |
set | Rating | Sets the rating's icon. |
set | Rating | Sets the rating's maximum scale level. |
set | Rating | Sets whether the respondent must answer the question. |
set | Rating | Sets the item's title (sometimes called header text, in the case of aSection). |
Detailed documentation
createResponse(response)
Creates a newItem for this rating item.
Throws a scripting exception if the providedresponse is less than1 orgreater than the value returned byget.
// Open a form by IDconstform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');// Get an existing rating item and create a response for it.constitem=form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();constresponse=item.createResponse(5);
Parameters
| Name | Type | Description |
|---|---|---|
response | Integer | A value answer for this rating 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
Rating — a duplicate of thisRating, 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
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
getRatingIcon()
Gets the icon chosen for the rating.
// Open a form by IDconstform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');// Get an existing rating item and get its rating icon.constitem=form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();constratingIcon=item.getRatingIcon();
Return
Rating — The rating icon type.
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
getRatingScaleLevel()
Gets the rating's scale level.
// Open a form by IDconstform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');// Get an existing rating item and get its rating scale level.constitem=form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();constratingScaleLevel=item.getRatingScaleLevel();
Return
Integer — The rating scale level.
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()
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
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
Rating — thisRating, 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
Rating — thisRating, 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
Rating — thisRating, 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
setRatingIcon(ratingIcon)
Sets the rating's icon.
Throws a scripting exception if the rating icon type is invalid.
// Open a form by IDconstform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');// Get an existing rating item and set its rating icon.constitem=form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();item.setRatingIcon(FormApp.RatingIconType.THUMB_UP);
Parameters
| Name | Type | Description |
|---|---|---|
rating | Rating | The rating icon type. |
Return
Rating — ThisRating, for chaining.
Throws
Error — if the rating icon type 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
setRatingScaleLevel(ratingScaleLevel)
Sets the rating's maximum scale level. The rating's maximum scale level must be between3 and10, inclusive. A new rating defaults to a rating scale level of3.
Throws a scripting exception if the given values are outside the permitted limits.
// Open a form by IDconstform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');// Get an existing rating item and set its rating scale level.constitem=form.getItems(FormApp.ItemType.RATING)[0].asRatingItem();item.setRatingScaleLevel(7);
Parameters
| Name | Type | Description |
|---|---|---|
rating | Integer | The rating scale level. |
Return
Rating — ThisRating, for chaining.
Throws
Error — if the rating scale level 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
setRequired(enabled)
Sets whether the respondent must answer the question.
Parameters
| Name | Type | Description |
|---|---|---|
enabled | Boolean | whether the respondent must answer the question |
Return
Rating — 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
Rating — thisRating, 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.