RunPivotReportRequest (Google Analytics Data API v1beta-rev20230214-2.0.0)

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.RunPivotReportRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class RunPivotReportRequest
extends com.google.api.client.json.GenericJson
```
The request to generate a pivot report.
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

RunPivotReportRequest()

Constructors
Constructor and Description
`RunPivotReportRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RunPivotReportRequest`	`clone()`
`CohortSpec`	`getCohortSpec()` Cohort group associated with this request.
`String`	`getCurrencyCode()` A currency code in ISO4217 format, such as "AED", "USD", "JPY".
`List<DateRange>`	`getDateRanges()` The date range to retrieve event data for the report.
`FilterExpression`	`getDimensionFilter()` The filter clause of dimensions.
`List<Dimension>`	`getDimensions()` The dimensions requested.
`Boolean`	`getKeepEmptyRows()` If false or unspecified, each row with all metrics equal to 0 will not be returned.
`FilterExpression`	`getMetricFilter()` The filter clause of metrics.
`List<Metric>`	`getMetrics()` The metrics requested, at least one metric needs to be specified.
`List<Pivot>`	`getPivots()` Describes the visual format of the report's dimensions in columns or rows.
`String`	`getProperty()` A Google Analytics GA4 property identifier whose events are tracked.
`Boolean`	`getReturnPropertyQuota()` Toggles whether to return the current state of this Analytics Property's quota.
`RunPivotReportRequest`	`set(String fieldName, Object value)`
`RunPivotReportRequest`	`setCohortSpec(CohortSpec cohortSpec)` Cohort group associated with this request.
`RunPivotReportRequest`	`setCurrencyCode(String currencyCode)` A currency code in ISO4217 format, such as "AED", "USD", "JPY".
`RunPivotReportRequest`	`setDateRanges(List<DateRange> dateRanges)` The date range to retrieve event data for the report.
`RunPivotReportRequest`	`setDimensionFilter(FilterExpression dimensionFilter)` The filter clause of dimensions.
`RunPivotReportRequest`	`setDimensions(List<Dimension> dimensions)` The dimensions requested.
`RunPivotReportRequest`	`setKeepEmptyRows(Boolean keepEmptyRows)` If false or unspecified, each row with all metrics equal to 0 will not be returned.
`RunPivotReportRequest`	`setMetricFilter(FilterExpression metricFilter)` The filter clause of metrics.
`RunPivotReportRequest`	`setMetrics(List<Metric> metrics)` The metrics requested, at least one metric needs to be specified.
`RunPivotReportRequest`	`setPivots(List<Pivot> pivots)` Describes the visual format of the report's dimensions in columns or rows.
`RunPivotReportRequest`	`setProperty(String property)` A Google Analytics GA4 property identifier whose events are tracked.
`RunPivotReportRequest`	`setReturnPropertyQuota(Boolean returnPropertyQuota)` Toggles whether to return the current state of this Analytics Property's quota.

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
  - RunPivotReportRequest
```
public RunPivotReportRequest()
```
- Method Detail
  - getCohortSpec
```
public CohortSpec getCohortSpec()
```
    Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
    
    Returns:
    
    value or null for none
  - setCohortSpec
```
public RunPivotReportRequest setCohortSpec(CohortSpec cohortSpec)
```
    Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
    
    Parameters:
    
    cohortSpec - cohortSpec or null for none
  - getCurrencyCode
```
public String getCurrencyCode()
```
    A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.
    
    Returns:
    
    value or null for none
  - setCurrencyCode
```
public RunPivotReportRequest setCurrencyCode(String currencyCode)
```
    A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.
    
    Parameters:
    
    currencyCode - currencyCode or null for none
  - getDateRanges
```
public List<DateRange> getDateRanges()
```
    The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
    
    Returns:
    
    value or null for none
  - setDateRanges
```
public RunPivotReportRequest setDateRanges(List<DateRange> dateRanges)
```
    The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
    
    Parameters:
    
    dateRanges - dateRanges or null for none
  - getDimensionFilter
```
public FilterExpression getDimensionFilter()
```
    The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
    
    Returns:
    
    value or null for none
  - setDimensionFilter
```
public RunPivotReportRequest setDimensionFilter(FilterExpression dimensionFilter)
```
    The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
    
    Parameters:
    
    dimensionFilter - dimensionFilter or null for none
  - getDimensions
```
public List<Dimension> getDimensions()
```
    The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
    
    Returns:
    
    value or null for none
  - setDimensions
```
public RunPivotReportRequest setDimensions(List<Dimension> dimensions)
```
    The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
    
    Parameters:
    
    dimensions - dimensions or null for none
  - getKeepEmptyRows
```
public Boolean getKeepEmptyRows()
```
    If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.
    
    Returns:
    
    value or null for none
  - setKeepEmptyRows
```
public RunPivotReportRequest setKeepEmptyRows(Boolean keepEmptyRows)
```
    If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.
    
    Parameters:
    
    keepEmptyRows - keepEmptyRows or null for none
  - getMetricFilter
```
public FilterExpression getMetricFilter()
```
    The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
    
    Returns:
    
    value or null for none
  - setMetricFilter
```
public RunPivotReportRequest setMetricFilter(FilterExpression metricFilter)
```
    The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
    
    Parameters:
    
    metricFilter - metricFilter or null for none
  - getMetrics
```
public List<Metric> getMetrics()
```
    The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public RunPivotReportRequest setMetrics(List<Metric> metrics)
```
    The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
    
    Parameters:
    
    metrics - metrics or null for none
  - getPivots
```
public List<Pivot> getPivots()
```
    Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
    
    Returns:
    
    value or null for none
  - setPivots
```
public RunPivotReportRequest setPivots(List<Pivot> pivots)
```
    Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
    
    Parameters:
    
    pivots - pivots or null for none
  - getProperty
```
public String getProperty()
```
    A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234
    
    Returns:
    
    value or null for none
  - setProperty
```
public RunPivotReportRequest setProperty(String property)
```
    A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234
    
    Parameters:
    
    property - property or null for none
  - getReturnPropertyQuota
```
public Boolean getReturnPropertyQuota()
```
    Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
    
    Returns:
    
    value or null for none
  - setReturnPropertyQuota
```
public RunPivotReportRequest setReturnPropertyQuota(Boolean returnPropertyQuota)
```
    Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
    
    Parameters:
    
    returnPropertyQuota - returnPropertyQuota or null for none
  - set
```
public RunPivotReportRequest set(String fieldName,
                                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public RunPivotReportRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class RunPivotReportRequest

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

Methods inherited from interface java.util.Map

Constructor Detail

RunPivotReportRequest

Method Detail

getCohortSpec

setCohortSpec

getCurrencyCode

setCurrencyCode

getDateRanges

setDateRanges

getDimensionFilter

setDimensionFilter

getDimensions

setDimensions

getKeepEmptyRows

setKeepEmptyRows

getMetricFilter

setMetricFilter

getMetrics

setMetrics

getPivots

setPivots

getProperty

setProperty

getReturnPropertyQuota

setReturnPropertyQuota

set

clone