ParagraphTextItem

A question item that allows the respondent to enter a block of text. Items can be accessed or
created from a `https://developers.google.com/apps-script/reference/forms/form`. When used in a quiz, these items are graded.

```javascript
// 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 |
|---|---|---|
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#clearValidation()` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | Removes any data validation for this paragraph text item. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#createResponse(String)` | `https://developers.google.com/apps-script/reference/forms/item-response` | Creates a new `https://developers.google.com/apps-script/reference/forms/item-response` for this paragraph text item. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#duplicate()` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | Creates a copy of this item and appends it to the end of the form. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#getGeneralFeedback()` | `https://developers.google.com/apps-script/reference/forms/quiz-feedback|null` | Returns the feedback that is shown to respondents when they respond to a gradeable question. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#getHelpText()` | `String` | Gets the item's help text (sometimes called description text for layout items like `https://developers.google.com/apps-script/reference/forms/image-item`, `https://developers.google.com/apps-script/reference/forms/page-break-item`, and `https://developers.google.com/apps-script/reference/forms/section-header-item`). |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#getId()` | `Integer` | Gets the item's unique identifier. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#getIndex()` | `Integer` | Gets the index of the item among all the items in the form. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#getPoints()` | `Integer` | Returns the point value of a gradeable item. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#getTitle()` | `String` | Gets the item's title (sometimes called header text, in the case of a `https://developers.google.com/apps-script/reference/forms/section-header-item`). |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#getType()` | `https://developers.google.com/apps-script/reference/forms/item-type` | Gets the item's type, represented as an `https://developers.google.com/apps-script/reference/forms/item-type`. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#isRequired()` | `Boolean` | Determines whether the respondent must answer the question. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#setGeneralFeedback(QuizFeedback)` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | 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). |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#setHelpText(String)` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | Sets the item's help text (sometimes called description text for layout items like `https://developers.google.com/apps-script/reference/forms/image-item`, `https://developers.google.com/apps-script/reference/forms/page-break-item`, and `https://developers.google.com/apps-script/reference/forms/section-header-item`). |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#setPoints(Integer)` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | Sets the number of points a gradeable item is worth. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#setRequired(Boolean)` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | Sets whether the respondent must answer the question. |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#setTitle(String)` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | Sets the item's title (sometimes called header text, in the case of a `https://developers.google.com/apps-script/reference/forms/section-header-item`). |
| `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#setValidation(ParagraphTextValidation)` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` | Sets the data validation for this paragraph text item. |

## Detailed documentation

### `clearValidation()`

Removes any data validation for this paragraph text item.

#### Return


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- this `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#`, for chaining

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/forms.currentonly`
- `https://www.googleapis.com/auth/forms`

*** ** * ** ***

### `createResponse(response)`

Creates a new `https://developers.google.com/apps-script/reference/forms/item-response` for this paragraph text item.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `response` | `String` | an answer to the question posed by the item |

#### Return


`https://developers.google.com/apps-script/reference/forms/item-response` --- the item response

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- a duplicate of this `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#`, for chaining

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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


`https://developers.google.com/apps-script/reference/forms/quiz-feedback|null` --- the feedback, if any.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/forms/image-item`, `https://developers.google.com/apps-script/reference/forms/page-break-item`, and `https://developers.google.com/apps-script/reference/forms/section-header-item`).

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/forms/section-header-item`).

#### 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://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/forms.currentonly`
- `https://www.googleapis.com/auth/forms`

*** ** * ** ***

### `getType()`

Gets the item's type, represented as an `https://developers.google.com/apps-script/reference/forms/item-type`.

#### Return


`https://developers.google.com/apps-script/reference/forms/item-type` --- the item's type

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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://developers.google.com/apps-script/concepts/scopes#setting_explicit_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` | `https://developers.google.com/apps-script/reference/forms/quiz-feedback` | the new feedback |

#### Return


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- this `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#`, for chaining

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/forms/image-item`, `https://developers.google.com/apps-script/reference/forms/page-break-item`, and `https://developers.google.com/apps-script/reference/forms/section-header-item`).

#### Parameters

| Name | Type | Description |
|---|---|---|
| `text` | `String` | the new help text |

#### Return


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- this `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#`, for chaining

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- this `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#`, for chaining

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- the current item (for chaining)

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/forms/section-header-item`).

#### Parameters

| Name | Type | Description |
|---|---|---|
| `title` | `String` | the new title or header text |

#### Return


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- this `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#`, for chaining

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_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 `https://developers.google.com/apps-script/reference/forms/paragraph-text-validation` instance on which no require functions have been called removes any
prior validation.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `validation` | `https://developers.google.com/apps-script/reference/forms/paragraph-text-validation` | a ParagraphTextValidation to apply to this item. |

#### Return


`https://developers.google.com/apps-script/reference/forms/paragraph-text-item#` --- this `https://developers.google.com/apps-script/reference/forms/paragraph-text-item#`, for chaining

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/forms.currentonly`
- `https://www.googleapis.com/auth/forms`