Class CohortSpec.Builder (0.44.0)

public static final class CohortSpec.Builder extends GeneratedMessageV3.Builder<CohortSpec.Builder> implements CohortSpecOrBuilder

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.

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.

Protobuf type google.analytics.data.v1beta.CohortSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CohortSpec.Builder

Implements

CohortSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllCohorts(Iterable<? extends Cohort> values)

public CohortSpec.Builder addAllCohorts(Iterable<? extends Cohort> values)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1beta.Cohort>`

Returns
Type	Description
`CohortSpec.Builder`

addCohorts(Cohort value)

public CohortSpec.Builder addCohorts(Cohort value)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`value`	`Cohort`

Returns
Type	Description
`CohortSpec.Builder`

addCohorts(Cohort.Builder builderForValue)

public CohortSpec.Builder addCohorts(Cohort.Builder builderForValue)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`builderForValue`	`Cohort.Builder`

Returns
Type	Description
`CohortSpec.Builder`

addCohorts(int index, Cohort value)

public CohortSpec.Builder addCohorts(int index, Cohort value)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameters
Name	Description
`index`	`int`
`value`	`Cohort`

Returns
Type	Description
`CohortSpec.Builder`

addCohorts(int index, Cohort.Builder builderForValue)

public CohortSpec.Builder addCohorts(int index, Cohort.Builder builderForValue)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Cohort.Builder`

Returns
Type	Description
`CohortSpec.Builder`

addCohortsBuilder()

public Cohort.Builder addCohortsBuilder()

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Returns
Type	Description
`Cohort.Builder`

addCohortsBuilder(int index)

public Cohort.Builder addCohortsBuilder(int index)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Cohort.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CohortSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CohortSpec build()

Returns
Type	Description
`CohortSpec`

buildPartial()

public CohortSpec buildPartial()

Returns
Type	Description
`CohortSpec`

clear()

public CohortSpec.Builder clear()

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCohortReportSettings()

public CohortSpec.Builder clearCohortReportSettings()

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Returns
Type	Description
`CohortSpec.Builder`

clearCohorts()

public CohortSpec.Builder clearCohorts()

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Returns
Type	Description
`CohortSpec.Builder`

clearCohortsRange()

public CohortSpec.Builder clearCohortsRange()

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

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Returns
Type	Description
`CohortSpec.Builder`

clearField(Descriptors.FieldDescriptor field)

public CohortSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CohortSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public CohortSpec.Builder clone()

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCohortReportSettings()

public CohortReportSettings getCohortReportSettings()

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Returns
Type	Description
`CohortReportSettings`	The cohortReportSettings.

getCohortReportSettingsBuilder()

public CohortReportSettings.Builder getCohortReportSettingsBuilder()

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Returns
Type	Description
`CohortReportSettings.Builder`

getCohortReportSettingsOrBuilder()

public CohortReportSettingsOrBuilder getCohortReportSettingsOrBuilder()

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Returns
Type	Description
`CohortReportSettingsOrBuilder`

getCohorts(int index)

public Cohort getCohorts(int index)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Cohort`

getCohortsBuilder(int index)

public Cohort.Builder getCohortsBuilder(int index)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Cohort.Builder`

getCohortsBuilderList()

public List<Cohort.Builder> getCohortsBuilderList()

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Returns
Type	Description
`List<Builder>`

getCohortsCount()

public int getCohortsCount()

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Returns
Type	Description
`int`

getCohortsList()

public List<Cohort> getCohortsList()

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Returns
Type	Description
`List<Cohort>`

getCohortsOrBuilder(int index)

public CohortOrBuilder getCohortsOrBuilder(int index)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CohortOrBuilder`

getCohortsOrBuilderList()

public List<? extends CohortOrBuilder> getCohortsOrBuilderList()

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Returns
Type	Description
`List<? extends com.google.analytics.data.v1beta.CohortOrBuilder>`

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.

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Returns
Type	Description
`CohortsRange`	The cohortsRange.

getCohortsRangeBuilder()

public CohortsRange.Builder getCohortsRangeBuilder()

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

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Returns
Type	Description
`CohortsRange.Builder`

getCohortsRangeOrBuilder()

public CohortsRangeOrBuilder getCohortsRangeOrBuilder()

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

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Returns
Type	Description
`CohortsRangeOrBuilder`

getDefaultInstanceForType()

public CohortSpec getDefaultInstanceForType()

Returns
Type	Description
`CohortSpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

hasCohortReportSettings()

public boolean hasCohortReportSettings()

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Returns
Type	Description
`boolean`	Whether the cohortReportSettings field is set.

hasCohortsRange()

public boolean hasCohortsRange()

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

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Returns
Type	Description
`boolean`	Whether the cohortsRange field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCohortReportSettings(CohortReportSettings value)

public CohortSpec.Builder mergeCohortReportSettings(CohortReportSettings value)

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Parameter
Name	Description
`value`	`CohortReportSettings`

Returns
Type	Description
`CohortSpec.Builder`

mergeCohortsRange(CohortsRange value)

public CohortSpec.Builder mergeCohortsRange(CohortsRange value)

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

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Parameter
Name	Description
`value`	`CohortsRange`

Returns
Type	Description
`CohortSpec.Builder`

mergeFrom(CohortSpec other)

public CohortSpec.Builder mergeFrom(CohortSpec other)

Parameter
Name	Description
`other`	`CohortSpec`

Returns
Type	Description
`CohortSpec.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CohortSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public CohortSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CohortSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeCohorts(int index)

public CohortSpec.Builder removeCohorts(int index)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CohortSpec.Builder`

setCohortReportSettings(CohortReportSettings value)

public CohortSpec.Builder setCohortReportSettings(CohortReportSettings value)

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Parameter
Name	Description
`value`	`CohortReportSettings`

Returns
Type	Description
`CohortSpec.Builder`

setCohortReportSettings(CohortReportSettings.Builder builderForValue)

public CohortSpec.Builder setCohortReportSettings(CohortReportSettings.Builder builderForValue)

Optional settings for a cohort report.

.google.analytics.data.v1beta.CohortReportSettings cohort_report_settings = 3;

Parameter
Name	Description
`builderForValue`	`CohortReportSettings.Builder`

Returns
Type	Description
`CohortSpec.Builder`

setCohorts(int index, Cohort value)

public CohortSpec.Builder setCohorts(int index, Cohort value)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameters
Name	Description
`index`	`int`
`value`	`Cohort`

Returns
Type	Description
`CohortSpec.Builder`

setCohorts(int index, Cohort.Builder builderForValue)

public CohortSpec.Builder setCohorts(int index, Cohort.Builder builderForValue)

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.

repeated .google.analytics.data.v1beta.Cohort cohorts = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Cohort.Builder`

Returns
Type	Description
`CohortSpec.Builder`

setCohortsRange(CohortsRange value)

public CohortSpec.Builder setCohortsRange(CohortsRange value)

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

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Parameter
Name	Description
`value`	`CohortsRange`

Returns
Type	Description
`CohortSpec.Builder`

setCohortsRange(CohortsRange.Builder builderForValue)

public CohortSpec.Builder setCohortsRange(CohortsRange.Builder builderForValue)

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

.google.analytics.data.v1beta.CohortsRange cohorts_range = 2;

Parameter
Name	Description
`builderForValue`	`CohortsRange.Builder`

Returns
Type	Description
`CohortSpec.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public CohortSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CohortSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final CohortSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CohortSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)