com.google.analytics.data.v1beta

Class Cohort

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1beta.Cohort

All Implemented Interfaces:

CohortOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Cohort
extends com.google.protobuf.GeneratedMessageV3
implements CohortOrBuilder

 Defines a cohort selection criteria. A cohort is a group of users who share
 a common characteristic. For example, users with the same `firstSessionDate`
 belong to the same cohort.
 

Protobuf type google.analytics.data.v1beta.Cohort

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cohort.Builder Defines a cohort selection criteria.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATE_RANGE_FIELD_NUMBER
static int	DIMENSION_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
DateRange	getDateRange() The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`.
DateRangeOrBuilder	getDateRangeOrBuilder() The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`.
static Cohort	getDefaultInstance()
Cohort	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDimension() Dimension used by the cohort.
com.google.protobuf.ByteString	getDimensionBytes() Dimension used by the cohort.
String	getName() Assigns a name to this cohort.
com.google.protobuf.ByteString	getNameBytes() Assigns a name to this cohort.
com.google.protobuf.Parser<Cohort>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDateRange() The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Cohort.Builder	newBuilder()
static Cohort.Builder	newBuilder(Cohort prototype)
Cohort.Builder	newBuilderForType()
protected Cohort.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Cohort	parseDelimitedFrom(InputStream input)
static Cohort	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cohort	parseFrom(byte[] data)
static Cohort	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cohort	parseFrom(ByteBuffer data)
static Cohort	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cohort	parseFrom(com.google.protobuf.ByteString data)
static Cohort	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cohort	parseFrom(com.google.protobuf.CodedInputStream input)
static Cohort	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cohort	parseFrom(InputStream input)
static Cohort	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cohort>	parser()
Cohort.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DIMENSION_FIELD_NUMBER

public static final int DIMENSION_FIELD_NUMBER

See Also:

Constant Field Values

DATE_RANGE_FIELD_NUMBER

public static final int DATE_RANGE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Assigns a name to this cohort. The dimension `cohort` is valued to this
 name in a report response. If set, cannot begin with `cohort_` or
 `RESERVED_`. If not set, cohorts are named by their zero based index
 `cohort_0`, `cohort_1`, etc.
 

string name = 1;

Specified by:

getName in interface CohortOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Assigns a name to this cohort. The dimension `cohort` is valued to this
 name in a report response. If set, cannot begin with `cohort_` or
 `RESERVED_`. If not set, cohorts are named by their zero based index
 `cohort_0`, `cohort_1`, etc.
 

string name = 1;

Specified by:

getNameBytes in interface CohortOrBuilder

Returns:

The bytes for name.

getDimension

public String getDimension()

 Dimension used by the cohort. Required and only supports
 `firstSessionDate`.
 

string dimension = 2;

Specified by:

getDimension in interface CohortOrBuilder

Returns:

The dimension.

getDimensionBytes

public com.google.protobuf.ByteString getDimensionBytes()

 Dimension used by the cohort. Required and only supports
 `firstSessionDate`.
 

string dimension = 2;

Specified by:

getDimensionBytes in interface CohortOrBuilder

Returns:

The bytes for dimension.

hasDateRange

public boolean hasDateRange()

 The cohort selects users whose first touch date is between start date and
 end date defined in the `dateRange`. This `dateRange` does not specify the
 full date range of event data that is present in a cohort report. In a
 cohort report, this `dateRange` is extended by the granularity and offset
 present in the `cohortsRange`; event data for the extended reporting date
 range is present in a cohort report.
 In a cohort request, this `dateRange` is required and the `dateRanges` in
 the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
 This `dateRange` should generally be aligned with the cohort's granularity.
 If `CohortsRange` uses daily granularity, this `dateRange` can be a single
 day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
 aligned to a week boundary, starting at Sunday and ending Saturday. If
 `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
 a month, starting at the first and ending on the last day of the month.
 

.google.analytics.data.v1beta.DateRange date_range = 3;

Specified by:

hasDateRange in interface CohortOrBuilder

Returns:

Whether the dateRange field is set.

getDateRange

public DateRange getDateRange()

 The cohort selects users whose first touch date is between start date and
 end date defined in the `dateRange`. This `dateRange` does not specify the
 full date range of event data that is present in a cohort report. In a
 cohort report, this `dateRange` is extended by the granularity and offset
 present in the `cohortsRange`; event data for the extended reporting date
 range is present in a cohort report.
 In a cohort request, this `dateRange` is required and the `dateRanges` in
 the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
 This `dateRange` should generally be aligned with the cohort's granularity.
 If `CohortsRange` uses daily granularity, this `dateRange` can be a single
 day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
 aligned to a week boundary, starting at Sunday and ending Saturday. If
 `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
 a month, starting at the first and ending on the last day of the month.
 

.google.analytics.data.v1beta.DateRange date_range = 3;

Specified by:

getDateRange in interface CohortOrBuilder

Returns:

The dateRange.

getDateRangeOrBuilder

public DateRangeOrBuilder getDateRangeOrBuilder()

 The cohort selects users whose first touch date is between start date and
 end date defined in the `dateRange`. This `dateRange` does not specify the
 full date range of event data that is present in a cohort report. In a
 cohort report, this `dateRange` is extended by the granularity and offset
 present in the `cohortsRange`; event data for the extended reporting date
 range is present in a cohort report.
 In a cohort request, this `dateRange` is required and the `dateRanges` in
 the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
 This `dateRange` should generally be aligned with the cohort's granularity.
 If `CohortsRange` uses daily granularity, this `dateRange` can be a single
 day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
 aligned to a week boundary, starting at Sunday and ending Saturday. If
 `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
 a month, starting at the first and ending on the last day of the month.
 

.google.analytics.data.v1beta.DateRange date_range = 3;

Specified by:

getDateRangeOrBuilder in interface CohortOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Cohort parseFrom(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cohort parseFrom(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cohort parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cohort parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cohort parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cohort parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cohort parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Cohort parseFrom(InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cohort parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cohort parseDelimitedFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Cohort parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Cohort parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Cohort.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Cohort.Builder newBuilder()

newBuilder

public static Cohort.Builder newBuilder(Cohort prototype)

toBuilder

public Cohort.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Cohort.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cohort getDefaultInstance()

parser

public static com.google.protobuf.Parser<Cohort> parser()

getParserForType

public com.google.protobuf.Parser<Cohort> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Cohort getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder