com.google.api.services.analyticsdata.v1beta.model

Class CohortSpec

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsdata.v1beta.model.CohortSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CohortSpec
extends com.google.api.client.json.GenericJson

The specification of cohorts for a cohort report. Cohort reports 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. For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/adva nced#cohort_report_examples). 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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Analytics Data API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CohortSpec()

Method Summary

Modifier and Type	Method and Description
CohortSpec	clone()
CohortReportSettings	getCohortReportSettings() Optional settings for a cohort report.
List<Cohort>	getCohorts() Defines the selection criteria to group users into cohorts.
CohortsRange	getCohortsRange() Cohort reports follow cohorts over an extended reporting date range.
CohortSpec	set(String fieldName, Object value)
CohortSpec	setCohortReportSettings(CohortReportSettings cohortReportSettings) Optional settings for a cohort report.
CohortSpec	setCohorts(List<Cohort> cohorts) Defines the selection criteria to group users into cohorts.
CohortSpec	setCohortsRange(CohortsRange cohortsRange) Cohort reports follow cohorts over an extended reporting date range.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CohortSpec

public CohortSpec()

Method Detail

getCohortReportSettings

public CohortReportSettings getCohortReportSettings()

Optional settings for a cohort report.

Returns:

value or null for none

setCohortReportSettings

public CohortSpec setCohortReportSettings(CohortReportSettings cohortReportSettings)

Optional settings for a cohort report.

Parameters:

cohortReportSettings - cohortReportSettings or null for none

getCohorts

public List<Cohort> 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:

value or null for none

setCohorts

public CohortSpec setCohorts(List<Cohort> cohorts)

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.

Parameters:

cohorts - cohorts or null for none

getCohortsRange

public CohortsRange getCohortsRange()

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

Returns:

value or null for none

setCohortsRange

public CohortSpec setCohortsRange(CohortsRange cohortsRange)

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

Parameters:

cohortsRange - cohortsRange or null for none

set

public CohortSpec set(String fieldName,
                      Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CohortSpec clone()

Overrides:

clone in class com.google.api.client.json.GenericJson