Class DateField
Page Summary
DateField is a deprecated class used only by the Contacts service to represent a date field in a Contact.
Instead of DateField, the People API advanced service should be used.
Dates in App Script outside the Contacts service use JavaScript's standard Date object.
The DateField class has methods to get and set its label.
Most methods of the DateField class are deprecated, including those for getting and setting the day, month, and year, and for deleting the date field.
Deprecated. Instead, use thePeople API advanced service
A date field in a Contact.
This class is only used by the Contacts service, and dates used elsewhere in App Script useJavaScript's standardDate object.
Methods
| Method | Return type | Brief description |
|---|---|---|
get | Object | Gets the label for this field. |
set | | Sets the label of this field. |
Deprecated methods
| Method | Return type | Brief description |
|---|---|---|
| void | Deletes this date. |
| Integer | Gets the day of the month for this date. |
| Month | Gets the month for this date. |
| Integer | Gets the year for this date. |
| | Sets the date to this day, without a year. |
| | Sets the date to this day. |
| | Sets the label of this field, such as 'Birthday' or 'Anniversary'. |
Detailed documentation
getLabel()
Gets the label for this field. This may be a Field, ExtendedField, or a String.
// Logs the label for all the address fields associated with contact// 'John Doe'. This method can be similarly called for any field that has// a label.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();for(leti=0;i <addressFields.length;i++){Logger.log(addressFields[i].getLabel());}
Return
Object — the label for this field
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
setLabel(label)
Sets the label of this field.
// Sets the label to 'Apartment' for the first address field associated// with contact 'John Doe'. This method can be similarly called for any// field that has a label.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();addressFields[0].setLabel('Apartment');
Parameters
| Name | Type | Description |
|---|---|---|
label | String | the new label for this field |
Return
Date
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
Deprecated methods
deleteDateField()
deleteDateField() Deprecated. This function is deprecated and should not be used in new scripts.
Deletes this date.
// Deletes all the dates that are set for contact 'John Doe'constcontacts=ContactsApp.getContactsByName('John Doe');constdates=contacts[0].getDates();for(leti=0;i <dates.length;i++){dates[i].deleteDateField();}
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
getDay()
getDay() Deprecated. This function is deprecated and should not be used in new scripts.
Gets the day of the month for this date.
Note: For standard JavaScript Date objects theget method returns the day of the week instead.
// Logs the day of the birthday for contact 'John Doe'constcontacts=ContactsApp.getContactsByName('John Doe');constbirthday=contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];Logger.log(birthday.getDay());
Return
Integer — the day of the month
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
getMonth()
getMonth() Deprecated. This function is deprecated and should not be used in new scripts.
Gets the month for this date.
// Logs the month of the birthday for contact 'John Doe'constcontacts=ContactsApp.getContactsByName('John Doe');constbirthday=contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];Logger.log(birthday.getMonth());
Return
Month — the month
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
getYear()
getYear() Deprecated. This function is deprecated and should not be used in new scripts.
Gets the year for this date.
// Logs the year of the birthday for contact 'John Doe'constcontacts=ContactsApp.getContactsByName('John Doe');constbirthday=contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];Logger.log(birthday.getYear());
Return
Integer — the year
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
setDate(month, day)
setDate(month, day) Deprecated. This function is deprecated and should not be used in new scripts.
Sets the date to this day, without a year.
This method only applies to date fields that don't require a year, such as birthdays.
// Sets the birthday for contact 'John Doe' to April 1constcontacts=ContactsApp.getContactsByName('John Doe');constbirthday=contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];birthday.setDate(ContactsApp.Month.APRIL,1);
Parameters
| Name | Type | Description |
|---|---|---|
month | Month | the month |
day | Integer | the day |
Return
Date
Throws
Error — if this date field requires a year
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
setDate(month, day, year)
setDate(month, day, year) Deprecated. This function is deprecated and should not be used in new scripts.
Sets the date to this day.
// Sets the birthday for contact 'John Doe' to April 1, 1980constcontacts=ContactsApp.getContactsByName('John Doe');constbirthday=contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];birthday.setDate(ContactsApp.Month.APRIL,1,1980);
Parameters
| Name | Type | Description |
|---|---|---|
month | Month | the month |
day | Integer | the day |
year | Integer | the year |
Return
Date
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
setLabel(label)
setLabel(label) Deprecated. This function is deprecated and should not be used in new scripts.
Sets the label of this field, such as 'Birthday' or 'Anniversary'.
// Retrieves the first date that's set for contact 'John Doe' and re-labels// it as an anniversaryconstcontacts=ContactsApp.getContactsByName('John Doe');constfirstDate=contacts[0].getDates()[0];firstDate.setLabel(ContactsApp.Field.ANNIVERSARY);
Parameters
| Name | Type | Description |
|---|---|---|
label | | the new standard label |
Return
Date
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.google.com/m8/feeds
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.