Class DateItem

    • DateItem allows respondents to indicate a date and can be accessed or created from a Form.

    • DateItem objects can be duplicated, and their help text, ID, index, points, and title can be retrieved.

    • The DateItem includes methods to check if a year is included, if the question is required, and to set general feedback, help text, year inclusion, points, required status, and title.

    • The createResponse(response) method generates an ItemResponse for the DateItem, using the date information from a provided Date object while ignoring time fields.
    Date Item

    A question item that allows the respondent to indicate a date. 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 item. 
 const 
  
 form 
  
 = 
  
 FormApp 
 . 
 openById 
 ( 
 '1234567890abcdefghijklmnopqrstuvwxyz' 
 ); 
 const 
  
 item 
  
 = 
  
 form 
 . 
 addDateItem 
 (); 
 item 
 . 
 setTitle 
 ( 
 'When were you born?' 
 );

    Methods

    Method Return type Brief description
    create Response(response)
    		Item Response Creates a new Item Response for this date item.
    duplicate()
    		Date Item Creates a copy of this item and appends it to the end of the form.
    get General Feedback()
    		Quiz Feedback Returns the feedback that is shown to respondents when they respond to a gradeable question.
    get Help Text()
    		String Gets the item's help text (sometimes called description text for layout items like Image Items , Page Break Items , and Section Header Items ).
    get Id()
    		Integer Gets the item's unique identifier.
    get Index()
    		Integer Gets the index of the item among all the items in the form.
    get Points()
    		Integer Returns the point value of a gradeable item.
    get Title()
    		String Gets the item's title (sometimes called header text, in the case of a Section Header Item ).
    get Type()
    		Item Type Gets the item's type, represented as an Item Type .
    includes Year()
    		Boolean Determines whether the date item includes a year option.
    is Required()
    		Boolean Determines whether the respondent must answer the question.
    set General Feedback(feedback)
    		Date 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).
    set Help Text(text)
    		Date Item Sets the item's help text (sometimes called description text for layout items like Image Items , Page Break Items , and Section Header Items ).
    set Includes Year(enableYear)
    		Date Item Sets whether the date item includes a year setting.
    set Points(points)
    		Date Item Sets the number of points a gradeable item is worth.
    set Required(enabled)
    		Date Item Sets whether the respondent must answer the question.
    set Title(title)
    		Date Item Sets the item's title (sometimes called header text, in the case of a Section Header Item ).

    Detailed documentation

    create Response(response)

    Creates a new Item Response for this date item. The time fields of the Date object are ignored; by default, only the year, month, and day fields are used. If set Includes Year(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, and possibly year

    Return

    Item Response — 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

    Date Item — a duplicate of this Date 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

    get General Feedback()

    Returns the feedback that is shown to respondents when they respond to a gradeable question.

    Return

    Quiz Feedback — 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

    get Help Text()

    Gets the item's help text (sometimes called description text for layout items like Image Items , Page Break Items , and Section Header Items ).

    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

    get Id()

    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

    get Index()

    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

    get Points()

    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

    get Title()

    Gets the item's title (sometimes called header text, in the case of a 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://www.googleapis.com/auth/forms.currentonly
    • https://www.googleapis.com/auth/forms

    get Type()

    Gets the item's type, represented as an Item Type .

    Return

    Item Type — 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

    includes Year()

    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

    is Required()

    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

    set General Feedback(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
    		Quiz Feedback the new feedback

    Return

    Date Item — this Date 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

    set Help Text(text)

    Sets the item's help text (sometimes called description text for layout items like Image Items , Page Break Items , and Section Header Items ).

    Parameters

    Name Type Description
    text
    		String the new help text

    Return

    Date Item — this Date 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

    set Includes Year(enableYear)

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

    Parameters

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

    Return

    Date Item — this Date 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

    set Points(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

    Date Item — this Date 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

    set Required(enabled)

    Sets whether the respondent must answer the question.

    Parameters

    Name Type Description
    enabled
    		Boolean whether the respondent must answer the question

    Return

    Date Item — 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

    set Title(title)

    Sets the item's title (sometimes called header text, in the case of a Section Header Item ).

    Parameters

    Name Type Description
    title
    		String the new title or header text

    Return

    Date Item — this Date 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
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: