com.google.api.services.analyticsreporting.v4.model

Class Cohort

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsreporting.v4.model.Cohort

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.

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 Reporting 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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Cohort()

Method Summary

Methods

Modifier and Type	Method and Description
Cohort	clone()
DateRange	getDateRange() This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange.
java.lang.String	getName() A unique name for the cohort.
java.lang.String	getType() Type of the cohort.
Cohort	set(java.lang.String fieldName, java.lang.Object value)
Cohort	setDateRange(DateRange dateRange) This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange.
Cohort	setName(java.lang.String name) A unique name for the cohort.
Cohort	setType(java.lang.String type) Type of the cohort.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Cohort

public Cohort()

Method Detail

getDateRange

public DateRange getDateRange()

This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be aligned for cohort requests. If the request contains `ga:cohortNthDay` it should be exactly one day long, if `ga:cohortNthWeek` it should be aligned to the week boundary (starting at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV requests there are no such restrictions. You do not need to supply a date range for the `reportsRequest.dateRanges` field.

Returns:

value or null for none

setDateRange

public Cohort setDateRange(DateRange dateRange)

This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be aligned for cohort requests. If the request contains `ga:cohortNthDay` it should be exactly one day long, if `ga:cohortNthWeek` it should be aligned to the week boundary (starting at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV requests there are no such restrictions. You do not need to supply a date range for the `reportsRequest.dateRanges` field.

Parameters:

dateRange - dateRange or null for none

getName

public java.lang.String getName()

A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].

Returns:

value or null for none

setName

public Cohort setName(java.lang.String name)

A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...].

Parameters:

name - name or null for none

getType

public java.lang.String getType()

Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort.

Returns:

value or null for none

setType

public Cohort setType(java.lang.String type)

Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort.

Parameters:

type - type or null for none

set

public Cohort set(java.lang.String fieldName,
         java.lang.Object value)

Overrides:

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

clone

public Cohort clone()

Overrides:

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