Class DateTimeItem

AI-generated Key Takeaways

• DateTimeItem is a question type in Google Forms that allows respondents to input a specific date and time.

• This item can be utilized within quizzes and graded accordingly, offering flexibility for various assessment scenarios.

• Developers can manipulate DateTimeItems programmatically using Apps Script, enabling customization and automation of form functionalities.

• Through Apps Script, DateTimeItems provide methods for setting titles, help text, points (for quizzes), and making the question required or optional, along with functionalities to duplicate the items and control responses.

• It allows for the customization of the date format by including or excluding the year input and provides options for setting general feedback for quiz scenarios.

DateTimeItem

A question item that allows the respondent to indicate a date and 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 date-time item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addDateTimeItem();
item.setTitle('When do you want to meet?');

Methods

Method	Return type	Brief description
createResponse(response)	ItemResponse	Creates a new ItemResponse for this date-time item.
duplicate()	DateTimeItem	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.
includesYear()	Boolean	Determines whether the date item includes a year option.
isRequired()	Boolean	Determines whether the respondent must answer the question.
setGeneralFeedback(feedback)	DateTimeItem	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)	DateTimeItem	Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
setIncludesYear(enableYear)	DateTimeItem	Sets whether the date item includes a year setting.
setPoints(points)	DateTimeItem	Sets the number of points a gradeable item is worth.
setRequired(enabled)	DateTimeItem	Sets whether the respondent must answer the question.
setTitle(title)	DateTimeItem	Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Detailed documentation

createResponse(response)

Creates a new ItemResponse for this date-time item. The seconds field of the Date object is ignored; by default, the year, month, day, hour, and minute fields are used. If setIncludesYear(enabled) is set to false, the year is ignored as well.

Parameters

Name	Type	Description
response	Date	a Date object that represents a month, day, hour, minute, and possibly year

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

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

---

includesYear()

Determines whether the date item includes a year option.

Return

Boolean — true if the date includes a year setting; false if not

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

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

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

---

setIncludesYear(enableYear)

Sets whether the date item includes a year setting. The default for new date items is true.

Parameters

Name	Type	Description
enableYear	Boolean	true if the date includes a year setting; false if not

Return

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

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

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

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