A question item that allows the respondent to indicate a length of time. 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 duration item. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); var item = form.addDurationItem(); item.setTitle('How long can you hold your breath?');
Methods
Method | Return type | Brief description |
---|---|---|
ItemResponse
|
Creates a new ItemResponse
for this date item. |
|
DurationItem
|
Creates a copy of this item and appends it to the end of the form. | |
QuizFeedback
|
Returns the feedback that is shown to respondents when they respond to a gradeable question. | |
String
|
Gets the item's help text (sometimes called description text for layout items like ImageItems
, PageBreakItems
, and SectionHeaderItems
). |
|
Integer
|
Gets the item's unique identifier. | |
Integer
|
Gets the index of the item among all the items in the form. | |
Integer
|
Returns the point value of a gradeable item. | |
String
|
Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem
). |
|
ItemType
|
Gets the item's type, represented as an ItemType
. |
|
Boolean
|
Determines whether the respondent must answer the question. | |
DurationItem
|
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). | |
DurationItem
|
Sets the item's help text (sometimes called description text for layout items like ImageItems
, PageBreakItems
, and SectionHeaderItems
). |
|
DurationItem
|
Sets the number of points a gradeable item is worth. | |
DurationItem
|
Sets whether the respondent must answer the question. | |
DurationItem
|
Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem
). |
Detailed documentation
createResponse(hours, minutes, seconds)
Creates a new ItemResponse
for this date item. The arguments hours
, minutes
, and seconds
are best represented as integers from 0
to 72
for hours
and 0
to 59
for minutes
and seconds
. Values that
exceed those bounds are clamped: for example, 24, 60, 90
is interpreted as 24:59:59.
Parameters
Name | Type | Description |
---|---|---|
hours
|
Integer
|
the hours, represented as an integer from 0
to 72
|
minutes
|
Integer
|
the minutes, represented as an integer from 0
to 59
|
seconds
|
Integer
|
the seconds, represented as an integer from 0
to 59
|
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
DurationItem
— a duplicate of this DurationItem
, 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()
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
DurationItem
— this DurationItem
, 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
DurationItem
— this DurationItem
, 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
DurationItem
— this DurationItem
, 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
DurationItem
— 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
DurationItem
— this DurationItem
, 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