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

Class CohortsRange

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.CohortsRange

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.

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
CohortsRange()

Method Summary

Modifier and Type	Method and Description
CohortsRange	clone()
Integer	getEndOffset() Required.
String	getGranularity() Required.
Integer	getStartOffset() `startOffset` specifies the start date of the extended reporting date range for a cohort report.
CohortsRange	set(String fieldName, Object value)
CohortsRange	setEndOffset(Integer endOffset) Required.
CohortsRange	setGranularity(String granularity) Required.
CohortsRange	setStartOffset(Integer startOffset) `startOffset` specifies the start date of the extended reporting date range for a cohort report.

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

CohortsRange

public CohortsRange()

Method Detail

getEndOffset

public Integer 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:

value or null for none

setEndOffset

public CohortsRange setEndOffset(Integer endOffset)

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.

Parameters:

endOffset - endOffset or null for none

getGranularity

public String getGranularity()

Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report.

Returns:

value or null for none

setGranularity

public CohortsRange setGranularity(String granularity)

Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report.

Parameters:

granularity - granularity or null for none

getStartOffset

public Integer 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:

value or null for none

setStartOffset

public CohortsRange setStartOffset(Integer startOffset)

`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.

Parameters:

startOffset - startOffset or null for none

set

public CohortsRange set(String fieldName,
                        Object value)

Overrides:

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

clone

public CohortsRange clone()

Overrides:

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