Reference documentation and code samples for the Google Analytics Data V1beta 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.v1beta.CohortsRange
Namespace
Google \ Analytics \ Data \ V1beta
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ granularity
int
Required. The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report.
↳ start_offset
int
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.
↳ end_offset
int
Required. 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.
getGranularity
Required. The granularity used to interpret the startOffset and
endOffset for the extended reporting date range for a cohort report.
Returns
Type
Description
int
setGranularity
Required. 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
Required. 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
Required. 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.
[[["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 Analytics Data V1beta Client - Class CohortsRange (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1beta.CohortsRange)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1beta.CohortsRange)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1beta.CohortsRange)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1beta.CohortsRange)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1beta.CohortsRange)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1beta.CohortsRange)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1beta.CohortsRange)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1beta.CohortsRange)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1beta.CohortsRange)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1beta.CohortsRange)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1beta.CohortsRange)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1beta.CohortsRange)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1beta.CohortsRange)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1beta.CohortsRange) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1beta Client class CohortsRange.\n\nConfigures the extended reporting date range for a cohort report. Specifies\nan offset duration to follow the cohorts over.\n\nGenerated from protobuf message `google.analytics.data.v1beta.CohortsRange`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getGranularity\n\nRequired. The granularity used to interpret the `startOffset` and\n`endOffset` for the extended reporting date range for a cohort report.\n\n### setGranularity\n\nRequired. The granularity used to interpret the `startOffset` and\n`endOffset` for the extended reporting date range for a cohort report.\n\n### getStartOffset\n\n`startOffset` specifies the start date of the extended reporting date range\nfor a cohort report. `startOffset` is commonly set to 0 so that reports\ncontain data from the acquisition of the cohort forward.\n\nIf `granularity` is `DAILY`, the `startDate` of the extended reporting date\nrange is `startDate` of the cohort plus `startOffset` days.\nIf `granularity` is `WEEKLY`, the `startDate` of the extended reporting\ndate range is `startDate` of the cohort plus `startOffset * 7` days.\nIf `granularity` is `MONTHLY`, the `startDate` of the extended reporting\ndate range is `startDate` of the cohort plus `startOffset * 30` days.\n\n### setStartOffset\n\n`startOffset` specifies the start date of the extended reporting date range\nfor a cohort report. `startOffset` is commonly set to 0 so that reports\ncontain data from the acquisition of the cohort forward.\n\nIf `granularity` is `DAILY`, the `startDate` of the extended reporting date\nrange is `startDate` of the cohort plus `startOffset` days.\nIf `granularity` is `WEEKLY`, the `startDate` of the extended reporting\ndate range is `startDate` of the cohort plus `startOffset * 7` days.\nIf `granularity` is `MONTHLY`, the `startDate` of the extended reporting\ndate range is `startDate` of the cohort plus `startOffset * 30` days.\n\n### getEndOffset\n\nRequired. `endOffset` specifies the end date of the extended reporting date\nrange for a cohort report. `endOffset` can be any positive integer but is\ncommonly set to 5 to 10 so that reports contain data on the cohort for the\nnext several granularity time periods.\n\nIf `granularity` is `DAILY`, the `endDate` of the extended reporting date\nrange is `endDate` of the cohort plus `endOffset` days.\nIf `granularity` is `WEEKLY`, the `endDate` of the extended reporting date\nrange is `endDate` of the cohort plus `endOffset * 7` days.\nIf `granularity` is `MONTHLY`, the `endDate` of the extended reporting date\nrange is `endDate` of the cohort plus `endOffset * 30` days.\n\n### setEndOffset\n\nRequired. `endOffset` specifies the end date of the extended reporting date\nrange for a cohort report. `endOffset` can be any positive integer but is\ncommonly set to 5 to 10 so that reports contain data on the cohort for the\nnext several granularity time periods.\n\nIf `granularity` is `DAILY`, the `endDate` of the extended reporting date\nrange is `endDate` of the cohort plus `endOffset` days.\nIf `granularity` is `WEEKLY`, the `endDate` of the extended reporting date\nrange is `endDate` of the cohort plus `endOffset * 7` days.\nIf `granularity` is `MONTHLY`, the `endDate` of the extended reporting date\nrange is `endDate` of the cohort plus `endOffset * 30` days."]]
