com.google.api.services.analyticsdata.v1beta.model

Class Pivot

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsdata.v1beta.model.Pivot

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Pivot
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Analytics Data API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Pivot()

Method Summary

Modifier and Type	Method and Description
Pivot	clone()
List<String>	getFieldNames() Dimension names for visible columns in the report response.
Long	getLimit() The number of unique combinations of dimension values to return in this pivot.
List<String>	getMetricAggregations() Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
Long	getOffset() The row count of the start row.
List<OrderBy>	getOrderBys() Specifies how dimensions are ordered in the pivot.
Pivot	set(String fieldName, Object value)
Pivot	setFieldNames(List<String> fieldNames) Dimension names for visible columns in the report response.
Pivot	setLimit(Long limit) The number of unique combinations of dimension values to return in this pivot.
Pivot	setMetricAggregations(List<String> metricAggregations) Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
Pivot	setOffset(Long offset) The row count of the start row.
Pivot	setOrderBys(List<OrderBy> orderBys) Specifies how dimensions are ordered in the pivot.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Pivot

public Pivot()

Method Detail

getFieldNames

public List<String> getFieldNames()

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.

Returns:

value or null for none

setFieldNames

public Pivot setFieldNames(List<String> fieldNames)

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.

Parameters:

fieldNames - fieldNames or null for none

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 100,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`.

Returns:

value or null for none

setLimit

public Pivot setLimit(Long limit)

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 100,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`.

Parameters:

limit - limit or null for none

getMetricAggregations

public List<String> getMetricAggregations()

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

Returns:

value or null for none

setMetricAggregations

public Pivot setMetricAggregations(List<String> metricAggregations)

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

Parameters:

metricAggregations - metricAggregations or null for none

getOffset

public Long getOffset()

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

Returns:

value or null for none

setOffset

public Pivot setOffset(Long offset)

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

Parameters:

offset - offset or null for none

getOrderBys

public List<OrderBy> getOrderBys()

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.

Returns:

value or null for none

setOrderBys

public Pivot setOrderBys(List<OrderBy> orderBys)

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.

Parameters:

orderBys - orderBys or null for none

set

public Pivot set(String fieldName,
                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Pivot clone()

Overrides:

clone in class com.google.api.client.json.GenericJson