Class ParagraphTextItem

AI-generated Key Takeaways

• ParagraphTextItem is a question item in Google Forms that allows respondents to enter a block of text.

• ParagraphTextItems can be accessed or created from a Form object.

• When used in a quiz, ParagraphTextItems are graded.

• You can clear validation, create responses, duplicate, get/set feedback, help text, ID, index, points, title, type, required status, and validation for a ParagraphTextItem using its methods.

• Using ParagraphTextItem methods requires specific authorization scopes.

ParagraphTextItem

A question item that allows the respondent to enter a block of text. 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 paragraph text item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addParagraphTextItem();
item.setTitle('What is your address?');

Methods

Method	Return type	Brief description
clearValidation()	ParagraphTextItem	Removes any data validation for this paragraph text item.
createResponse(response)	ItemResponse	Creates a new ItemResponse for this paragraph text item.
duplicate()	ParagraphTextItem	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.
getPoints()	Integer	Returns the point value of a gradeable item.
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.
isRequired()	Boolean	Determines whether the respondent must answer the question.
setGeneralFeedback(feedback)	ParagraphTextItem	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)	ParagraphTextItem	Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
setPoints(points)	ParagraphTextItem	Sets the number of points a gradeable item is worth.
setRequired(enabled)	ParagraphTextItem	Sets whether the respondent must answer the question.
setTitle(title)	ParagraphTextItem	Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem).
setValidation(validation)	ParagraphTextItem	Sets the data validation for this paragraph text item.

Detailed documentation

clearValidation()

Removes any data validation for this paragraph text item.

Return

ParagraphTextItem — this ParagraphTextItem, 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

---

createResponse(response)

Creates a new ItemResponse for this paragraph text item.

Parameters

Name	Type	Description
response	String	an 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 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

ParagraphTextItem — a duplicate of this ParagraphTextItem, 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

---

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

---

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()

Gets the item's type, represented as an ItemType.

Return

ItemType — the item's type

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

---

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

ParagraphTextItem — this ParagraphTextItem, 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

ParagraphTextItem — this ParagraphTextItem, 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

ParagraphTextItem — this ParagraphTextItem, 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

ParagraphTextItem — 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

ParagraphTextItem — this ParagraphTextItem, 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

---

setValidation(validation)

Sets the data validation for this paragraph text item. Passing in null or a ParagraphTextValidation instance on which no require functions have been called removes any prior validation.

Parameters

Name	Type	Description
validation	ParagraphTextValidation	a ParagraphTextValidation to apply to this item.

Return

ParagraphTextItem — this ParagraphTextItem, 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