public static final class CohortsRange.Builder extends GeneratedMessageV3.Builder<CohortsRange.Builder> implements CohortsRangeOrBuilderConfigures 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CohortsRange.BuilderImplements
CohortsRangeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CohortsRange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
build()
public CohortsRange build()| Returns | |
|---|---|
| Type | Description |
CohortsRange | |
buildPartial()
public CohortsRange buildPartial()| Returns | |
|---|---|
| Type | Description |
CohortsRange | |
clear()
public CohortsRange.Builder clear()| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
clearEndOffset()
public CohortsRange.Builder clearEndOffset() 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 |
CohortsRange.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CohortsRange.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
clearGranularity()
public CohortsRange.Builder clearGranularity() 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.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CohortsRange.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
clearStartOffset()
public CohortsRange.Builder clearStartOffset() 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 |
CohortsRange.Builder | This builder for chaining. |
clone()
public CohortsRange.Builder clone()| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
getDefaultInstanceForType()
public CohortsRange getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CohortsRange | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CohortsRange other)
public CohortsRange.Builder mergeFrom(CohortsRange other)| Parameter | |
|---|---|
| Name | Description |
other | CohortsRange |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CohortsRange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public CohortsRange.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CohortsRange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
setEndOffset(int value)
public CohortsRange.Builder setEndOffset(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe endOffset to set. |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CohortsRange.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
setGranularity(CohortsRange.Granularity value)
public CohortsRange.Builder setGranularity(CohortsRange.Granularity value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | CohortsRange.GranularityThe granularity to set. |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | This builder for chaining. |
setGranularityValue(int value)
public CohortsRange.Builder setGranularityValue(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for granularity to set. |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CohortsRange.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |
setStartOffset(int value)
public CohortsRange.Builder setStartOffset(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe startOffset to set. |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CohortsRange.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CohortsRange.Builder | |