ReportRequest (Analytics Reporting API v4-rev20211020-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.analyticsreporting.v4.model.ReportRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class ReportRequest
extends GenericJson
```
The main request class which specifies the Reporting API request.
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

ReportRequest()

Constructors
Constructor and Description
`ReportRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReportRequest`	`clone()`
`CohortGroup`	`getCohortGroup()` Cohort group associated with this request.
`List<DateRange>`	`getDateRanges()` Date ranges in the request.
`List<DimensionFilterClause>`	`getDimensionFilterClauses()` The dimension filter clauses for filtering Dimension Values.
`List<Dimension>`	`getDimensions()` The dimensions requested.
`String`	`getFiltersExpression()` Dimension or metric filters that restrict the data returned for your request.
`Boolean`	`getHideTotals()` If set to true, hides the total of all metrics for all the matching rows, for every date range.
`Boolean`	`getHideValueRanges()` If set to true, hides the minimum and maximum across all matching rows.
`Boolean`	`getIncludeEmptyRows()` If set to false, the response does not include rows if all the retrieved metrics are equal to zero.
`List<MetricFilterClause>`	`getMetricFilterClauses()` The metric filter clauses.
`List<Metric>`	`getMetrics()` The metrics requested.
`List<OrderBy>`	`getOrderBys()` Sort order on output rows.
`Integer`	`getPageSize()` Page size is for paging and specifies the maximum number of returned rows.
`String`	`getPageToken()` A continuation token to get the next page of the results.
`List<Pivot>`	`getPivots()` The pivot definitions.
`String`	`getSamplingLevel()` The desired report [sample](https://support.google.com/analytics/answer/2637192) size.
`List<Segment>`	`getSegments()` Segment the data returned for the request.
`String`	`getViewId()` The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data.
`ReportRequest`	`set(String fieldName, Object value)`
`ReportRequest`	`setCohortGroup(CohortGroup cohortGroup)` Cohort group associated with this request.
`ReportRequest`	`setDateRanges(List<DateRange> dateRanges)` Date ranges in the request.
`ReportRequest`	`setDimensionFilterClauses(List<DimensionFilterClause> dimensionFilterClauses)` The dimension filter clauses for filtering Dimension Values.
`ReportRequest`	`setDimensions(List<Dimension> dimensions)` The dimensions requested.
`ReportRequest`	`setFiltersExpression(String filtersExpression)` Dimension or metric filters that restrict the data returned for your request.
`ReportRequest`	`setHideTotals(Boolean hideTotals)` If set to true, hides the total of all metrics for all the matching rows, for every date range.
`ReportRequest`	`setHideValueRanges(Boolean hideValueRanges)` If set to true, hides the minimum and maximum across all matching rows.
`ReportRequest`	`setIncludeEmptyRows(Boolean includeEmptyRows)` If set to false, the response does not include rows if all the retrieved metrics are equal to zero.
`ReportRequest`	`setMetricFilterClauses(List<MetricFilterClause> metricFilterClauses)` The metric filter clauses.
`ReportRequest`	`setMetrics(List<Metric> metrics)` The metrics requested.
`ReportRequest`	`setOrderBys(List<OrderBy> orderBys)` Sort order on output rows.
`ReportRequest`	`setPageSize(Integer pageSize)` Page size is for paging and specifies the maximum number of returned rows.
`ReportRequest`	`setPageToken(String pageToken)` A continuation token to get the next page of the results.
`ReportRequest`	`setPivots(List<Pivot> pivots)` The pivot definitions.
`ReportRequest`	`setSamplingLevel(String samplingLevel)` The desired report [sample](https://support.google.com/analytics/answer/2637192) size.
`ReportRequest`	`setSegments(List<Segment> segments)` Segment the data returned for the request.
`ReportRequest`	`setViewId(String viewId)` The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data.

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
  - ReportRequest
```
public ReportRequest()
```
- Method Detail
  - getCohortGroup
```
public CohortGroup getCohortGroup()
```
    Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `cohortGroup` definition.
    
    Returns:
    
    value or null for none
  - setCohortGroup
```
public ReportRequest setCohortGroup(CohortGroup cohortGroup)
```
    Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `cohortGroup` definition.
    
    Parameters:
    
    cohortGroup - cohortGroup or null for none
  - getDateRanges
```
public List<DateRange> getDateRanges()
```
    Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition.
    
    Returns:
    
    value or null for none
  - setDateRanges
```
public ReportRequest setDateRanges(List<DateRange> dateRanges)
```
    Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition.
    
    Parameters:
    
    dateRanges - dateRanges or null for none
  - getDimensionFilterClauses
```
public List<DimensionFilterClause> getDimensionFilterClauses()
```
    The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.
    
    Returns:
    
    value or null for none
  - setDimensionFilterClauses
```
public ReportRequest setDimensionFilterClauses(List<DimensionFilterClause> dimensionFilterClauses)
```
    The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions.
    
    Parameters:
    
    dimensionFilterClauses - dimensionFilterClauses or null for none
  - getDimensions
```
public List<Dimension> getDimensions()
```
    The dimensions requested. Requests can have a total of 9 dimensions.
    
    Returns:
    
    value or null for none
  - setDimensions
```
public ReportRequest setDimensions(List<Dimension> dimensions)
```
    The dimensions requested. Requests can have a total of 9 dimensions.
    
    Parameters:
    
    dimensions - dimensions or null for none
  - getFiltersExpression
```
public String getFiltersExpression()
```
    Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/ref erence#filters).
    
    Returns:
    
    value or null for none
  - setFiltersExpression
```
public ReportRequest setFiltersExpression(String filtersExpression)
```
    Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/ref erence#filters).
    
    Parameters:
    
    filtersExpression - filtersExpression or null for none
  - getHideTotals
```
public Boolean getHideTotals()
```
    If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
    
    Returns:
    
    value or null for none
  - setHideTotals
```
public ReportRequest setHideTotals(Boolean hideTotals)
```
    If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals.
    
    Parameters:
    
    hideTotals - hideTotals or null for none
  - getHideValueRanges
```
public Boolean getHideValueRanges()
```
    If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
    
    Returns:
    
    value or null for none
  - setHideValueRanges
```
public ReportRequest setHideValueRanges(Boolean hideValueRanges)
```
    If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned.
    
    Parameters:
    
    hideValueRanges - hideValueRanges or null for none
  - getIncludeEmptyRows
```
public Boolean getIncludeEmptyRows()
```
    If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.
    
    Returns:
    
    value or null for none
  - setIncludeEmptyRows
```
public ReportRequest setIncludeEmptyRows(Boolean includeEmptyRows)
```
    If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows.
    
    Parameters:
    
    includeEmptyRows - includeEmptyRows or null for none
  - getMetricFilterClauses
```
public List<MetricFilterClause> getMetricFilterClauses()
```
    The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
    
    Returns:
    
    value or null for none
  - setMetricFilterClauses
```
public ReportRequest setMetricFilterClauses(List<MetricFilterClause> metricFilterClauses)
```
    The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated.
    
    Parameters:
    
    metricFilterClauses - metricFilterClauses or null for none
  - getMetrics
```
public List<Metric> getMetrics()
```
    The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public ReportRequest setMetrics(List<Metric> metrics)
```
    The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics.
    
    Parameters:
    
    metrics - metrics or null for none
  - getOrderBys
```
public List<OrderBy> getOrderBys()
```
    Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
    
    Returns:
    
    value or null for none
  - setOrderBys
```
public ReportRequest setOrderBys(List<OrderBy> orderBys)
```
    Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order.
    
    Parameters:
    
    orderBys - orderBys or null for none
  - getPageSize
```
public Integer getPageSize()
```
    Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value.
    
    Returns:
    
    value or null for none
  - setPageSize
```
public ReportRequest setPageSize(Integer pageSize)
```
    Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to a higher value.
    
    Parameters:
    
    pageSize - pageSize or null for none
  - getPageToken
```
public String getPageToken()
```
    A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.
    
    Returns:
    
    value or null for none
  - setPageToken
```
public ReportRequest setPageToken(String pageToken)
```
    A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request.
    
    Parameters:
    
    pageToken - pageToken or null for none
  - getPivots
```
public List<Pivot> getPivots()
```
    The pivot definitions. Requests can have a maximum of 2 pivots.
    
    Returns:
    
    value or null for none
  - setPivots
```
public ReportRequest setPivots(List<Pivot> pivots)
```
    The pivot definitions. Requests can have a maximum of 2 pivots.
    
    Parameters:
    
    pivots - pivots or null for none
  - getSamplingLevel
```
public String getSamplingLevel()
```
    The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
    
    Returns:
    
    value or null for none
  - setSamplingLevel
```
public ReportRequest setSamplingLevel(String samplingLevel)
```
    The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.
    
    Parameters:
    
    samplingLevel - samplingLevel or null for none
  - getSegments
```
public List<Segment> getSegments()
```
    Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension.
    
    Returns:
    
    value or null for none
  - setSegments
```
public ReportRequest setSegments(List<Segment> segments)
```
    Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension.
    
    Parameters:
    
    segments - segments or null for none
  - getViewId
```
public String getViewId()
```
    The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`.
    
    Returns:
    
    value or null for none
  - setViewId
```
public ReportRequest setViewId(String viewId)
```
    The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `viewId`.
    
    Parameters:
    
    viewId - viewId or null for none
  - set
```
public ReportRequest set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public ReportRequest clone()
```
    Overrides:
    
    clone in class GenericJson

Class ReportRequest

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

ReportRequest

Method Detail

getCohortGroup

setCohortGroup

getDateRanges

setDateRanges

getDimensionFilterClauses

setDimensionFilterClauses

getDimensions

setDimensions

getFiltersExpression

setFiltersExpression

getHideTotals

setHideTotals

getHideValueRanges

setHideValueRanges

getIncludeEmptyRows

setIncludeEmptyRows

getMetricFilterClauses

setMetricFilterClauses

getMetrics

setMetrics

getOrderBys

setOrderBys

getPageSize

setPageSize

getPageToken

setPageToken

getPivots

setPivots

getSamplingLevel

setSamplingLevel

getSegments

setSegments

getViewId

setViewId

set

clone