Stay organized with collections Save and categorize content based on your preferences.
RatingItemA question item that allows the respondent to give a rating. Items can be accessed or created from a Form
. When used in a quiz, these items are graded.
// Open a form by ID const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Get an existing rating item and access its properties. const existingRatingItem = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem(); const ratingScaleLevel = existingRatingItem.getRatingScaleLevel(); const ratingIcon = existingRatingItem.getRatingIcon(); // Create a new rating item. const ratingItem = form.addRatingItem(); // Update the rating item's properties via chaining. ratingItem.setRatingScaleLevel(7).setRatingIcon(FormApp.RatingIconType.HEART);Detailed documentation
createResponse(response)
Creates a new ItemResponse
for this rating item.
Throws a scripting exception if the provided response
is less than 1
or greater than the value returned by getRatingScaleLevel()
.
// Open a form by ID const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Get an existing rating item and create a response for it. const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem(); const response =item.createResponse(5);Parameters Name Type Description
response
Integer
A value answer for this rating item. Return
ItemResponse
— The item response.
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.
ReturnRatingItem
— a duplicate of this RatingItem
, for chaining
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.
ReturnQuizFeedback
— the feedback, if any.
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
).
String
— the item's help text or description text
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.
ReturnInteger
— the item's ID
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.
ReturnInteger
— the index of the item
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.
ReturnInteger
— the number of points a question is worth.
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
getRatingIcon()
Gets the icon chosen for the rating.
// Open a form by ID const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Get an existing rating item and get its rating icon. const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem(); const ratingIcon = item.getRatingIcon();Return
RatingIconType
— The rating icon type.
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
getRatingScaleLevel()
Gets the rating's scale level.
// Open a form by ID const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Get an existing rating item and get its rating scale level. const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem(); const ratingScaleLevel = item.getRatingScaleLevel();Return
Integer
— The rating scale level.
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
).
String
— the item's title or header text
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()
Gets the item's type, represented as an ItemType
.
ItemType
— the item's type
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.
ReturnBoolean
— whether the respondent must answer the question
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 Descriptionfeedback
QuizFeedback
the new feedback Return
RatingItem
— this RatingItem
, for chaining
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
).
text
String
the new help text Return
RatingItem
— this RatingItem
, for chaining
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 Descriptionpoints
Integer
the number of a points a question item is worth Return
RatingItem
— this RatingItem
, for chaining
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
setRatingIcon(ratingIcon)
Sets the rating's icon.
Throws a scripting exception if the rating icon type is invalid.
// Open a form by ID const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Get an existing rating item and set its rating icon. const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem(); item.setRatingIcon(FormApp.RatingIconType.THUMB_UP);Parameters Return
RatingItem
— This RatingItem
, for chaining.
Error
— if the rating icon type is invalid
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
setRatingScaleLevel(ratingScaleLevel)
Sets the rating's maximum scale level. The rating's maximum scale level must be between 3
and 10
, inclusive. A new rating defaults to a rating scale level of 3
.
Throws a scripting exception if the given values are outside the permitted limits.
// Open a form by ID const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); // Get an existing rating item and set its rating scale level. const item = form.getItems(FormApp.ItemType.RATING)[0].asRatingItem(); item.setRatingScaleLevel(7);Parameters Name Type Description
ratingScaleLevel
Integer
The rating scale level. Return
RatingItem
— This RatingItem
, for chaining.
Error
— if the rating scale level is invalid
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 Descriptionenabled
Boolean
whether the respondent must answer the question Return
RatingItem
— the current item (for chaining)
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
).
title
String
the new title or header text Return
RatingItem
— this RatingItem
, for chaining
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-05 UTC."],[[["A RatingItem is a question type in Google Forms that allows respondents to provide a rating using a defined scale and icon."],["You can access and modify existing RatingItems or create new ones within a form using Apps Script."],["RatingItems offer various properties and methods for customization, such as setting the rating scale, icon, help text, and whether it's required."],["In quizzes, RatingItems can be graded, and feedback can be provided to respondents based on their answers."],["Apps Script provides a comprehensive set of methods to interact with RatingItems, allowing you to programmatically manage and manipulate them within your Google Forms."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4