Interface CohortsRangeOrBuilder (0.63.0)

public interface CohortsRangeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndOffset()

public abstract 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 abstract 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.v1alpha.CohortsRange.Granularity granularity = 1;

Returns
Type Description
CohortsRange.Granularity

The granularity.

getGranularityValue()

public abstract 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.v1alpha.CohortsRange.Granularity granularity = 1;

Returns
Type Description
int

The enum numeric value on the wire for granularity.

getStartOffset()

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