Class TimeItem

  • TimeItem allows respondents to indicate a time of day in a form.

  • TimeItem can be accessed or created from a Form and is graded when used in a quiz.

  • Various methods are available for TimeItem, including creating responses, duplicating the item, and getting or setting properties like feedback, help text, ID, index, points, title, required status, and type.

  • Methods likecreateResponse,duplicate,getGeneralFeedback,getHelpText,getId,getIndex,getPoints,getTitle,getType,isRequired,setGeneralFeedback,setHelpText,setPoints,setRequired, andsetTitle provide functionality for interacting with a TimeItem programmatically.

TimeItem

A question item that allows the respondent to indicate a time of day. Items can be accessed orcreated from aForm. When used in a quiz, these items are graded.

// Open a form by ID and add a new time item.constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');constitem=form.addTimeItem();item.setTitle('What time do you usually wake up in the morning?');

Methods

MethodReturn typeBrief description
createResponse(hour, minute)ItemResponseCreates a newItemResponse for this time item.
duplicate()TimeItemCreates 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)TimeItemSets 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)TimeItemSets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).
setPoints(points)TimeItemSets the number of points a gradeable item is worth.
setRequired(enabled)TimeItemSets whether the respondent must answer the question.
setTitle(title)TimeItemSets the item's title (sometimes called header text, in the case of aSectionHeaderItem).

Detailed documentation

createResponse(hour, minute)

Creates a newItemResponse for this time item. The argumentshour andminute are best represented as integers from0 to23 and from0 to59, respectively. If they exceed those bounds, they behave as a clock would: forexample,10, 90 is interpreted as 11:30, and-1, 60 is interpreted as 00:00.

Parameters

NameTypeDescription
hourIntegerthe hour, represented as an integer from0 to23
minuteIntegerthe minute of the hour, represented as an integer from0 to59

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

TimeItem — a duplicate of thisTimeItem, 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

TimeItem — thisTimeItem, 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

TimeItem — thisTimeItem, 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

TimeItem — thisTimeItem, 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

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

TimeItem — thisTimeItem, 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.