Class TextItem

  • A TextItem in Google Forms allows respondents to enter a single line of text and can be graded when used in a quiz.

  • You can access or create a TextItem from a Form using Apps Script, as demonstrated in the provided code example.

  • TextItems offer various methods to manage their properties, such as setting the title, help text, required status, and points, as well as managing data validation and duplicating the item.

  • Methods are available to retrieve information about a TextItem, including its ID, index, title, type, points, help text, and whether it is required.

  • Authorization with specific scopes (https://www.googleapis.com/auth/forms.currentonly orhttps://www.googleapis.com/auth/forms) is required for scripts using these TextItem methods.

TextItem

A question item that allows the respondent to enter a single line of text. Items can be accessedor created from aForm. When used in a quiz, these items are graded.

// Open a form by ID and add a new text item.constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');constitem=form.addTextItem();item.setTitle('What is your name?');

Methods

MethodReturn typeBrief description
clearValidation()TextItemRemoves any data validation for this text item.
createResponse(response)ItemResponseCreates a newItemResponse for this text item.
duplicate()TextItemCreates a copy of this item and appends it to the end of the form.
getGeneralFeedback()QuizFeedback|nullReturns the feedback that is shown to respondents when they respond to a gradeable question.
getHelpText()StringGets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).
getId()IntegerGets the item's unique identifier.
getIndex()IntegerGets the index of the item among all the items in the form.
getPoints()IntegerReturns the point value of a gradeable item.
getTitle()StringGets the item's title (sometimes called header text, in the case of aSectionHeaderItem).
getType()ItemTypeGets the item's type, represented as anItemType.
isRequired()BooleanDetermines whether the respondent must answer the question.
setGeneralFeedback(feedback)TextItemSets 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).
setHelpText(text)TextItemSets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).
setPoints(points)TextItemSets the number of points a gradeable item is worth.
setRequired(enabled)TextItemSets whether the respondent must answer the question.
setTitle(title)TextItemSets the item's title (sometimes called header text, in the case of aSectionHeaderItem).
setValidation(validation)TextItemSets the data validation for this text item.

Detailed documentation

clearValidation()

Removes any data validation for this text item.

Return

TextItem — thisTextItem, for chaining

Authorization

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

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

createResponse(response)

Creates a newItemResponse for this text item.

Parameters

NameTypeDescription
responseStringan answer to the question posed by the item

Return

ItemResponse — the item response

Authorization

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

  • 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

TextItem — a duplicate of thisTextItem, for chaining

Authorization

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

  • 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|null — 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.currentonly
  • https://www.googleapis.com/auth/forms

getHelpText()

Gets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).

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.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 followingscopes:

  • 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 followingscopes:

  • 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 followingscopes:

  • 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 aSectionHeaderItem).

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

getType()

Gets the item's type, represented as anItemType.

Return

ItemType — the item's type

Authorization

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

  • 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 followingscopes:

  • 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 thatdoesn't have a correct or incorrect answer (ie questions that require manual grading).

Parameters

NameTypeDescription
feedbackQuizFeedbackthe new feedback

Return

TextItem — thisTextItem, for chaining

Authorization

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

  • 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 likeImageItems,PageBreakItems, andSectionHeaderItems).

Parameters

NameTypeDescription
textStringthe new help text

Return

TextItem — thisTextItem, for chaining

Authorization

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

  • 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

NameTypeDescription
pointsIntegerthe number of a points a question item is worth

Return

TextItem — thisTextItem, for chaining

Authorization

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

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

setRequired(enabled)

Sets whether the respondent must answer the question.

Parameters

NameTypeDescription
enabledBooleanwhether the respondent must answer the question

Return

TextItem — 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.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

Sets the item's title (sometimes called header text, in the case of aSectionHeaderItem).

Parameters

NameTypeDescription
titleStringthe new title or header text

Return

TextItem — thisTextItem, for chaining

Authorization

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

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

setValidation(validation)

Sets the data validation for this text item. Passing in null or a validation without anyrequire functions called will remove any prior validation.

Parameters

NameTypeDescription
validationTextValidationa TextValidation to apply to this item.

Return

TextItem — thisTextItem, for chaining

Authorization

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

  • 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 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.