Reference documentation and code samples for the Google API Common Protos Client class DateTime.
Represents civil time (or occasionally physical time).
This type can represent a civil time in one of a few possible ways:
When utc_offset is set and time_zone is unset: a civil time on a calendar
day with a particular offset from UTC.
When time_zone is set and utc_offset is unset: a civil time on a calendar
day in a particular time zone.
When neither time_zone nor utc_offset is set: a civil time on a calendar
day in local time.
The date is relative to the Proleptic Gregorian Calendar.
If year is 0, the DateTime is considered not to have a specific year. month
and day must have valid, non-zero values.
This type may also be used to represent a physical time if all the date and
time fields are set and either case of thetime_offsetoneof is set.
Consider usingTimestampmessage for physical time instead. If your use
case also would like to store the user's timezone, that can be done in
another field.
This type is more flexible than some applications may want. Make sure to
document and validate your application's limitations.
Generated from protobuf messagegoogle.type.DateTime
Namespace
Google \ Type
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ year
int
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
↳ month
int
Required. Month of year. Must be from 1 to 12.
↳ day
int
Required. Day of month. Must be from 1 to 31 and valid for the year and month.
↳ hours
int
Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
↳ minutes
int
Required. Minutes of hour of day. Must be from 0 to 59.
↳ seconds
int
Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
↳ nanos
int
Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
datetime without a year.
Returns
Type
Description
int
setYear
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
datetime without a year.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMonth
Required. Month of year. Must be from 1 to 12.
Returns
Type
Description
int
setMonth
Required. Month of year. Must be from 1 to 12.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getDay
Required. Day of month. Must be from 1 to 31 and valid for the year and
month.
Returns
Type
Description
int
setDay
Required. Day of month. Must be from 1 to 31 and valid for the year and
month.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getHours
Required. Hours of day in 24 hour format. Should be from 0 to 23. An API
may choose to allow the value "24:00:00" for scenarios like business
closing time.
Returns
Type
Description
int
setHours
Required. Hours of day in 24 hour format. Should be from 0 to 23. An API
may choose to allow the value "24:00:00" for scenarios like business
closing time.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMinutes
Required. Minutes of hour of day. Must be from 0 to 59.
Returns
Type
Description
int
setMinutes
Required. Minutes of hour of day. Must be from 0 to 59.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getSeconds
Required. Seconds of minutes of the time. Must normally be from 0 to 59. An
API may allow the value 60 if it allows leap-seconds.
Returns
Type
Description
int
setSeconds
Required. Seconds of minutes of the time. Must normally be from 0 to 59. An
API may allow the value 60 if it allows leap-seconds.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getNanos
Required. Fractions of seconds in nanoseconds. Must be from 0 to
999,999,999.
Returns
Type
Description
int
setNanos
Required. Fractions of seconds in nanoseconds. Must be from 0 to
999,999,999.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getUtcOffset
UTC offset. Must be whole seconds, between -18 hours and +18 hours.
For example, a UTC offset of -4:00 would be represented as
{ seconds: -14400 }.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class DateTime (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Type.DateTime)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Type.DateTime)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Type.DateTime)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Type.DateTime)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Type.DateTime)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Type.DateTime) \nReference documentation and code samples for the Google API Common Protos Client class DateTime.\n\nRepresents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n- When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.\n- When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone.\n- When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.\n\nGenerated from protobuf message `google.type.DateTime`\n\nNamespace\n---------\n\nGoogle \\\\ Type\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getYear\n\nOptional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year.\n\n### setYear\n\nOptional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year.\n\n### getMonth\n\nRequired. Month of year. Must be from 1 to 12.\n\n### setMonth\n\nRequired. Month of year. Must be from 1 to 12.\n\n### getDay\n\nRequired. Day of month. Must be from 1 to 31 and valid for the year and\nmonth.\n\n### setDay\n\nRequired. Day of month. Must be from 1 to 31 and valid for the year and\nmonth.\n\n### getHours\n\nRequired. Hours of day in 24 hour format. Should be from 0 to 23. An API\nmay choose to allow the value \"24:00:00\" for scenarios like business\nclosing time.\n\n### setHours\n\nRequired. Hours of day in 24 hour format. Should be from 0 to 23. An API\nmay choose to allow the value \"24:00:00\" for scenarios like business\nclosing time.\n\n### getMinutes\n\nRequired. Minutes of hour of day. Must be from 0 to 59.\n\n### setMinutes\n\nRequired. Minutes of hour of day. Must be from 0 to 59.\n\n### getSeconds\n\nRequired. Seconds of minutes of the time. Must normally be from 0 to 59. An\nAPI may allow the value 60 if it allows leap-seconds.\n\n### setSeconds\n\nRequired. Seconds of minutes of the time. Must normally be from 0 to 59. An\nAPI may allow the value 60 if it allows leap-seconds.\n\n### getNanos\n\nRequired. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999.\n\n### setNanos\n\nRequired. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999.\n\n### getUtcOffset\n\nUTC offset. Must be whole seconds, between -18 hours and +18 hours.\n\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }.\n\n### hasUtcOffset\n\n### setUtcOffset\n\nUTC offset. Must be whole seconds, between -18 hours and +18 hours.\n\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }.\n\n### getTimeZone\n\nTime zone.\n\n### hasTimeZone\n\n### setTimeZone\n\nTime zone.\n\n### getTimeOffset"]]
