Google Analytics Data V1alpha Client - Class CohortSpec (0.11.1)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class CohortSpec.

Specification of cohorts for a cohort report.

Cohort reports can be used for example to create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the cohort object. Following that cohort for the next six weeks is specified in the cohortsRange object. The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric cohortActiveUsers/cohortTotalUsers and will be separate rows in the report.

Generated from protobuf message google.analytics.data.v1alpha.CohortSpec

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ cohorts array<Google\Analytics\Data\V1alpha\Cohort>

Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.

↳ cohorts_range Google\Analytics\Data\V1alpha\CohortsRange

Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over.

↳ cohort_report_settings Google\Analytics\Data\V1alpha\CohortReportSettings

Optional settings for a cohort report.

getCohorts

Defines the selection criteria to group users into cohorts.

Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCohorts

Defines the selection criteria to group users into cohorts.

Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\Cohort>
Returns
TypeDescription
$this

getCohortsRange

Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over.

Returns
TypeDescription
Google\Analytics\Data\V1alpha\CohortsRange|null

hasCohortsRange

clearCohortsRange

setCohortsRange

Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over.

Parameter
NameDescription
var Google\Analytics\Data\V1alpha\CohortsRange
Returns
TypeDescription
$this

getCohortReportSettings

Optional settings for a cohort report.

Returns
TypeDescription
Google\Analytics\Data\V1alpha\CohortReportSettings|null

hasCohortReportSettings

clearCohortReportSettings

setCohortReportSettings

Optional settings for a cohort report.

Parameter
NameDescription
var Google\Analytics\Data\V1alpha\CohortReportSettings
Returns
TypeDescription
$this