Pivot (Google Analytics Reporting API v4 (Rev. 123) 1.23.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.analyticsreporting.v4.model.Pivot

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Pivot
extends com.google.api.client.json.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 Google 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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Pivot()

Constructors
Constructor and Description
`Pivot()`

Method Summary

Methods
Modifier and Type	Method and Description
`Pivot`	`clone()`
`java.util.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.
`java.util.List<Dimension>`	`getDimensions()` A list of dimensions to show as pivot columns.
`java.lang.Integer`	`getMaxGroupCount()` Specifies the maximum number of groups to return.
`java.util.List<Metric>`	`getMetrics()` The pivot metrics.
`java.lang.Integer`	`getStartGroup()` If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report.
`Pivot`	`set(java.lang.String fieldName, java.lang.Object value)`
`Pivot`	`setDimensionFilterClauses(java.util.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(java.util.List<Dimension> dimensions)` A list of dimensions to show as pivot columns.
`Pivot`	`setMaxGroupCount(java.lang.Integer maxGroupCount)` Specifies the maximum number of groups to return.
`Pivot`	`setMetrics(java.util.List<Metric> metrics)` The pivot metrics.
`Pivot`	`setStartGroup(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Pivot
```
public Pivot()
```
- Method Detail
  - getDimensionFilterClauses
```
public java.util.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(java.util.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 java.util.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(java.util.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 java.lang.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(java.lang.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 java.util.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(java.util.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 java.lang.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(java.lang.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(java.lang.String fieldName,
        java.lang.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

Google Analytics Reporting API v4 (revision 123)

Class Pivot

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Pivot

Method Detail

getDimensionFilterClauses

setDimensionFilterClauses

getDimensions

setDimensions

getMaxGroupCount

setMaxGroupCount

getMetrics

setMetrics

getStartGroup

setStartGroup

set

clone