Class DatePicker
Stay organized with collections
Save and categorize content based on your preferences.
DatePicker
An input field that allows inputing a date.
Available for Google Workspace add-ons and Google Chat apps.
const dateTimePicker =
CardService.newDatePicker()
.setTitle('Enter the date.')
.setFieldName('date_field')
// Set default value as Jan 1, 2018 UTC. Either a number or string is
// acceptable.
.setValueInMsSinceEpoch(1514775600)
.setOnChangeAction(
CardService.newAction().setFunctionName('handleDateTimeChange'),
);
Detailed documentation
setFieldName(fieldName)
Sets the field name that identifies this picker in the event object that is generated when
there is a UI interaction. The field name is visible to the user. Required; the specified field
name must be unique.
Parameters
| Name | Type | Description |
fieldName | String | The name to assign to this input. |
Return
DatePicker — This picker, for chaining.
setOnChangeAction(action)
Sets an Action that the script performs whenever the picker input changes.
Parameters
| Name | Type | Description |
action | Action | The action to take. |
Return
DatePicker — This picker, for chaining.
setTitle(title)
Sets the title displayed above the input field.
Parameters
| Name | Type | Description |
title | String | The input field title. |
Return
DatePicker — This picker, for chaining.
setValueInMsSinceEpoch(valueMsEpoch)
Sets the prefilled value to be set in the input field.
Parameters
| Name | Type | Description |
valueMsEpoch | Number | The default value placed in the input as a number, in milliseconds since
the epoch. Only the date of the epoch time is used, and the time of the epoch time is
discarded. It is always represented as a string in the form callback parameters. |
Return
DatePicker — This picker, for chaining.
setValueInMsSinceEpoch(valueMsEpoch)
Sets the prefilled value to be set in the input field.
Parameters
| Name | Type | Description |
valueMsEpoch | String | The default value placed in the input as a string, in milliseconds since
the epoch. Only the date of the epoch time is used, and the time of the epoch time is
discarded. It is always represented as a string in the form callback parameters. |
Return
DatePicker — This picker, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-30 UTC.
[null,null,["Last updated 2025-01-30 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eDatePicker\u003c/code\u003e is an input field allowing users to select a date, available for use in Google Workspace Add-ons and Google Chat apps.\u003c/p\u003e\n"],["\u003cp\u003eIt offers methods to set a field name for event handling, trigger actions on input changes, provide a title for clarity, and pre-fill a default date value.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esetValueInMsSinceEpoch\u003c/code\u003e method accepts either a number or a string representing milliseconds since the epoch to set the default date.\u003c/p\u003e\n"],["\u003cp\u003eAll configuration methods for the \u003ccode\u003eDatePicker\u003c/code\u003e are chainable, allowing for concise and readable code when setting multiple properties.\u003c/p\u003e\n"]]],["The `DatePicker` component, available for Google Workspace add-ons and Google Chat apps, creates a date input field. Key actions include setting the `fieldName` to identify the picker in UI interactions, defining an `onChangeAction` for script execution upon input changes, and setting a `title` for the field. You can also set a default `valueInMsSinceEpoch` as a number or string. Each method returns the `DatePicker` object, enabling method chaining.\n"],null,["# Class DatePicker\n\nDatePicker\n\nAn input field that allows inputing a date.\n\nAvailable for Google Workspace add-ons and Google Chat apps.\n\n```javascript\nconst dateTimePicker =\n CardService.newDatePicker()\n .setTitle('Enter the date.')\n .setFieldName('date_field')\n // Set default value as Jan 1, 2018 UTC. Either a number or string is\n // acceptable.\n .setValueInMsSinceEpoch(1514775600)\n .setOnChangeAction(\n CardService.newAction().setFunctionName('handleDateTimeChange'),\n );\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------|\n| [setFieldName(fieldName)](#setFieldName(String)) | [DatePicker](#) | Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction. |\n| [setOnChangeAction(action)](#setOnChangeAction(Action)) | [DatePicker](#) | Sets an [Action](/apps-script/reference/card-service/action) that the script performs whenever the picker input changes. |\n| [setTitle(title)](#setTitle(String)) | [DatePicker](#) | Sets the title displayed above the input field. |\n| [setValueInMsSinceEpoch(valueMsEpoch)](#setValueInMsSinceEpoch(Number)) | [DatePicker](#) | Sets the prefilled value to be set in the input field. |\n| [setValueInMsSinceEpoch(valueMsEpoch)](#setValueInMsSinceEpoch(String)) | [DatePicker](#) | Sets the prefilled value to be set in the input field. |\n\nDetailed documentation\n----------------------\n\n### `set``Field``Name(fieldName)`\n\nSets the field name that identifies this picker in the event object that is generated when\nthere is a UI interaction. The field name is visible to the user. Required; the specified field\nname must be unique.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|----------|-----------------------------------|\n| `field``Name` | `String` | The name to assign to this input. |\n\n#### Return\n\n\n[DatePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``On``Change``Action(action)`\n\nSets an [Action](/apps-script/reference/card-service/action) that the script performs whenever the picker input changes.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|------------------------------------------------------|---------------------|\n| `action` | [Action](/apps-script/reference/card-service/action) | The action to take. |\n\n#### Return\n\n\n[DatePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``Title(title)`\n\nSets the title displayed above the input field.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|------------------------|\n| `title` | `String` | The input field title. |\n\n#### Return\n\n\n[DatePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``Value``In``Ms``Since``Epoch(valueMsEpoch)`\n\nSets the prefilled value to be set in the input field.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `value``Ms``Epoch` | `Number` | The default value placed in the input as a number, in milliseconds since the epoch. Only the date of the epoch time is used, and the time of the epoch time is discarded. It is always represented as a string in the form callback parameters. |\n\n#### Return\n\n\n[DatePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``Value``In``Ms``Since``Epoch(valueMsEpoch)`\n\nSets the prefilled value to be set in the input field.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `value``Ms``Epoch` | `String` | The default value placed in the input as a string, in milliseconds since the epoch. Only the date of the epoch time is used, and the time of the epoch time is discarded. It is always represented as a string in the form callback parameters. |\n\n#### Return\n\n\n[DatePicker](#) --- This picker, for chaining."]]
