Class Pivot.Builder (0.65.0) 

public static final class Pivot.Builder extends GeneratedMessageV3.Builder<Pivot.Builder> implements PivotOrBuilder

Describes the visible dimension columns and rows in the report response.

Protobuf type google.analytics.data.v1beta.Pivot

Inheritance

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

Implements

PivotOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllFieldNames(Iterable<String> values)

public Pivot.Builder addAllFieldNames(Iterable<String> values)

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Parameter
Name Description
values Iterable<String>

The fieldNames to add.
Returns
Type Description
Pivot.Builder

This builder for chaining.

addAllMetricAggregations(Iterable<? extends MetricAggregation> values)

public Pivot.Builder addAllMetricAggregations(Iterable<? extends MetricAggregation> values)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.MetricAggregation>

The metricAggregations to add.
Returns
Type Description
Pivot.Builder

This builder for chaining.

addAllMetricAggregationsValue(Iterable<Integer> values)

public Pivot.Builder addAllMetricAggregationsValue(Iterable<Integer> values)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for metricAggregations to add.
Returns
Type Description
Pivot.Builder

This builder for chaining.

addAllOrderBys(Iterable<? extends OrderBy> values)

public Pivot.Builder addAllOrderBys(Iterable<? extends OrderBy> values)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

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

addFieldNames(String value)

public Pivot.Builder addFieldNames(String value)

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Parameter
Name Description
value String

The fieldNames to add.
Returns
Type Description
Pivot.Builder

This builder for chaining.

addFieldNamesBytes(ByteString value)

public Pivot.Builder addFieldNamesBytes(ByteString value)

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Parameter
Name Description
value ByteString

The bytes of the fieldNames to add.
Returns
Type Description
Pivot.Builder

This builder for chaining.

addMetricAggregations(MetricAggregation value)

public Pivot.Builder addMetricAggregations(MetricAggregation value)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameter
Name Description
value MetricAggregation

The metricAggregations to add.
Returns
Type Description
Pivot.Builder

This builder for chaining.

addMetricAggregationsValue(int value)

public Pivot.Builder addMetricAggregationsValue(int value)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for metricAggregations to add.
Returns
Type Description
Pivot.Builder

This builder for chaining.

addOrderBys(OrderBy value)

public Pivot.Builder addOrderBys(OrderBy value)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Parameter
Name Description
value OrderBy
Returns
Type Description
Pivot.Builder

addOrderBys(OrderBy.Builder builderForValue)

public Pivot.Builder addOrderBys(OrderBy.Builder builderForValue)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

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

addOrderBys(int index, OrderBy value)

public Pivot.Builder addOrderBys(int index, OrderBy value)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

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

addOrderBys(int index, OrderBy.Builder builderForValue)

public Pivot.Builder addOrderBys(int index, OrderBy.Builder builderForValue)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

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

addOrderBysBuilder()

public OrderBy.Builder addOrderBysBuilder()

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Returns
Type Description
OrderBy.Builder

addOrderBysBuilder(int index)

public OrderBy.Builder addOrderBysBuilder(int index)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Pivot build()
Returns
Type Description
Pivot

buildPartial()

public Pivot buildPartial()
Returns
Type Description
Pivot

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFieldNames()

public Pivot.Builder clearFieldNames()

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Returns
Type Description
Pivot.Builder

This builder for chaining.

clearLimit()

public Pivot.Builder clearLimit()

The number of unique combinations of dimension values to return in this pivot. The limit parameter is required. A limit of 10,000 is common for single pivot requests.

The product of the limit for each pivot in a RunPivotReportRequest must not exceed 250,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.

int64 limit = 4;

Returns
Type Description
Pivot.Builder

This builder for chaining.

clearMetricAggregations()

public Pivot.Builder clearMetricAggregations()

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Returns
Type Description
Pivot.Builder

This builder for chaining.

clearOffset()

public Pivot.Builder clearOffset()

The row count of the start row. The first row is counted as row 0.

int64 offset = 3;

Returns
Type Description
Pivot.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBys()

public Pivot.Builder clearOrderBys()

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Returns
Type Description
Pivot.Builder

clone()

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

getDefaultInstanceForType()

public Pivot getDefaultInstanceForType()
Returns
Type Description
Pivot

getDescriptorForType()

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

getFieldNames(int index)

public String getFieldNames(int index)

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The fieldNames at the given index.

getFieldNamesBytes(int index)

public ByteString getFieldNamesBytes(int index)

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the fieldNames at the given index.

getFieldNamesCount()

public int getFieldNamesCount()

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Returns
Type Description
int

The count of fieldNames.

getFieldNamesList()

public ProtocolStringList getFieldNamesList()

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Returns
Type Description
ProtocolStringList

A list containing the fieldNames.

getLimit()

public long getLimit()

The number of unique combinations of dimension values to return in this pivot. The limit parameter is required. A limit of 10,000 is common for single pivot requests.

The product of the limit for each pivot in a RunPivotReportRequest must not exceed 250,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.

int64 limit = 4;

Returns
Type Description
long

The limit.

getMetricAggregations(int index)

public MetricAggregation getMetricAggregations(int index)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
MetricAggregation

The metricAggregations at the given index.

getMetricAggregationsCount()

public int getMetricAggregationsCount()

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Returns
Type Description
int

The count of metricAggregations.

getMetricAggregationsList()

public List<MetricAggregation> getMetricAggregationsList()

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Returns
Type Description
List<MetricAggregation>

A list containing the metricAggregations.

getMetricAggregationsValue(int index)

public int getMetricAggregationsValue(int index)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

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

getMetricAggregationsValueList()

public List<Integer> getMetricAggregationsValueList()

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Returns
Type Description
List<Integer>

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

getOffset()

public long getOffset()

The row count of the start row. The first row is counted as row 0.

int64 offset = 3;

Returns
Type Description
long

The offset.

getOrderBys(int index)

public OrderBy getOrderBys(int index)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy

getOrderBysBuilder(int index)

public OrderBy.Builder getOrderBysBuilder(int index)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy.Builder

getOrderBysBuilderList()

public List<OrderBy.Builder> getOrderBysBuilderList()

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Returns
Type Description
List<Builder>

getOrderBysCount()

public int getOrderBysCount()

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Returns
Type Description
int

getOrderBysList()

public List<OrderBy> getOrderBysList()

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Returns
Type Description
List<OrderBy>

getOrderBysOrBuilder(int index)

public OrderByOrBuilder getOrderBysOrBuilder(int index)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderByOrBuilder

getOrderBysOrBuilderList()

public List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Pivot other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeOrderBys(int index)

public Pivot.Builder removeOrderBys(int index)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

Parameter
Name Description
index int
Returns
Type Description
Pivot.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setFieldNames(int index, String value)

public Pivot.Builder setFieldNames(int index, String value)

Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

repeated string field_names = 1;

Parameters
Name Description
index int

The index to set the value at.
value String

The fieldNames to set.
Returns
Type Description
Pivot.Builder

This builder for chaining.

setLimit(long value)

public Pivot.Builder setLimit(long value)

The number of unique combinations of dimension values to return in this pivot. The limit parameter is required. A limit of 10,000 is common for single pivot requests.

The product of the limit for each pivot in a RunPivotReportRequest must not exceed 250,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.

int64 limit = 4;

Parameter
Name Description
value long

The limit to set.
Returns
Type Description
Pivot.Builder

This builder for chaining.

setMetricAggregations(int index, MetricAggregation value)

public Pivot.Builder setMetricAggregations(int index, MetricAggregation value)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameters
Name Description
index int

The index to set the value at.
value MetricAggregation

The metricAggregations to set.
Returns
Type Description
Pivot.Builder

This builder for chaining.

setMetricAggregationsValue(int index, int value)

public Pivot.Builder setMetricAggregationsValue(int index, int value)

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for metricAggregations to set.
Returns
Type Description
Pivot.Builder

This builder for chaining.

setOffset(long value)

public Pivot.Builder setOffset(long value)

The row count of the start row. The first row is counted as row 0.

int64 offset = 3;

Parameter
Name Description
value long

The offset to set.
Returns
Type Description
Pivot.Builder

This builder for chaining.

setOrderBys(int index, OrderBy value)

public Pivot.Builder setOrderBys(int index, OrderBy value)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

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

setOrderBys(int index, OrderBy.Builder builderForValue)

public Pivot.Builder setOrderBys(int index, OrderBy.Builder builderForValue)

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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