GoogleAnalyticsAdminV1betaRunAccessReportRequest (Google Analytics Admin API v1beta-rev20240916-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.analyticsadmin.v1beta.model.GoogleAnalyticsAdminV1betaRunAccessReportRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAnalyticsAdminV1betaRunAccessReportRequest
extends com.google.api.client.json.GenericJson
```
The request for a Data Access Record 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 Admin 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

GoogleAnalyticsAdminV1betaRunAccessReportRequest()

Constructors
Constructor and Description
`GoogleAnalyticsAdminV1betaRunAccessReportRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`clone()`
`List<GoogleAnalyticsAdminV1betaAccessDateRange>`	`getDateRanges()` Date ranges of access records to read.
`GoogleAnalyticsAdminV1betaAccessFilterExpression`	`getDimensionFilter()` Dimension filters let you restrict report response to specific dimension values which match the filter.
`List<GoogleAnalyticsAdminV1betaAccessDimension>`	`getDimensions()` The dimensions requested and displayed in the response.
`Boolean`	`getExpandGroups()` Optional.
`Boolean`	`getIncludeAllUsers()` Optional.
`Long`	`getLimit()` The number of rows to return.
`GoogleAnalyticsAdminV1betaAccessFilterExpression`	`getMetricFilter()` Metric filters allow you to restrict report response to specific metric values which match the filter.
`List<GoogleAnalyticsAdminV1betaAccessMetric>`	`getMetrics()` The metrics requested and displayed in the response.
`Long`	`getOffset()` The row count of the start row.
`List<GoogleAnalyticsAdminV1betaAccessOrderBy>`	`getOrderBys()` Specifies how rows are ordered in the response.
`Boolean`	`getReturnEntityQuota()` Toggles whether to return the current state of this Analytics Property's quota.
`String`	`getTimeZone()` This request's time zone if specified.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`set(String fieldName, Object value)`
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setDateRanges(List<GoogleAnalyticsAdminV1betaAccessDateRange> dateRanges)` Date ranges of access records to read.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setDimensionFilter(GoogleAnalyticsAdminV1betaAccessFilterExpression dimensionFilter)` Dimension filters let you restrict report response to specific dimension values which match the filter.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setDimensions(List<GoogleAnalyticsAdminV1betaAccessDimension> dimensions)` The dimensions requested and displayed in the response.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setExpandGroups(Boolean expandGroups)` Optional.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setIncludeAllUsers(Boolean includeAllUsers)` Optional.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setLimit(Long limit)` The number of rows to return.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setMetricFilter(GoogleAnalyticsAdminV1betaAccessFilterExpression metricFilter)` Metric filters allow you to restrict report response to specific metric values which match the filter.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setMetrics(List<GoogleAnalyticsAdminV1betaAccessMetric> metrics)` The metrics requested and displayed in the response.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setOffset(Long offset)` The row count of the start row.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setOrderBys(List<GoogleAnalyticsAdminV1betaAccessOrderBy> orderBys)` Specifies how rows are ordered in the response.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setReturnEntityQuota(Boolean returnEntityQuota)` Toggles whether to return the current state of this Analytics Property's quota.
`GoogleAnalyticsAdminV1betaRunAccessReportRequest`	`setTimeZone(String timeZone)` This request's time zone if specified.

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
  - GoogleAnalyticsAdminV1betaRunAccessReportRequest
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest()
```
- Method Detail
  - getDateRanges
```
public List<GoogleAnalyticsAdminV1betaAccessDateRange> getDateRanges()
```
    Date ranges of access records 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 access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
    
    Returns:
    
    value or null for none
  - setDateRanges
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setDateRanges(List<GoogleAnalyticsAdminV1betaAccessDateRange> dateRanges)
```
    Date ranges of access records 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 access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
    
    Parameters:
    
    dateRanges - dateRanges or null for none
  - getDimensionFilter
```
public GoogleAnalyticsAdminV1betaAccessFilterExpression getDimensionFilter()
```
    Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting /data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
    
    Returns:
    
    value or null for none
  - setDimensionFilter
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setDimensionFilter(GoogleAnalyticsAdminV1betaAccessFilterExpression dimensionFilter)
```
    Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting /data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
    
    Parameters:
    
    dimensionFilter - dimensionFilter or null for none
  - getDimensions
```
public List<GoogleAnalyticsAdminV1betaAccessDimension> getDimensions()
```
    The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
    
    Returns:
    
    value or null for none
  - setDimensions
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setDimensions(List<GoogleAnalyticsAdminV1betaAccessDimension> dimensions)
```
    The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
    
    Parameters:
    
    dimensions - dimensions or null for none
  - getExpandGroups
```
public Boolean getExpandGroups()
```
    Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.
    
    Returns:
    
    value or null for none
  - setExpandGroups
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setExpandGroups(Boolean expandGroups)
```
    Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.
    
    Parameters:
    
    expandGroups - expandGroups or null for none
  - getIncludeAllUsers
```
public Boolean getIncludeAllUsers()
```
    Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.
    
    Returns:
    
    value or null for none
  - setIncludeAllUsers
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setIncludeAllUsers(Boolean includeAllUsers)
```
    Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.
    
    Parameters:
    
    includeAllUsers - includeAllUsers 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 may return fewer rows than the requested `limit`, if there aren't as many remaining rows 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#pagination).
    
    Returns:
    
    value or null for none
  - setLimit
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest 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 may return fewer rows than the requested `limit`, if there aren't as many remaining rows 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#pagination).
    
    Parameters:
    
    limit - limit or null for none
  - getMetricFilter
```
public GoogleAnalyticsAdminV1betaAccessFilterExpression getMetricFilter()
```
    Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are 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 GoogleAnalyticsAdminV1betaRunAccessReportRequest setMetricFilter(GoogleAnalyticsAdminV1betaAccessFilterExpression metricFilter)
```
    Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are 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<GoogleAnalyticsAdminV1betaAccessMetric> getMetrics()
```
    The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setMetrics(List<GoogleAnalyticsAdminV1betaAccessMetric> metrics)
```
    The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
    
    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. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://develo pers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
    
    Returns:
    
    value or null for none
  - setOffset
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setOffset(Long offset)
```
    The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://develo pers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
    
    Parameters:
    
    offset - offset or null for none
  - getOrderBys
```
public List<GoogleAnalyticsAdminV1betaAccessOrderBy> getOrderBys()
```
    Specifies how rows are ordered in the response.
    
    Returns:
    
    value or null for none
  - setOrderBys
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setOrderBys(List<GoogleAnalyticsAdminV1betaAccessOrderBy> orderBys)
```
    Specifies how rows are ordered in the response.
    
    Parameters:
    
    orderBys - orderBys or null for none
  - getReturnEntityQuota
```
public Boolean getReturnEntityQuota()
```
    Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false.
    
    Returns:
    
    value or null for none
  - setReturnEntityQuota
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setReturnEntityQuota(Boolean returnEntityQuota)
```
    Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false.
    
    Parameters:
    
    returnEntityQuota - returnEntityQuota or null for none
  - getTimeZone
```
public String getTimeZone()
```
    This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
    
    Returns:
    
    value or null for none
  - setTimeZone
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest setTimeZone(String timeZone)
```
    This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
    
    Parameters:
    
    timeZone - timeZone or null for none
  - set
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest set(String fieldName,
                                                            Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAnalyticsAdminV1betaRunAccessReportRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAnalyticsAdminV1betaRunAccessReportRequest

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

GoogleAnalyticsAdminV1betaRunAccessReportRequest

Method Detail

getDateRanges

setDateRanges

getDimensionFilter

setDimensionFilter

getDimensions

setDimensions

getExpandGroups

setExpandGroups

getIncludeAllUsers

setIncludeAllUsers

getLimit

setLimit

getMetricFilter

setMetricFilter

getMetrics

setMetrics

getOffset

setOffset

getOrderBys

setOrderBys

getReturnEntityQuota

setReturnEntityQuota

getTimeZone

setTimeZone

set

clone