com.google.api.services.analyticsreporting.v4.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.analyticsreporting.v4.model.Pivot

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Pivot
extends GenericJson

The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.

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 Analytics Reporting 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

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<DimensionFilterClause>	getDimensionFilterClauses() DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region.
List<Dimension>	getDimensions() A list of dimensions to show as pivot columns.
Integer	getMaxGroupCount() Specifies the maximum number of groups to return.
List<Metric>	getMetrics() The pivot metrics.
Integer	getStartGroup() If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report.
Pivot	set(String fieldName, Object value)
Pivot	setDimensionFilterClauses(List<DimensionFilterClause> dimensionFilterClauses) DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region.
Pivot	setDimensions(List<Dimension> dimensions) A list of dimensions to show as pivot columns.
Pivot	setMaxGroupCount(Integer maxGroupCount) Specifies the maximum number of groups to return.
Pivot	setMetrics(List<Metric> metrics) The pivot metrics.
Pivot	setStartGroup(Integer startGroup) If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report.

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

getDimensionFilterClauses

public List<DimensionFilterClause> getDimensionFilterClauses()

DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify key filters to restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers would show up as columns.

Returns:

value or null for none

setDimensionFilterClauses

public Pivot setDimensionFilterClauses(List<DimensionFilterClause> dimensionFilterClauses)

DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify key filters to restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers would show up as columns.

Parameters:

dimensionFilterClauses - dimensionFilterClauses or null for none

getDimensions

public List<Dimension> getDimensions()

A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request.

Returns:

value or null for none

setDimensions

public Pivot setDimensions(List<Dimension> dimensions)

A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in the request.

Parameters:

dimensions - dimensions or null for none

getMaxGroupCount

public Integer getMaxGroupCount()

Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000.

Returns:

value or null for none

setMaxGroupCount

public Pivot setMaxGroupCount(Integer maxGroupCount)

Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000.

Parameters:

maxGroupCount - maxGroupCount or null for none

getMetrics

public List<Metric> getMetrics()

The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.

Returns:

value or null for none

setMetrics

public Pivot setMetrics(List<Metric> metrics)

The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request.

Parameters:

metrics - metrics or null for none

getStartGroup

public Integer getStartGroup()

If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response.

Returns:

value or null for none

setStartGroup

public Pivot setStartGroup(Integer startGroup)

If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns are included in the response.

Parameters:

startGroup - startGroup or null for none

set

public Pivot set(String fieldName,
                 Object value)

Overrides:

set in class GenericJson

clone

public Pivot clone()

Overrides:

clone in class GenericJson