com.google.analytics.data.v1beta

Interface CohortOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Cohort, Cohort.Builder

public interface CohortOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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`.
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.
boolean	hasDateRange() The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`.

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

getName

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;

Returns:

The name.

getNameBytes

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;

Returns:

The bytes for name.

getDimension

String getDimension()

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

string dimension = 2;

Returns:

The dimension.

getDimensionBytes

com.google.protobuf.ByteString getDimensionBytes()

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

string dimension = 2;

Returns:

The bytes for dimension.

hasDateRange

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;

Returns:

Whether the dateRange field is set.

getDateRange

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;

Returns:

The dateRange.

getDateRangeOrBuilder

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;