Class RunPivotReportRequest.Builder (0.60.0) 

public static final class RunPivotReportRequest.Builder extends GeneratedMessageV3.Builder<RunPivotReportRequest.Builder> implements RunPivotReportRequestOrBuilder

The request to generate a pivot report.

Protobuf type google.analytics.data.v1beta.RunPivotReportRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunPivotReportRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllComparisons(Iterable<? extends Comparison> values)

public RunPivotReportRequest.Builder addAllComparisons(Iterable<? extends Comparison> values)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.Comparison>
Returns
Type Description
RunPivotReportRequest.Builder

addAllDateRanges(Iterable<? extends DateRange> values)

public RunPivotReportRequest.Builder addAllDateRanges(Iterable<? extends DateRange> values)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.DateRange>
Returns
Type Description
RunPivotReportRequest.Builder

addAllDimensions(Iterable<? extends Dimension> values)

public RunPivotReportRequest.Builder addAllDimensions(Iterable<? extends Dimension> values)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.Dimension>
Returns
Type Description
RunPivotReportRequest.Builder

addAllMetrics(Iterable<? extends Metric> values)

public RunPivotReportRequest.Builder addAllMetrics(Iterable<? extends Metric> values)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.Metric>
Returns
Type Description
RunPivotReportRequest.Builder

addAllPivots(Iterable<? extends Pivot> values)

public RunPivotReportRequest.Builder addAllPivots(Iterable<? extends Pivot> values)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.Pivot>
Returns
Type Description
RunPivotReportRequest.Builder

addComparisons(Comparison value)

public RunPivotReportRequest.Builder addComparisons(Comparison value)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Comparison
Returns
Type Description
RunPivotReportRequest.Builder

addComparisons(Comparison.Builder builderForValue)

public RunPivotReportRequest.Builder addComparisons(Comparison.Builder builderForValue)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Comparison.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addComparisons(int index, Comparison value)

public RunPivotReportRequest.Builder addComparisons(int index, Comparison value)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Comparison
Returns
Type Description
RunPivotReportRequest.Builder

addComparisons(int index, Comparison.Builder builderForValue)

public RunPivotReportRequest.Builder addComparisons(int index, Comparison.Builder builderForValue)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Comparison.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addComparisonsBuilder()

public Comparison.Builder addComparisonsBuilder()

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Comparison.Builder

addComparisonsBuilder(int index)

public Comparison.Builder addComparisonsBuilder(int index)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Comparison.Builder

addDateRanges(DateRange value)

public RunPivotReportRequest.Builder addDateRanges(DateRange value)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
value DateRange
Returns
Type Description
RunPivotReportRequest.Builder

addDateRanges(DateRange.Builder builderForValue)

public RunPivotReportRequest.Builder addDateRanges(DateRange.Builder builderForValue)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
builderForValue DateRange.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addDateRanges(int index, DateRange value)

public RunPivotReportRequest.Builder addDateRanges(int index, DateRange value)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameters
Name Description
index int
value DateRange
Returns
Type Description
RunPivotReportRequest.Builder

addDateRanges(int index, DateRange.Builder builderForValue)

public RunPivotReportRequest.Builder addDateRanges(int index, DateRange.Builder builderForValue)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameters
Name Description
index int
builderForValue DateRange.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addDateRangesBuilder()

public DateRange.Builder addDateRangesBuilder()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Returns
Type Description
DateRange.Builder

addDateRangesBuilder(int index)

public DateRange.Builder addDateRangesBuilder(int index)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
index int
Returns
Type Description
DateRange.Builder

addDimensions(Dimension value)

public RunPivotReportRequest.Builder addDimensions(Dimension value)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
value Dimension
Returns
Type Description
RunPivotReportRequest.Builder

addDimensions(Dimension.Builder builderForValue)

public RunPivotReportRequest.Builder addDimensions(Dimension.Builder builderForValue)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
builderForValue Dimension.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addDimensions(int index, Dimension value)

public RunPivotReportRequest.Builder addDimensions(int index, Dimension value)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameters
Name Description
index int
value Dimension
Returns
Type Description
RunPivotReportRequest.Builder

addDimensions(int index, Dimension.Builder builderForValue)

public RunPivotReportRequest.Builder addDimensions(int index, Dimension.Builder builderForValue)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameters
Name Description
index int
builderForValue Dimension.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addDimensionsBuilder()

public Dimension.Builder addDimensionsBuilder()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Returns
Type Description
Dimension.Builder

addDimensionsBuilder(int index)

public Dimension.Builder addDimensionsBuilder(int index)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
Dimension.Builder

addMetrics(Metric value)

public RunPivotReportRequest.Builder addMetrics(Metric value)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
value Metric
Returns
Type Description
RunPivotReportRequest.Builder

addMetrics(Metric.Builder builderForValue)

public RunPivotReportRequest.Builder addMetrics(Metric.Builder builderForValue)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
builderForValue Metric.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addMetrics(int index, Metric value)

public RunPivotReportRequest.Builder addMetrics(int index, Metric value)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameters
Name Description
index int
value Metric
Returns
Type Description
RunPivotReportRequest.Builder

addMetrics(int index, Metric.Builder builderForValue)

public RunPivotReportRequest.Builder addMetrics(int index, Metric.Builder builderForValue)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameters
Name Description
index int
builderForValue Metric.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addMetricsBuilder()

public Metric.Builder addMetricsBuilder()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Returns
Type Description
Metric.Builder

addMetricsBuilder(int index)

public Metric.Builder addMetricsBuilder(int index)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
Metric.Builder

addPivots(Pivot value)

public RunPivotReportRequest.Builder addPivots(Pivot value)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
value Pivot
Returns
Type Description
RunPivotReportRequest.Builder

addPivots(Pivot.Builder builderForValue)

public RunPivotReportRequest.Builder addPivots(Pivot.Builder builderForValue)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
builderForValue Pivot.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addPivots(int index, Pivot value)

public RunPivotReportRequest.Builder addPivots(int index, Pivot value)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameters
Name Description
index int
value Pivot
Returns
Type Description
RunPivotReportRequest.Builder

addPivots(int index, Pivot.Builder builderForValue)

public RunPivotReportRequest.Builder addPivots(int index, Pivot.Builder builderForValue)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameters
Name Description
index int
builderForValue Pivot.Builder
Returns
Type Description
RunPivotReportRequest.Builder

addPivotsBuilder()

public Pivot.Builder addPivotsBuilder()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
Type Description
Pivot.Builder

addPivotsBuilder(int index)

public Pivot.Builder addPivotsBuilder(int index)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
index int
Returns
Type Description
Pivot.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunPivotReportRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

build()

public RunPivotReportRequest build()
Returns
Type Description
RunPivotReportRequest

buildPartial()

public RunPivotReportRequest buildPartial()
Returns
Type Description
RunPivotReportRequest

clear()

public RunPivotReportRequest.Builder clear()
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

clearCohortSpec()

public RunPivotReportRequest.Builder clearCohortSpec()

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

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Returns
Type Description
RunPivotReportRequest.Builder

clearComparisons()

public RunPivotReportRequest.Builder clearComparisons()

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RunPivotReportRequest.Builder

clearCurrencyCode()

public RunPivotReportRequest.Builder clearCurrencyCode()

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

string currency_code = 8;

Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

clearDateRanges()

public RunPivotReportRequest.Builder clearDateRanges()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Returns
Type Description
RunPivotReportRequest.Builder

clearDimensionFilter()

public RunPivotReportRequest.Builder clearDimensionFilter()

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.v1beta.FilterExpression dimension_filter = 6;

Returns
Type Description
RunPivotReportRequest.Builder

clearDimensions()

public RunPivotReportRequest.Builder clearDimensions()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Returns
Type Description
RunPivotReportRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RunPivotReportRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

clearKeepEmptyRows()

public RunPivotReportRequest.Builder clearKeepEmptyRows()

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.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

bool keep_empty_rows = 10;

Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

clearMetricFilter()

public RunPivotReportRequest.Builder clearMetricFilter()

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.v1beta.FilterExpression metric_filter = 7;

Returns
Type Description
RunPivotReportRequest.Builder

clearMetrics()

public RunPivotReportRequest.Builder clearMetrics()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Returns
Type Description
RunPivotReportRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RunPivotReportRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

clearPivots()

public RunPivotReportRequest.Builder clearPivots()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
Type Description
RunPivotReportRequest.Builder

clearProperty()

public RunPivotReportRequest.Builder clearProperty()

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1;

Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

clearReturnPropertyQuota()

public RunPivotReportRequest.Builder clearReturnPropertyQuota()

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

bool return_property_quota = 11;

Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

clone()

public RunPivotReportRequest.Builder clone()
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

getCohortSpec()

public 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.v1beta.CohortSpec cohort_spec = 9;

Returns
Type Description
CohortSpec

The cohortSpec.

getCohortSpecBuilder()

public CohortSpec.Builder getCohortSpecBuilder()

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

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Returns
Type Description
CohortSpec.Builder

getCohortSpecOrBuilder()

public 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.v1beta.CohortSpec cohort_spec = 9;

Returns
Type Description
CohortSpecOrBuilder

getComparisons(int index)

public Comparison getComparisons(int index)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Comparison

getComparisonsBuilder(int index)

public Comparison.Builder getComparisonsBuilder(int index)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Comparison.Builder

getComparisonsBuilderList()

public List<Comparison.Builder> getComparisonsBuilderList()

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getComparisonsCount()

public int getComparisonsCount()

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getComparisonsList()

public List<Comparison> getComparisonsList()

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Comparison>

getComparisonsOrBuilder(int index)

public ComparisonOrBuilder getComparisonsOrBuilder(int index)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ComparisonOrBuilder

getComparisonsOrBuilderList()

public List<? extends ComparisonOrBuilder> getComparisonsOrBuilderList()

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.ComparisonOrBuilder>

getCurrencyCode()

public String getCurrencyCode()

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

string currency_code = 8;

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

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

string currency_code = 8;

Returns
Type Description
ByteString

The bytes for currencyCode.

getDateRanges(int index)

public DateRange getDateRanges(int index)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
index int
Returns
Type Description
DateRange

getDateRangesBuilder(int index)

public DateRange.Builder getDateRangesBuilder(int index)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
index int
Returns
Type Description
DateRange.Builder

getDateRangesBuilderList()

public List<DateRange.Builder> getDateRangesBuilderList()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Returns
Type Description
List<Builder>

getDateRangesCount()

public int getDateRangesCount()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Returns
Type Description
int

getDateRangesList()

public List<DateRange> getDateRangesList()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Returns
Type Description
List<DateRange>

getDateRangesOrBuilder(int index)

public DateRangeOrBuilder getDateRangesOrBuilder(int index)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
index int
Returns
Type Description
DateRangeOrBuilder

getDateRangesOrBuilderList()

public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.DateRangeOrBuilder>

getDefaultInstanceForType()

public RunPivotReportRequest getDefaultInstanceForType()
Returns
Type Description
RunPivotReportRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimensionFilter()

public 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.v1beta.FilterExpression dimension_filter = 6;

Returns
Type Description
FilterExpression

The dimensionFilter.

getDimensionFilterBuilder()

public FilterExpression.Builder getDimensionFilterBuilder()

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.v1beta.FilterExpression dimension_filter = 6;

Returns
Type Description
FilterExpression.Builder

getDimensionFilterOrBuilder()

public 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.v1beta.FilterExpression dimension_filter = 6;

Returns
Type Description
FilterExpressionOrBuilder

getDimensions(int index)

public Dimension getDimensions(int index)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
Dimension

getDimensionsBuilder(int index)

public Dimension.Builder getDimensionsBuilder(int index)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
Dimension.Builder

getDimensionsBuilderList()

public List<Dimension.Builder> getDimensionsBuilderList()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Returns
Type Description
List<Builder>

getDimensionsCount()

public int getDimensionsCount()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Returns
Type Description
int

getDimensionsList()

public List<Dimension> getDimensionsList()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Returns
Type Description
List<Dimension>

getDimensionsOrBuilder(int index)

public DimensionOrBuilder getDimensionsOrBuilder(int index)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
DimensionOrBuilder

getDimensionsOrBuilderList()

public List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.DimensionOrBuilder>

getKeepEmptyRows()

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

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

bool keep_empty_rows = 10;

Returns
Type Description
boolean

The keepEmptyRows.

getMetricFilter()

public 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.v1beta.FilterExpression metric_filter = 7;

Returns
Type Description
FilterExpression

The metricFilter.

getMetricFilterBuilder()

public FilterExpression.Builder getMetricFilterBuilder()

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.v1beta.FilterExpression metric_filter = 7;

Returns
Type Description
FilterExpression.Builder

getMetricFilterOrBuilder()

public 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.v1beta.FilterExpression metric_filter = 7;

Returns
Type Description
FilterExpressionOrBuilder

getMetrics(int index)

public Metric getMetrics(int index)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
Metric

getMetricsBuilder(int index)

public Metric.Builder getMetricsBuilder(int index)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
Metric.Builder

getMetricsBuilderList()

public List<Metric.Builder> getMetricsBuilderList()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Returns
Type Description
List<Builder>

getMetricsCount()

public int getMetricsCount()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Returns
Type Description
int

getMetricsList()

public List<Metric> getMetricsList()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Returns
Type Description
List<Metric>

getMetricsOrBuilder(int index)

public MetricOrBuilder getMetricsOrBuilder(int index)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
MetricOrBuilder

getMetricsOrBuilderList()

public List<? extends MetricOrBuilder> getMetricsOrBuilderList()

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.MetricOrBuilder>

getPivots(int index)

public Pivot getPivots(int index)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
index int
Returns
Type Description
Pivot

getPivotsBuilder(int index)

public Pivot.Builder getPivotsBuilder(int index)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
index int
Returns
Type Description
Pivot.Builder

getPivotsBuilderList()

public List<Pivot.Builder> getPivotsBuilderList()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
Type Description
List<Builder>

getPivotsCount()

public int getPivotsCount()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
Type Description
int

getPivotsList()

public List<Pivot> getPivotsList()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
Type Description
List<Pivot>

getPivotsOrBuilder(int index)

public PivotOrBuilder getPivotsOrBuilder(int index)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
index int
Returns
Type Description
PivotOrBuilder

getPivotsOrBuilderList()

public List<? extends PivotOrBuilder> getPivotsOrBuilderList()

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.PivotOrBuilder>

getProperty()

public String getProperty()

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1;

Returns
Type Description
String

The property.

getPropertyBytes()

public ByteString getPropertyBytes()

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1;

Returns
Type Description
ByteString

The bytes for property.

getReturnPropertyQuota()

public boolean getReturnPropertyQuota()

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

bool return_property_quota = 11;

Returns
Type Description
boolean

The returnPropertyQuota.

hasCohortSpec()

public 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.v1beta.CohortSpec cohort_spec = 9;

Returns
Type Description
boolean

Whether the cohortSpec field is set.

hasDimensionFilter()

public 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.v1beta.FilterExpression dimension_filter = 6;

Returns
Type Description
boolean

Whether the dimensionFilter field is set.

hasMetricFilter()

public 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.v1beta.FilterExpression metric_filter = 7;

Returns
Type Description
boolean

Whether the metricFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCohortSpec(CohortSpec value)

public RunPivotReportRequest.Builder mergeCohortSpec(CohortSpec value)

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

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Parameter
Name Description
value CohortSpec
Returns
Type Description
RunPivotReportRequest.Builder

mergeDimensionFilter(FilterExpression value)

public RunPivotReportRequest.Builder mergeDimensionFilter(FilterExpression value)

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.v1beta.FilterExpression dimension_filter = 6;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunPivotReportRequest.Builder

mergeFrom(RunPivotReportRequest other)

public RunPivotReportRequest.Builder mergeFrom(RunPivotReportRequest other)
Parameter
Name Description
other RunPivotReportRequest
Returns
Type Description
RunPivotReportRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunPivotReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPivotReportRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunPivotReportRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

mergeMetricFilter(FilterExpression value)

public RunPivotReportRequest.Builder mergeMetricFilter(FilterExpression value)

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.v1beta.FilterExpression metric_filter = 7;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunPivotReportRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunPivotReportRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

removeComparisons(int index)

public RunPivotReportRequest.Builder removeComparisons(int index)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RunPivotReportRequest.Builder

removeDateRanges(int index)

public RunPivotReportRequest.Builder removeDateRanges(int index)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameter
Name Description
index int
Returns
Type Description
RunPivotReportRequest.Builder

removeDimensions(int index)

public RunPivotReportRequest.Builder removeDimensions(int index)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
RunPivotReportRequest.Builder

removeMetrics(int index)

public RunPivotReportRequest.Builder removeMetrics(int index)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameter
Name Description
index int
Returns
Type Description
RunPivotReportRequest.Builder

removePivots(int index)

public RunPivotReportRequest.Builder removePivots(int index)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameter
Name Description
index int
Returns
Type Description
RunPivotReportRequest.Builder

setCohortSpec(CohortSpec value)

public RunPivotReportRequest.Builder setCohortSpec(CohortSpec value)

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

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Parameter
Name Description
value CohortSpec
Returns
Type Description
RunPivotReportRequest.Builder

setCohortSpec(CohortSpec.Builder builderForValue)

public RunPivotReportRequest.Builder setCohortSpec(CohortSpec.Builder builderForValue)

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

.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

Parameter
Name Description
builderForValue CohortSpec.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setComparisons(int index, Comparison value)

public RunPivotReportRequest.Builder setComparisons(int index, Comparison value)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Comparison
Returns
Type Description
RunPivotReportRequest.Builder

setComparisons(int index, Comparison.Builder builderForValue)

public RunPivotReportRequest.Builder setComparisons(int index, Comparison.Builder builderForValue)

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

repeated .google.analytics.data.v1beta.Comparison comparisons = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Comparison.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setCurrencyCode(String value)

public RunPivotReportRequest.Builder setCurrencyCode(String value)

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

string currency_code = 8;

Parameter
Name Description
value String

The currencyCode to set.
Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public RunPivotReportRequest.Builder setCurrencyCodeBytes(ByteString value)

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

string currency_code = 8;

Parameter
Name Description
value ByteString

The bytes for currencyCode to set.
Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

setDateRanges(int index, DateRange value)

public RunPivotReportRequest.Builder setDateRanges(int index, DateRange value)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameters
Name Description
index int
value DateRange
Returns
Type Description
RunPivotReportRequest.Builder

setDateRanges(int index, DateRange.Builder builderForValue)

public RunPivotReportRequest.Builder setDateRanges(int index, DateRange.Builder builderForValue)

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

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

Parameters
Name Description
index int
builderForValue DateRange.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setDimensionFilter(FilterExpression value)

public RunPivotReportRequest.Builder setDimensionFilter(FilterExpression value)

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.v1beta.FilterExpression dimension_filter = 6;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunPivotReportRequest.Builder

setDimensionFilter(FilterExpression.Builder builderForValue)

public RunPivotReportRequest.Builder setDimensionFilter(FilterExpression.Builder builderForValue)

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.v1beta.FilterExpression dimension_filter = 6;

Parameter
Name Description
builderForValue FilterExpression.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setDimensions(int index, Dimension value)

public RunPivotReportRequest.Builder setDimensions(int index, Dimension value)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameters
Name Description
index int
value Dimension
Returns
Type Description
RunPivotReportRequest.Builder

setDimensions(int index, Dimension.Builder builderForValue)

public RunPivotReportRequest.Builder setDimensions(int index, Dimension.Builder builderForValue)

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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

Parameters
Name Description
index int
builderForValue Dimension.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunPivotReportRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

setKeepEmptyRows(boolean value)

public RunPivotReportRequest.Builder setKeepEmptyRows(boolean value)

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.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

bool keep_empty_rows = 10;

Parameter
Name Description
value boolean

The keepEmptyRows to set.
Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

setMetricFilter(FilterExpression value)

public RunPivotReportRequest.Builder setMetricFilter(FilterExpression value)

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.v1beta.FilterExpression metric_filter = 7;

Parameter
Name Description
value FilterExpression
Returns
Type Description
RunPivotReportRequest.Builder

setMetricFilter(FilterExpression.Builder builderForValue)

public RunPivotReportRequest.Builder setMetricFilter(FilterExpression.Builder builderForValue)

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.v1beta.FilterExpression metric_filter = 7;

Parameter
Name Description
builderForValue FilterExpression.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setMetrics(int index, Metric value)

public RunPivotReportRequest.Builder setMetrics(int index, Metric value)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameters
Name Description
index int
value Metric
Returns
Type Description
RunPivotReportRequest.Builder

setMetrics(int index, Metric.Builder builderForValue)

public RunPivotReportRequest.Builder setMetrics(int index, Metric.Builder builderForValue)

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

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

Parameters
Name Description
index int
builderForValue Metric.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setPivots(int index, Pivot value)

public RunPivotReportRequest.Builder setPivots(int index, Pivot value)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameters
Name Description
index int
value Pivot
Returns
Type Description
RunPivotReportRequest.Builder

setPivots(int index, Pivot.Builder builderForValue)

public RunPivotReportRequest.Builder setPivots(int index, Pivot.Builder builderForValue)

Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

repeated .google.analytics.data.v1beta.Pivot pivots = 5;

Parameters
Name Description
index int
builderForValue Pivot.Builder
Returns
Type Description
RunPivotReportRequest.Builder

setProperty(String value)

public RunPivotReportRequest.Builder setProperty(String value)

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1;

Parameter
Name Description
value String

The property to set.
Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

setPropertyBytes(ByteString value)

public RunPivotReportRequest.Builder setPropertyBytes(ByteString value)

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

string property = 1;

Parameter
Name Description
value ByteString

The bytes for property to set.
Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunPivotReportRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunPivotReportRequest.Builder
Overrides

setReturnPropertyQuota(boolean value)

public RunPivotReportRequest.Builder setReturnPropertyQuota(boolean value)

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

bool return_property_quota = 11;

Parameter
Name Description
value boolean

The returnPropertyQuota to set.
Returns
Type Description
RunPivotReportRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunPivotReportRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunPivotReportRequest.Builder
Overrides