com.google.analytics.data.v1beta

Interface CohortsRangeOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CohortsRange, CohortsRange.Builder

public interface CohortsRangeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getEndOffset() Required.
CohortsRange.Granularity	getGranularity() Required.
int	getGranularityValue() Required.
int	getStartOffset() `startOffset` specifies the start date of the extended reporting date range for a cohort report.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getGranularityValue

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:

The enum numeric value on the wire for granularity.

getGranularity

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:

The granularity.

getStartOffset

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:

The startOffset.

getEndOffset

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:

The endOffset.