Reference documentation and code samples for the Google Analytics Data V1alpha Client class CohortsRange.
Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.
Generated from protobuf message google.analytics.data.v1alpha.CohortsRange
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ granularity |
int
The granularity used to interpret the |
↳ start_offset |
int
|
↳ end_offset |
int
|
getGranularity
The granularity used to interpret the startOffset and endOffset for the
extended reporting date range for a cohort report.
| Returns | |
|---|---|
| Type | Description |
int | |
setGranularity
The granularity used to interpret the startOffset and endOffset for the
extended reporting date range for a cohort report.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartOffset
startOffset specifies the start date of the extended reporting date range
for a cohort report. startOffset is commonly set to 0 so that reports
contain data from the acquisition of the cohort forward.
If granularity is DAILY, the startDate of the extended reporting date
range is startDate of the cohort plus startOffset days.
If granularity is WEEKLY, the startDate of the extended reporting
date range is startDate of the cohort plus startOffset * 7 days.
If granularity is MONTHLY, the startDate of the extended reporting
date range is startDate of the cohort plus startOffset * 30 days.
| Returns | |
|---|---|
| Type | Description |
int | |
setStartOffset
startOffset specifies the start date of the extended reporting date range
for a cohort report. startOffset is commonly set to 0 so that reports
contain data from the acquisition of the cohort forward.
If granularity is DAILY, the startDate of the extended reporting date
range is startDate of the cohort plus startOffset days.
If granularity is WEEKLY, the startDate of the extended reporting
date range is startDate of the cohort plus startOffset * 7 days.
If granularity is MONTHLY, the startDate of the extended reporting
date range is startDate of the cohort plus startOffset * 30 days.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndOffset
endOffset specifies the end date of the extended reporting date range
for a cohort report. endOffset can be any positive integer but is
commonly set to 5 to 10 so that reports contain data on the cohort for the
next several granularity time periods.
If granularity is DAILY, the endDate of the extended reporting date
range is endDate of the cohort plus endOffset days.
If granularity is WEEKLY, the endDate of the extended reporting date
range is endDate of the cohort plus endOffset * 7 days.
If granularity is MONTHLY, the endDate of the extended reporting date
range is endDate of the cohort plus endOffset * 30 days.
| Returns | |
|---|---|
| Type | Description |
int | |
setEndOffset
endOffset specifies the end date of the extended reporting date range
for a cohort report. endOffset can be any positive integer but is
commonly set to 5 to 10 so that reports contain data on the cohort for the
next several granularity time periods.
If granularity is DAILY, the endDate of the extended reporting date
range is endDate of the cohort plus endOffset days.
If granularity is WEEKLY, the endDate of the extended reporting date
range is endDate of the cohort plus endOffset * 7 days.
If granularity is MONTHLY, the endDate of the extended reporting date
range is endDate of the cohort plus endOffset * 30 days.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |