RunReportRequest (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.RunReportRequest

All Implemented Interfaces:

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

RunReportRequest()

Constructors
Constructor and Description
`RunReportRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RunReportRequest`	`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()` Date ranges of data to read.
`FilterExpression`	`getDimensionFilter()` Dimension filters let you ask for only specific dimension values in the report.
`List<Dimension>`	`getDimensions()` The dimensions requested and displayed.
`Boolean`	`getKeepEmptyRows()` If false or unspecified, each row with all metrics equal to 0 will not be returned.
`Long`	`getLimit()` The number of rows to return.
`List<String>`	`getMetricAggregations()` Aggregation of metrics.
`FilterExpression`	`getMetricFilter()` The filter clause of metrics.
`List<Metric>`	`getMetrics()` The metrics requested and displayed.
`Long`	`getOffset()` The row count of the start row.
`List<OrderBy>`	`getOrderBys()` Specifies how rows are ordered in the response.
`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.
`RunReportRequest`	`set(String fieldName, Object value)`
`RunReportRequest`	`setCohortSpec(CohortSpec cohortSpec)` Cohort group associated with this request.
`RunReportRequest`	`setCurrencyCode(String currencyCode)` A currency code in ISO4217 format, such as "AED", "USD", "JPY".
`RunReportRequest`	`setDateRanges(List<DateRange> dateRanges)` Date ranges of data to read.
`RunReportRequest`	`setDimensionFilter(FilterExpression dimensionFilter)` Dimension filters let you ask for only specific dimension values in the report.
`RunReportRequest`	`setDimensions(List<Dimension> dimensions)` The dimensions requested and displayed.
`RunReportRequest`	`setKeepEmptyRows(Boolean keepEmptyRows)` If false or unspecified, each row with all metrics equal to 0 will not be returned.
`RunReportRequest`	`setLimit(Long limit)` The number of rows to return.
`RunReportRequest`	`setMetricAggregations(List<String> metricAggregations)` Aggregation of metrics.
`RunReportRequest`	`setMetricFilter(FilterExpression metricFilter)` The filter clause of metrics.
`RunReportRequest`	`setMetrics(List<Metric> metrics)` The metrics requested and displayed.
`RunReportRequest`	`setOffset(Long offset)` The row count of the start row.
`RunReportRequest`	`setOrderBys(List<OrderBy> orderBys)` Specifies how rows are ordered in the response.
`RunReportRequest`	`setProperty(String property)` A Google Analytics GA4 property identifier whose events are tracked.
`RunReportRequest`	`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
  - RunReportRequest
```
public RunReportRequest()
```
- 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 RunReportRequest 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 RunReportRequest 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()
```
    Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified.
    
    Returns:
    
    value or null for none
  - setDateRanges
```
public RunReportRequest setDateRanges(List<DateRange> dateRanges)
```
    Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified.
    
    Parameters:
    
    dateRanges - dateRanges or null for none
  - getDimensionFilter
```
public FilterExpression getDimensionFilter()
```
    Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/repor ting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
    
    Returns:
    
    value or null for none
  - setDimensionFilter
```
public RunReportRequest setDimensionFilter(FilterExpression dimensionFilter)
```
    Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/repor ting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
    
    Parameters:
    
    dimensionFilter - dimensionFilter or null for none
  - getDimensions
```
public List<Dimension> getDimensions()
```
    The dimensions requested and displayed.
    
    Returns:
    
    value or null for none
  - setDimensions
```
public RunReportRequest setDimensions(List<Dimension> dimensions)
```
    The dimensions requested and displayed.
    
    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 RunReportRequest 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
  - getLimit
```
public Long getLimit()
```
    The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [ Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#paginati on).
    
    Returns:
    
    value or null for none
  - setLimit
```
public RunReportRequest setLimit(Long limit)
```
    The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [ Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#paginati on).
    
    Parameters:
    
    limit - limit or null for none
  - getMetricAggregations
```
public List<String> getMetricAggregations()
```
    Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
    
    Returns:
    
    value or null for none
  - setMetricAggregations
```
public RunReportRequest setMetricAggregations(List<String> metricAggregations)
```
    Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
    
    Parameters:
    
    metricAggregations - metricAggregations or null for none
  - getMetricFilter
```
public FilterExpression getMetricFilter()
```
    The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
    
    Returns:
    
    value or null for none
  - setMetricFilter
```
public RunReportRequest setMetricFilter(FilterExpression metricFilter)
```
    The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
    
    Parameters:
    
    metricFilter - metricFilter or null for none
  - getMetrics
```
public List<Metric> getMetrics()
```
    The metrics requested and displayed.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public RunReportRequest setMetrics(List<Metric> metrics)
```
    The metrics requested and displayed.
    
    Parameters:
    
    metrics - metrics or null for none
  - getOffset
```
public Long getOffset()
```
    The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1 /basics#pagination).
    
    Returns:
    
    value or null for none
  - setOffset
```
public RunReportRequest setOffset(Long offset)
```
    The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1 /basics#pagination).
    
    Parameters:
    
    offset - offset or null for none
  - getOrderBys
```
public List<OrderBy> getOrderBys()
```
    Specifies how rows are ordered in the response.
    
    Returns:
    
    value or null for none
  - setOrderBys
```
public RunReportRequest setOrderBys(List<OrderBy> orderBys)
```
    Specifies how rows are ordered in the response.
    
    Parameters:
    
    orderBys - orderBys 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 RunReportRequest 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 RunReportRequest 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 RunReportRequest set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public RunReportRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class RunReportRequest

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

RunReportRequest

Method Detail

getCohortSpec

setCohortSpec

getCurrencyCode

setCurrencyCode

getDateRanges

setDateRanges

getDimensionFilter

setDimensionFilter

getDimensions

setDimensions

getKeepEmptyRows

setKeepEmptyRows

getLimit

setLimit

getMetricAggregations

setMetricAggregations

getMetricFilter

setMetricFilter

getMetrics

setMetrics

getOffset

setOffset

getOrderBys

setOrderBys

getProperty

setProperty

getReturnPropertyQuota

setReturnPropertyQuota

set

clone