Class RunPivotReportRequest.Builder (0.17.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

Implements

RunPivotReportRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

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

addDateRanges(DateRange value)

public RunPivotReportRequest.Builder addDateRanges(DateRange value)

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)

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)

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)

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()

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

Returns

Type	Description
DateRange.Builder

addDateRangesBuilder(int index)

public DateRange.Builder addDateRangesBuilder(int index)

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)

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)

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)

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)

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()

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

Returns

Type	Description
Pivot.Builder

addPivotsBuilder(int index)

public Pivot.Builder addPivotsBuilder(int index)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

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()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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.

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPivots()

public RunPivotReportRequest.Builder clearPivots()

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

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)

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)

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()

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

Returns

Type	Description
List<Builder>

getDateRangesCount()

public int getDateRangesCount()

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

Returns

Type	Description
int

getDateRangesList()

public List<DateRange> getDateRangesList()

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

Returns

Type	Description
List<DateRange>

getDateRangesOrBuilder(int index)

public DateRangeOrBuilder getDateRangesOrBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
DateRangeOrBuilder

getDateRangesOrBuilderList()

public List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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)

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)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
Pivot.Builder

getPivotsBuilderList()

public List<Pivot.Builder> getPivotsBuilderList()

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

Returns

Type	Description
List<Builder>

getPivotsCount()

public int getPivotsCount()

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

Returns

Type	Description
int

getPivotsList()

public List<Pivot> getPivotsList()

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

Returns

Type	Description
List<Pivot>

getPivotsOrBuilder(int index)

public PivotOrBuilder getPivotsOrBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
PivotOrBuilder

getPivotsOrBuilderList()

public List<? extends PivotOrBuilder> getPivotsOrBuilderList()

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

Returns

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

getProperty()

public String getProperty()

string property = 1;

Returns

Type	Description
String	The property.

getPropertyBytes()

public ByteString getPropertyBytes()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public RunPivotReportRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
RunPivotReportRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeDateRanges(int index)

public RunPivotReportRequest.Builder removeDateRanges(int index)

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)

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

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)

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)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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.

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)

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)

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)

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)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)