Interface RunAccessReportRequestOrBuilder (0.40.0)

Version 0.40.0

• 0.62.0 (latest)
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0

public interface RunAccessReportRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDateRanges(int index)

public abstract AccessDateRange getDateRanges(int index)

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.

repeated .google.analytics.admin.v1alpha.AccessDateRange date_ranges = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessDateRange

getDateRangesCount()

public abstract int getDateRangesCount()

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.

repeated .google.analytics.admin.v1alpha.AccessDateRange date_ranges = 4;

Returns
Type	Description
int

getDateRangesList()

public abstract List<AccessDateRange> getDateRangesList()

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.

repeated .google.analytics.admin.v1alpha.AccessDateRange date_ranges = 4;

Returns
Type	Description
List<AccessDateRange>

getDateRangesOrBuilder(int index)

public abstract AccessDateRangeOrBuilder getDateRangesOrBuilder(int index)

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.

repeated .google.analytics.admin.v1alpha.AccessDateRange date_ranges = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessDateRangeOrBuilder

getDateRangesOrBuilderList()

public abstract List<? extends AccessDateRangeOrBuilder> getDateRangesOrBuilderList()

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.

repeated .google.analytics.admin.v1alpha.AccessDateRange date_ranges = 4;

Returns
Type	Description
List<? extends com.google.analytics.admin.v1alpha.AccessDateRangeOrBuilder>

getDimensionFilter()

public abstract AccessFilterExpression 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 for examples. Metrics cannot be used in this filter.

.google.analytics.admin.v1alpha.AccessFilterExpression dimension_filter = 5;

Returns
Type	Description
AccessFilterExpression	The dimensionFilter.

getDimensionFilterOrBuilder()

public abstract AccessFilterExpressionOrBuilder getDimensionFilterOrBuilder()

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 for examples. Metrics cannot be used in this filter.

.google.analytics.admin.v1alpha.AccessFilterExpression dimension_filter = 5;

Returns
Type	Description
AccessFilterExpressionOrBuilder

getDimensions(int index)

public abstract AccessDimension getDimensions(int index)

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessDimension

getDimensionsCount()

public abstract int getDimensionsCount()

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;

Returns
Type	Description
int

getDimensionsList()

public abstract List<AccessDimension> getDimensionsList()

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;

Returns
Type	Description
List<AccessDimension>

getDimensionsOrBuilder(int index)

public abstract AccessDimensionOrBuilder getDimensionsOrBuilder(int index)

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessDimensionOrBuilder

getDimensionsOrBuilderList()

public abstract List<? extends AccessDimensionOrBuilder> getDimensionsOrBuilderList()

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;

Returns
Type	Description
List<? extends com.google.analytics.admin.v1alpha.AccessDimensionOrBuilder>

getEntity()

public abstract String getEntity()

The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.

To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID.

string entity = 1;

Returns
Type	Description
String	The entity.

getEntityBytes()

public abstract ByteString getEntityBytes()

The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.

To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID.

string entity = 1;

Returns
Type	Description
ByteString	The bytes for entity.

getExpandGroups()

public abstract 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.

bool expand_groups = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The expandGroups.

getIncludeAllUsers()

public abstract 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.

bool include_all_users = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The includeAllUsers.

getLimit()

public abstract 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.

int64 limit = 8;

Returns
Type	Description
long	The limit.

getMetricFilter()

public abstract AccessFilterExpression 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.

.google.analytics.admin.v1alpha.AccessFilterExpression metric_filter = 6;

Returns
Type	Description
AccessFilterExpression	The metricFilter.

getMetricFilterOrBuilder()

public abstract AccessFilterExpressionOrBuilder getMetricFilterOrBuilder()

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.

.google.analytics.admin.v1alpha.AccessFilterExpression metric_filter = 6;

Returns
Type	Description
AccessFilterExpressionOrBuilder

getMetrics(int index)

public abstract AccessMetric getMetrics(int index)

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessMetric

getMetricsCount()

public abstract int getMetricsCount()

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;

Returns
Type	Description
int

getMetricsList()

public abstract List<AccessMetric> getMetricsList()

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;

Returns
Type	Description
List<AccessMetric>

getMetricsOrBuilder(int index)

public abstract AccessMetricOrBuilder getMetricsOrBuilder(int index)

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessMetricOrBuilder

getMetricsOrBuilderList()

public abstract List<? extends AccessMetricOrBuilder> getMetricsOrBuilderList()

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;

Returns
Type	Description
List<? extends com.google.analytics.admin.v1alpha.AccessMetricOrBuilder>

getOffset()

public abstract 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.

int64 offset = 7;

Returns
Type	Description
long	The offset.

getOrderBys(int index)

public abstract AccessOrderBy getOrderBys(int index)

Specifies how rows are ordered in the response.

repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessOrderBy

getOrderBysCount()

public abstract int getOrderBysCount()

Specifies how rows are ordered in the response.

repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;

Returns
Type	Description
int

getOrderBysList()

public abstract List<AccessOrderBy> getOrderBysList()

Specifies how rows are ordered in the response.

repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;

Returns
Type	Description
List<AccessOrderBy>

getOrderBysOrBuilder(int index)

public abstract AccessOrderByOrBuilder getOrderBysOrBuilder(int index)

Specifies how rows are ordered in the response.

repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
AccessOrderByOrBuilder

getOrderBysOrBuilderList()

public abstract List<? extends AccessOrderByOrBuilder> getOrderBysOrBuilderList()

Specifies how rows are ordered in the response.

repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;

Returns
Type	Description
List<? extends com.google.analytics.admin.v1alpha.AccessOrderByOrBuilder>

getReturnEntityQuota()

public abstract boolean getReturnEntityQuota()

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

bool return_entity_quota = 11;

Returns
Type	Description
boolean	The returnEntityQuota.

getTimeZone()

public abstract 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".

string time_zone = 9;

Returns
Type	Description
String	The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

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

string time_zone = 9;

Returns
Type	Description
ByteString	The bytes for timeZone.

hasDimensionFilter()

public abstract boolean hasDimensionFilter()

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 for examples. Metrics cannot be used in this filter.

.google.analytics.admin.v1alpha.AccessFilterExpression dimension_filter = 5;

Returns
Type	Description
boolean	Whether the dimensionFilter field is set.

hasMetricFilter()

public abstract boolean hasMetricFilter()

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.

.google.analytics.admin.v1alpha.AccessFilterExpression metric_filter = 6;

Returns
Type	Description
boolean	Whether the metricFilter field is set.