Interface PivotOrBuilder (0.55.0)

public interface PivotOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFieldNames(int index)

public abstract 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 abstract ByteString getFieldNamesBytes(int index)

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 abstract int getFieldNamesCount()

repeated string field_names = 1;

Returns
Type	Description
`int`	The count of fieldNames.

getFieldNamesList()

public abstract List<String> getFieldNamesList()

repeated string field_names = 1;

Returns
Type	Description
`List<String>`	A list containing the fieldNames.

getLimit()

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