Class CohortsRange (0.58.0)

public final class CohortsRange extends GeneratedMessageV3 implements CohortsRangeOrBuilder

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

Protobuf type google.analytics.data.v1beta.CohortsRange

Static Fields

END_OFFSET_FIELD_NUMBER

public static final int END_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

GRANULARITY_FIELD_NUMBER

public static final int GRANULARITY_FIELD_NUMBER
Field Value
Type Description
int

START_OFFSET_FIELD_NUMBER

public static final int START_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CohortsRange getDefaultInstance()
Returns
Type Description
CohortsRange

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CohortsRange.Builder newBuilder()
Returns
Type Description
CohortsRange.Builder

newBuilder(CohortsRange prototype)

public static CohortsRange.Builder newBuilder(CohortsRange prototype)
Parameter
Name Description
prototype CohortsRange
Returns
Type Description
CohortsRange.Builder

parseDelimitedFrom(InputStream input)

public static CohortsRange parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CohortsRange
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CohortsRange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CohortsRange
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CohortsRange parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CohortsRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CohortsRange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CohortsRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CohortsRange parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CohortsRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CohortsRange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CohortsRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CohortsRange parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CohortsRange
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CohortsRange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CohortsRange
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CohortsRange parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CohortsRange
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CohortsRange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CohortsRange
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CohortsRange parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CohortsRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CohortsRange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CohortsRange
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CohortsRange> parser()
Returns
Type Description
Parser<CohortsRange>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CohortsRange getDefaultInstanceForType()
Returns
Type Description
CohortsRange

getEndOffset()

public int 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.

int32 end_offset = 3;

Returns
Type Description
int

The endOffset.

getGranularity()

public CohortsRange.Granularity getGranularity()

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

.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;

Returns
Type Description
CohortsRange.Granularity

The granularity.

getGranularityValue()

public int getGranularityValue()

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

.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;

Returns
Type Description
int

The enum numeric value on the wire for granularity.

getParserForType()

public Parser<CohortsRange> getParserForType()
Returns
Type Description
Parser<CohortsRange>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartOffset()

public int 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.

int32 start_offset = 2;

Returns
Type Description
int

The startOffset.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CohortsRange.Builder newBuilderForType()
Returns
Type Description
CohortsRange.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CohortsRange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CohortsRange.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CohortsRange.Builder toBuilder()
Returns
Type Description
CohortsRange.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException