com.google.analytics.data.v1alpha

Interface RunReportRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RunReportRequest, RunReportRequest.Builder

public interface RunReportRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CohortSpec	getCohortSpec() Cohort group associated with this request.
CohortSpecOrBuilder	getCohortSpecOrBuilder() Cohort group associated with this request.
String	getCurrencyCode() A currency code in ISO4217 format, such as "AED", "USD", "JPY".
com.google.protobuf.ByteString	getCurrencyCodeBytes() A currency code in ISO4217 format, such as "AED", "USD", "JPY".
DateRange	getDateRanges(int index) Date ranges of data to read.
int	getDateRangesCount() Date ranges of data to read.
List<DateRange>	getDateRangesList() Date ranges of data to read.
DateRangeOrBuilder	getDateRangesOrBuilder(int index) Date ranges of data to read.
List<? extends DateRangeOrBuilder>	getDateRangesOrBuilderList() Date ranges of data to read.
FilterExpression	getDimensionFilter() The filter clause of dimensions.
FilterExpressionOrBuilder	getDimensionFilterOrBuilder() The filter clause of dimensions.
Dimension	getDimensions(int index) The dimensions requested and displayed.
int	getDimensionsCount() The dimensions requested and displayed.
List<Dimension>	getDimensionsList() The dimensions requested and displayed.
DimensionOrBuilder	getDimensionsOrBuilder(int index) The dimensions requested and displayed.
List<? extends DimensionOrBuilder>	getDimensionsOrBuilderList() The dimensions requested and displayed.
Entity	getEntity() A property whose events are tracked.
EntityOrBuilder	getEntityOrBuilder() A property whose events are tracked.
boolean	getKeepEmptyRows() If false or unspecified, each row with all metrics equal to 0 will not be returned.
long	getLimit() The number of rows to return.
MetricAggregation	getMetricAggregations(int index) Aggregation of metrics.
int	getMetricAggregationsCount() Aggregation of metrics.
List<MetricAggregation>	getMetricAggregationsList() Aggregation of metrics.
int	getMetricAggregationsValue(int index) Aggregation of metrics.
List<Integer>	getMetricAggregationsValueList() Aggregation of metrics.
FilterExpression	getMetricFilter() The filter clause of metrics.
FilterExpressionOrBuilder	getMetricFilterOrBuilder() The filter clause of metrics.
Metric	getMetrics(int index) The metrics requested and displayed.
int	getMetricsCount() The metrics requested and displayed.
List<Metric>	getMetricsList() The metrics requested and displayed.
MetricOrBuilder	getMetricsOrBuilder(int index) The metrics requested and displayed.
List<? extends MetricOrBuilder>	getMetricsOrBuilderList() The metrics requested and displayed.
long	getOffset() The row count of the start row.
OrderBy	getOrderBys(int index) Specifies how rows are ordered in the response.
int	getOrderBysCount() Specifies how rows are ordered in the response.
List<OrderBy>	getOrderBysList() Specifies how rows are ordered in the response.
OrderByOrBuilder	getOrderBysOrBuilder(int index) Specifies how rows are ordered in the response.
List<? extends OrderByOrBuilder>	getOrderBysOrBuilderList() Specifies how rows are ordered in the response.
boolean	getReturnPropertyQuota() Toggles whether to return the current state of this Analytics Property's quota.
boolean	hasCohortSpec() Cohort group associated with this request.
boolean	hasDimensionFilter() The filter clause of dimensions.
boolean	hasEntity() A property whose events are tracked.
boolean	hasMetricFilter() The filter clause of metrics.

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

hasEntity

boolean hasEntity()

 A property whose events are tracked. Within a batch request, this entity
 should either be unspecified or consistent with the batch-level entity.
 

.google.analytics.data.v1alpha.Entity entity = 1;

Returns:

Whether the entity field is set.

getEntity

Entity getEntity()

 A property whose events are tracked. Within a batch request, this entity
 should either be unspecified or consistent with the batch-level entity.
 

.google.analytics.data.v1alpha.Entity entity = 1;

Returns:

The entity.

getEntityOrBuilder

EntityOrBuilder getEntityOrBuilder()

 A property whose events are tracked. Within a batch request, this entity
 should either be unspecified or consistent with the batch-level entity.
 

.google.analytics.data.v1alpha.Entity entity = 1;

getDimensionsList

List<Dimension> getDimensionsList()

 The dimensions requested and displayed.
 

repeated .google.analytics.data.v1alpha.Dimension dimensions = 2;

getDimensions

Dimension getDimensions(int index)

 The dimensions requested and displayed.
 

repeated .google.analytics.data.v1alpha.Dimension dimensions = 2;

getDimensionsCount

int getDimensionsCount()

 The dimensions requested and displayed.
 

repeated .google.analytics.data.v1alpha.Dimension dimensions = 2;

getDimensionsOrBuilderList

List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()

 The dimensions requested and displayed.
 

repeated .google.analytics.data.v1alpha.Dimension dimensions = 2;

getDimensionsOrBuilder

DimensionOrBuilder getDimensionsOrBuilder(int index)

 The dimensions requested and displayed.
 

repeated .google.analytics.data.v1alpha.Dimension dimensions = 2;

getMetricsList

List<Metric> getMetricsList()

 The metrics requested and displayed.
 

repeated .google.analytics.data.v1alpha.Metric metrics = 3;

getMetrics

Metric getMetrics(int index)

 The metrics requested and displayed.
 

repeated .google.analytics.data.v1alpha.Metric metrics = 3;

getMetricsCount

int getMetricsCount()

 The metrics requested and displayed.
 

repeated .google.analytics.data.v1alpha.Metric metrics = 3;

getMetricsOrBuilderList

List<? extends MetricOrBuilder> getMetricsOrBuilderList()

 The metrics requested and displayed.
 

repeated .google.analytics.data.v1alpha.Metric metrics = 3;

getMetricsOrBuilder

MetricOrBuilder getMetricsOrBuilder(int index)

 The metrics requested and displayed.
 

repeated .google.analytics.data.v1alpha.Metric metrics = 3;

getDateRangesList

List<DateRange> getDateRangesList()

 Date ranges of data to read. If multiple date ranges are requested, each
 response row will contain a zero based date range index. If two date
 ranges overlap, the event data for the overlapping days is included in the
 response rows for both date ranges. In a cohort request, this `dateRanges`
 must be unspecified.
 

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4;

getDateRanges

DateRange getDateRanges(int index)

 Date ranges of data to read. If multiple date ranges are requested, each
 response row will contain a zero based date range index. If two date
 ranges overlap, the event data for the overlapping days is included in the
 response rows for both date ranges. In a cohort request, this `dateRanges`
 must be unspecified.
 

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4;

getDateRangesCount

int getDateRangesCount()

 Date ranges of data to read. If multiple date ranges are requested, each
 response row will contain a zero based date range index. If two date
 ranges overlap, the event data for the overlapping days is included in the
 response rows for both date ranges. In a cohort request, this `dateRanges`
 must be unspecified.
 

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4;

getDateRangesOrBuilderList

List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

 Date ranges of data to read. If multiple date ranges are requested, each
 response row will contain a zero based date range index. If two date
 ranges overlap, the event data for the overlapping days is included in the
 response rows for both date ranges. In a cohort request, this `dateRanges`
 must be unspecified.
 

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4;

getDateRangesOrBuilder

DateRangeOrBuilder getDateRangesOrBuilder(int index)

 Date ranges of data to read. If multiple date ranges are requested, each
 response row will contain a zero based date range index. If two date
 ranges overlap, the event data for the overlapping days is included in the
 response rows for both date ranges. In a cohort request, this `dateRanges`
 must be unspecified.
 

repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4;

getOffset

long getOffset()

 The row count of the start row. The first row is counted as row 0.
 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 offset = 5;

Returns:

The offset.

getLimit

long getLimit()

 The number of rows to return. If unspecified, 10 rows are returned. If
 -1, all rows are returned.
 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
 

int64 limit = 6;

Returns:

The limit.

getMetricAggregationsList

List<MetricAggregation> getMetricAggregationsList()

 Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
 

repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 7;

Returns:

A list containing the metricAggregations.

getMetricAggregationsCount

int getMetricAggregationsCount()

 Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
 

repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 7;

Returns:

The count of metricAggregations.

getMetricAggregations

MetricAggregation getMetricAggregations(int index)

 Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
 

repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 7;

Parameters:

index - The index of the element to return.

Returns:

The metricAggregations at the given index.

getMetricAggregationsValueList

List<Integer> getMetricAggregationsValueList()

 Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
 

repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 7;

Returns:

A list containing the enum numeric values on the wire for metricAggregations.

getMetricAggregationsValue

int getMetricAggregationsValue(int index)

 Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
 

repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 7;

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of metricAggregations at the given index.

hasDimensionFilter

boolean hasDimensionFilter()

 The filter clause of dimensions. Dimensions must be requested to be used in
 this filter. Metrics cannot be used in this filter.
 

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 8;

Returns:

Whether the dimensionFilter field is set.

getDimensionFilter

FilterExpression getDimensionFilter()

 The filter clause of dimensions. Dimensions must be requested to be used in
 this filter. Metrics cannot be used in this filter.
 

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 8;

Returns:

The dimensionFilter.

getDimensionFilterOrBuilder

FilterExpressionOrBuilder getDimensionFilterOrBuilder()

 The filter clause of dimensions. Dimensions must be requested to be used in
 this filter. Metrics cannot be used in this filter.
 

.google.analytics.data.v1alpha.FilterExpression dimension_filter = 8;

hasMetricFilter

boolean hasMetricFilter()

 The filter clause of metrics. Applied at post aggregation phase, similar to
 SQL having-clause. Metrics must be requested to be used in this filter.
 Dimensions cannot be used in this filter.
 

.google.analytics.data.v1alpha.FilterExpression metric_filter = 9;

Returns:

Whether the metricFilter field is set.

getMetricFilter

FilterExpression getMetricFilter()

 The filter clause of metrics. Applied at post aggregation phase, similar to
 SQL having-clause. Metrics must be requested to be used in this filter.
 Dimensions cannot be used in this filter.
 

.google.analytics.data.v1alpha.FilterExpression metric_filter = 9;

Returns:

The metricFilter.

getMetricFilterOrBuilder

FilterExpressionOrBuilder getMetricFilterOrBuilder()

 The filter clause of metrics. Applied at post aggregation phase, similar to
 SQL having-clause. Metrics must be requested to be used in this filter.
 Dimensions cannot be used in this filter.
 

.google.analytics.data.v1alpha.FilterExpression metric_filter = 9;

getOrderBysList

List<OrderBy> getOrderBysList()

 Specifies how rows are ordered in the response.
 

repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10;

getOrderBys

OrderBy getOrderBys(int index)

 Specifies how rows are ordered in the response.
 

repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10;

getOrderBysCount

int getOrderBysCount()

 Specifies how rows are ordered in the response.
 

repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10;

getOrderBysOrBuilderList

List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()

 Specifies how rows are ordered in the response.
 

repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10;

getOrderBysOrBuilder

OrderByOrBuilder getOrderBysOrBuilder(int index)

 Specifies how rows are ordered in the response.
 

repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10;

getCurrencyCode

String getCurrencyCode()

 A currency code in ISO4217 format, such as "AED", "USD", "JPY".
 If the field is empty, the report uses the entity's default currency.
 

string currency_code = 11;

Returns:

The currencyCode.

getCurrencyCodeBytes

com.google.protobuf.ByteString getCurrencyCodeBytes()

 A currency code in ISO4217 format, such as "AED", "USD", "JPY".
 If the field is empty, the report uses the entity's default currency.
 

string currency_code = 11;

Returns:

The bytes for currencyCode.

hasCohortSpec

boolean hasCohortSpec()

 Cohort group associated with this request. If there is a cohort group
 in the request the 'cohort' dimension must be present.
 

.google.analytics.data.v1alpha.CohortSpec cohort_spec = 12;

Returns:

Whether the cohortSpec field is set.

getCohortSpec

CohortSpec getCohortSpec()

 Cohort group associated with this request. If there is a cohort group
 in the request the 'cohort' dimension must be present.
 

.google.analytics.data.v1alpha.CohortSpec cohort_spec = 12;

Returns:

The cohortSpec.

getCohortSpecOrBuilder

CohortSpecOrBuilder getCohortSpecOrBuilder()

 Cohort group associated with this request. If there is a cohort group
 in the request the 'cohort' dimension must be present.
 

.google.analytics.data.v1alpha.CohortSpec cohort_spec = 12;

getKeepEmptyRows

boolean getKeepEmptyRows()

 If false or unspecified, each row with all metrics equal to 0 will not be
 returned. If true, these rows will be returned if they are not separately
 removed by a filter.
 

bool keep_empty_rows = 13;

Returns:

The keepEmptyRows.

getReturnPropertyQuota

boolean getReturnPropertyQuota()

 Toggles whether to return the current state of this Analytics Property's
 quota. Quota is returned in [PropertyQuota](#PropertyQuota).
 

bool return_property_quota = 14;

Returns:

The returnPropertyQuota.