Reference documentation and code samples for the Google Analytics Data V1alpha Client class DateRange.
A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.
Generated from protobuf message google.analytics.data.v1alpha.DateRange
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_date |
string
The inclusive start date for the query in the format |
↳ end_date |
string
The inclusive end date for the query in the format |
↳ name |
string
Assigns a name to this date range. The dimension |
getStartDate
The inclusive start date for the query in the format YYYY-MM-DD
. Cannot
be after end_date
. The format NdaysAgo
, yesterday
, or today
is also
accepted, and in that case, the date is inferred based on the property's
reporting time zone.
Returns | |
---|---|
Type | Description |
string |
setStartDate
The inclusive start date for the query in the format YYYY-MM-DD
. Cannot
be after end_date
. The format NdaysAgo
, yesterday
, or today
is also
accepted, and in that case, the date is inferred based on the property's
reporting time zone.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getEndDate
The inclusive end date for the query in the format YYYY-MM-DD
. Cannot
be before start_date
. The format NdaysAgo
, yesterday
, or today
is
also accepted, and in that case, the date is inferred based on the
property's reporting time zone.
Returns | |
---|---|
Type | Description |
string |
setEndDate
The inclusive end date for the query in the format YYYY-MM-DD
. Cannot
be before start_date
. The format NdaysAgo
, yesterday
, or today
is
also accepted, and in that case, the date is inferred based on the
property's reporting time zone.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getName
Assigns a name to this date range. The dimension dateRange
is valued to
this name in a report response. If set, cannot begin with date_range_
or
RESERVED_
. If not set, date ranges are named by their zero based index in
the request: date_range_0
, date_range_1
, etc.
Returns | |
---|---|
Type | Description |
string |
setName
Assigns a name to this date range. The dimension dateRange
is valued to
this name in a report response. If set, cannot begin with date_range_
or
RESERVED_
. If not set, date ranges are named by their zero based index in
the request: date_range_0
, date_range_1
, etc.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |