Class RunAccessReportRequest.Builder (0.56.0) 

public static final class RunAccessReportRequest.Builder extends GeneratedMessageV3.Builder<RunAccessReportRequest.Builder> implements RunAccessReportRequestOrBuilder

The request for a Data Access Record Report.

Protobuf type google.analytics.admin.v1beta.RunAccessReportRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunAccessReportRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDateRanges(Iterable<? extends AccessDateRange> values)

public RunAccessReportRequest.Builder addAllDateRanges(Iterable<? extends AccessDateRange> values)

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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
values Iterable<? extends com.google.analytics.admin.v1beta.AccessDateRange>
Returns
Type Description
RunAccessReportRequest.Builder

addAllDimensions(Iterable<? extends AccessDimension> values)

public RunAccessReportRequest.Builder addAllDimensions(Iterable<? extends AccessDimension> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.analytics.admin.v1beta.AccessDimension>
Returns
Type Description
RunAccessReportRequest.Builder

addAllMetrics(Iterable<? extends AccessMetric> values)

public RunAccessReportRequest.Builder addAllMetrics(Iterable<? extends AccessMetric> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.analytics.admin.v1beta.AccessMetric>
Returns
Type Description
RunAccessReportRequest.Builder

addAllOrderBys(Iterable<? extends AccessOrderBy> values)

public RunAccessReportRequest.Builder addAllOrderBys(Iterable<? extends AccessOrderBy> values)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
values Iterable<? extends com.google.analytics.admin.v1beta.AccessOrderBy>
Returns
Type Description
RunAccessReportRequest.Builder

addDateRanges(AccessDateRange value)

public RunAccessReportRequest.Builder addDateRanges(AccessDateRange value)

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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
value AccessDateRange
Returns
Type Description
RunAccessReportRequest.Builder

addDateRanges(AccessDateRange.Builder builderForValue)

public RunAccessReportRequest.Builder addDateRanges(AccessDateRange.Builder builderForValue)

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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
builderForValue AccessDateRange.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addDateRanges(int index, AccessDateRange value)

public RunAccessReportRequest.Builder addDateRanges(int index, AccessDateRange value)

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.v1beta.AccessDateRange date_ranges = 4;

Parameters
Name Description
index int
value AccessDateRange
Returns
Type Description
RunAccessReportRequest.Builder

addDateRanges(int index, AccessDateRange.Builder builderForValue)

public RunAccessReportRequest.Builder addDateRanges(int index, AccessDateRange.Builder builderForValue)

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.v1beta.AccessDateRange date_ranges = 4;

Parameters
Name Description
index int
builderForValue AccessDateRange.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addDateRangesBuilder()

public AccessDateRange.Builder addDateRangesBuilder()

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.v1beta.AccessDateRange date_ranges = 4;

Returns
Type Description
AccessDateRange.Builder

addDateRangesBuilder(int index)

public AccessDateRange.Builder addDateRangesBuilder(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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
index int
Returns
Type Description
AccessDateRange.Builder

addDimensions(AccessDimension value)

public RunAccessReportRequest.Builder addDimensions(AccessDimension value)

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

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

Parameter
Name Description
value AccessDimension
Returns
Type Description
RunAccessReportRequest.Builder

addDimensions(AccessDimension.Builder builderForValue)

public RunAccessReportRequest.Builder addDimensions(AccessDimension.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue AccessDimension.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addDimensions(int index, AccessDimension value)

public RunAccessReportRequest.Builder addDimensions(int index, AccessDimension value)

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

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

Parameters
Name Description
index int
value AccessDimension
Returns
Type Description
RunAccessReportRequest.Builder

addDimensions(int index, AccessDimension.Builder builderForValue)

public RunAccessReportRequest.Builder addDimensions(int index, AccessDimension.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AccessDimension.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addDimensionsBuilder()

public AccessDimension.Builder addDimensionsBuilder()

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

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

Returns
Type Description
AccessDimension.Builder

addDimensionsBuilder(int index)

public AccessDimension.Builder addDimensionsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessDimension.Builder

addMetrics(AccessMetric value)

public RunAccessReportRequest.Builder addMetrics(AccessMetric value)

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

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

Parameter
Name Description
value AccessMetric
Returns
Type Description
RunAccessReportRequest.Builder

addMetrics(AccessMetric.Builder builderForValue)

public RunAccessReportRequest.Builder addMetrics(AccessMetric.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue AccessMetric.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addMetrics(int index, AccessMetric value)

public RunAccessReportRequest.Builder addMetrics(int index, AccessMetric value)

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

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

Parameters
Name Description
index int
value AccessMetric
Returns
Type Description
RunAccessReportRequest.Builder

addMetrics(int index, AccessMetric.Builder builderForValue)

public RunAccessReportRequest.Builder addMetrics(int index, AccessMetric.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AccessMetric.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addMetricsBuilder()

public AccessMetric.Builder addMetricsBuilder()

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

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

Returns
Type Description
AccessMetric.Builder

addMetricsBuilder(int index)

public AccessMetric.Builder addMetricsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessMetric.Builder

addOrderBys(AccessOrderBy value)

public RunAccessReportRequest.Builder addOrderBys(AccessOrderBy value)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
value AccessOrderBy
Returns
Type Description
RunAccessReportRequest.Builder

addOrderBys(AccessOrderBy.Builder builderForValue)

public RunAccessReportRequest.Builder addOrderBys(AccessOrderBy.Builder builderForValue)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
builderForValue AccessOrderBy.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addOrderBys(int index, AccessOrderBy value)

public RunAccessReportRequest.Builder addOrderBys(int index, AccessOrderBy value)

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
value AccessOrderBy
Returns
Type Description
RunAccessReportRequest.Builder

addOrderBys(int index, AccessOrderBy.Builder builderForValue)

public RunAccessReportRequest.Builder addOrderBys(int index, AccessOrderBy.Builder builderForValue)

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
builderForValue AccessOrderBy.Builder
Returns
Type Description
RunAccessReportRequest.Builder

addOrderBysBuilder()

public AccessOrderBy.Builder addOrderBysBuilder()

Specifies how rows are ordered in the response.

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

Returns
Type Description
AccessOrderBy.Builder

addOrderBysBuilder(int index)

public AccessOrderBy.Builder addOrderBysBuilder(int index)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
index int
Returns
Type Description
AccessOrderBy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunAccessReportRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

build()

public RunAccessReportRequest build()
Returns
Type Description
RunAccessReportRequest

buildPartial()

public RunAccessReportRequest buildPartial()
Returns
Type Description
RunAccessReportRequest

clear()

public RunAccessReportRequest.Builder clear()
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

clearDateRanges()

public RunAccessReportRequest.Builder clearDateRanges()

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.v1beta.AccessDateRange date_ranges = 4;

Returns
Type Description
RunAccessReportRequest.Builder

clearDimensionFilter()

public RunAccessReportRequest.Builder clearDimensionFilter()

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.v1beta.AccessFilterExpression dimension_filter = 5;

Returns
Type Description
RunAccessReportRequest.Builder

clearDimensions()

public RunAccessReportRequest.Builder clearDimensions()

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

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

Returns
Type Description
RunAccessReportRequest.Builder

clearEntity()

public RunAccessReportRequest.Builder clearEntity()

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
RunAccessReportRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RunAccessReportRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

clearLimit()

public RunAccessReportRequest.Builder clearLimit()

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
RunAccessReportRequest.Builder

This builder for chaining.

clearMetricFilter()

public RunAccessReportRequest.Builder clearMetricFilter()

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.v1beta.AccessFilterExpression metric_filter = 6;

Returns
Type Description
RunAccessReportRequest.Builder

clearMetrics()

public RunAccessReportRequest.Builder clearMetrics()

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

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

Returns
Type Description
RunAccessReportRequest.Builder

clearOffset()

public RunAccessReportRequest.Builder clearOffset()

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
RunAccessReportRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunAccessReportRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

clearOrderBys()

public RunAccessReportRequest.Builder clearOrderBys()

Specifies how rows are ordered in the response.

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

Returns
Type Description
RunAccessReportRequest.Builder

clearReturnEntityQuota()

public RunAccessReportRequest.Builder clearReturnEntityQuota()

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
RunAccessReportRequest.Builder

This builder for chaining.

clearTimeZone()

public RunAccessReportRequest.Builder clearTimeZone()

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
RunAccessReportRequest.Builder

This builder for chaining.

clone()

public RunAccessReportRequest.Builder clone()
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

getDateRanges(int index)

public 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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
index int
Returns
Type Description
AccessDateRange

getDateRangesBuilder(int index)

public AccessDateRange.Builder getDateRangesBuilder(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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
index int
Returns
Type Description
AccessDateRange.Builder

getDateRangesBuilderList()

public List<AccessDateRange.Builder> getDateRangesBuilderList()

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.v1beta.AccessDateRange date_ranges = 4;

Returns
Type Description
List<Builder>

getDateRangesCount()

public 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.v1beta.AccessDateRange date_ranges = 4;

Returns
Type Description
int

getDateRangesList()

public 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.v1beta.AccessDateRange date_ranges = 4;

Returns
Type Description
List<AccessDateRange>

getDateRangesOrBuilder(int index)

public 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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
index int
Returns
Type Description
AccessDateRangeOrBuilder

getDateRangesOrBuilderList()

public 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.v1beta.AccessDateRange date_ranges = 4;

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

getDefaultInstanceForType()

public RunAccessReportRequest getDefaultInstanceForType()
Returns
Type Description
RunAccessReportRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimensionFilter()

public 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.v1beta.AccessFilterExpression dimension_filter = 5;

Returns
Type Description
AccessFilterExpression

The dimensionFilter.

getDimensionFilterBuilder()

public AccessFilterExpression.Builder getDimensionFilterBuilder()

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.v1beta.AccessFilterExpression dimension_filter = 5;

Returns
Type Description
AccessFilterExpression.Builder

getDimensionFilterOrBuilder()

public 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.v1beta.AccessFilterExpression dimension_filter = 5;

Returns
Type Description
AccessFilterExpressionOrBuilder

getDimensions(int index)

public AccessDimension getDimensions(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessDimension

getDimensionsBuilder(int index)

public AccessDimension.Builder getDimensionsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessDimension.Builder

getDimensionsBuilderList()

public List<AccessDimension.Builder> getDimensionsBuilderList()

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

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

Returns
Type Description
List<Builder>

getDimensionsCount()

public int getDimensionsCount()

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

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

Returns
Type Description
int

getDimensionsList()

public List<AccessDimension> getDimensionsList()

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

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

Returns
Type Description
List<AccessDimension>

getDimensionsOrBuilder(int index)

public AccessDimensionOrBuilder getDimensionsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessDimensionOrBuilder

getDimensionsOrBuilderList()

public List<? extends AccessDimensionOrBuilder> getDimensionsOrBuilderList()

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

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

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

getEntity()

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

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.

int64 limit = 8;

Returns
Type Description
long

The limit.

getMetricFilter()

public 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.v1beta.AccessFilterExpression metric_filter = 6;

Returns
Type Description
AccessFilterExpression

The metricFilter.

getMetricFilterBuilder()

public AccessFilterExpression.Builder getMetricFilterBuilder()

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.v1beta.AccessFilterExpression metric_filter = 6;

Returns
Type Description
AccessFilterExpression.Builder

getMetricFilterOrBuilder()

public 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.v1beta.AccessFilterExpression metric_filter = 6;

Returns
Type Description
AccessFilterExpressionOrBuilder

getMetrics(int index)

public AccessMetric getMetrics(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessMetric

getMetricsBuilder(int index)

public AccessMetric.Builder getMetricsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessMetric.Builder

getMetricsBuilderList()

public List<AccessMetric.Builder> getMetricsBuilderList()

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

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

Returns
Type Description
List<Builder>

getMetricsCount()

public int getMetricsCount()

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

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

Returns
Type Description
int

getMetricsList()

public List<AccessMetric> getMetricsList()

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

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

Returns
Type Description
List<AccessMetric>

getMetricsOrBuilder(int index)

public AccessMetricOrBuilder getMetricsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AccessMetricOrBuilder

getMetricsOrBuilderList()

public List<? extends AccessMetricOrBuilder> getMetricsOrBuilderList()

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

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

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

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.

int64 offset = 7;

Returns
Type Description
long

The offset.

getOrderBys(int index)

public AccessOrderBy getOrderBys(int index)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
index int
Returns
Type Description
AccessOrderBy

getOrderBysBuilder(int index)

public AccessOrderBy.Builder getOrderBysBuilder(int index)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
index int
Returns
Type Description
AccessOrderBy.Builder

getOrderBysBuilderList()

public List<AccessOrderBy.Builder> getOrderBysBuilderList()

Specifies how rows are ordered in the response.

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

Returns
Type Description
List<Builder>

getOrderBysCount()

public int getOrderBysCount()

Specifies how rows are ordered in the response.

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

Returns
Type Description
int

getOrderBysList()

public List<AccessOrderBy> getOrderBysList()

Specifies how rows are ordered in the response.

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

Returns
Type Description
List<AccessOrderBy>

getOrderBysOrBuilder(int index)

public AccessOrderByOrBuilder getOrderBysOrBuilder(int index)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
index int
Returns
Type Description
AccessOrderByOrBuilder

getOrderBysOrBuilderList()

public List<? extends AccessOrderByOrBuilder> getOrderBysOrBuilderList()

Specifies how rows are ordered in the response.

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

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

getReturnEntityQuota()

public 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 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 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 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.v1beta.AccessFilterExpression dimension_filter = 5;

Returns
Type Description
boolean

Whether the dimensionFilter field is set.

hasMetricFilter()

public 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.v1beta.AccessFilterExpression metric_filter = 6;

Returns
Type Description
boolean

Whether the metricFilter field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDimensionFilter(AccessFilterExpression value)

public RunAccessReportRequest.Builder mergeDimensionFilter(AccessFilterExpression value)

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.v1beta.AccessFilterExpression dimension_filter = 5;

Parameter
Name Description
value AccessFilterExpression
Returns
Type Description
RunAccessReportRequest.Builder

mergeFrom(RunAccessReportRequest other)

public RunAccessReportRequest.Builder mergeFrom(RunAccessReportRequest other)
Parameter
Name Description
other RunAccessReportRequest
Returns
Type Description
RunAccessReportRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunAccessReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAccessReportRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunAccessReportRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

mergeMetricFilter(AccessFilterExpression value)

public RunAccessReportRequest.Builder mergeMetricFilter(AccessFilterExpression value)

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.v1beta.AccessFilterExpression metric_filter = 6;

Parameter
Name Description
value AccessFilterExpression
Returns
Type Description
RunAccessReportRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunAccessReportRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

removeDateRanges(int index)

public RunAccessReportRequest.Builder removeDateRanges(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.v1beta.AccessDateRange date_ranges = 4;

Parameter
Name Description
index int
Returns
Type Description
RunAccessReportRequest.Builder

removeDimensions(int index)

public RunAccessReportRequest.Builder removeDimensions(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
RunAccessReportRequest.Builder

removeMetrics(int index)

public RunAccessReportRequest.Builder removeMetrics(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
RunAccessReportRequest.Builder

removeOrderBys(int index)

public RunAccessReportRequest.Builder removeOrderBys(int index)

Specifies how rows are ordered in the response.

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

Parameter
Name Description
index int
Returns
Type Description
RunAccessReportRequest.Builder

setDateRanges(int index, AccessDateRange value)

public RunAccessReportRequest.Builder setDateRanges(int index, AccessDateRange value)

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.v1beta.AccessDateRange date_ranges = 4;

Parameters
Name Description
index int
value AccessDateRange
Returns
Type Description
RunAccessReportRequest.Builder

setDateRanges(int index, AccessDateRange.Builder builderForValue)

public RunAccessReportRequest.Builder setDateRanges(int index, AccessDateRange.Builder builderForValue)

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.v1beta.AccessDateRange date_ranges = 4;

Parameters
Name Description
index int
builderForValue AccessDateRange.Builder
Returns
Type Description
RunAccessReportRequest.Builder

setDimensionFilter(AccessFilterExpression value)

public RunAccessReportRequest.Builder setDimensionFilter(AccessFilterExpression value)

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.v1beta.AccessFilterExpression dimension_filter = 5;

Parameter
Name Description
value AccessFilterExpression
Returns
Type Description
RunAccessReportRequest.Builder

setDimensionFilter(AccessFilterExpression.Builder builderForValue)

public RunAccessReportRequest.Builder setDimensionFilter(AccessFilterExpression.Builder builderForValue)

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.v1beta.AccessFilterExpression dimension_filter = 5;

Parameter
Name Description
builderForValue AccessFilterExpression.Builder
Returns
Type Description
RunAccessReportRequest.Builder

setDimensions(int index, AccessDimension value)

public RunAccessReportRequest.Builder setDimensions(int index, AccessDimension value)

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

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

Parameters
Name Description
index int
value AccessDimension
Returns
Type Description
RunAccessReportRequest.Builder

setDimensions(int index, AccessDimension.Builder builderForValue)

public RunAccessReportRequest.Builder setDimensions(int index, AccessDimension.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AccessDimension.Builder
Returns
Type Description
RunAccessReportRequest.Builder

setEntity(String value)

public RunAccessReportRequest.Builder setEntity(String value)

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;

Parameter
Name Description
value String

The entity to set.
Returns
Type Description
RunAccessReportRequest.Builder

This builder for chaining.

setEntityBytes(ByteString value)

public RunAccessReportRequest.Builder setEntityBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for entity to set.
Returns
Type Description
RunAccessReportRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RunAccessReportRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

setLimit(long value)

public RunAccessReportRequest.Builder setLimit(long value)

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;

Parameter
Name Description
value long

The limit to set.
Returns
Type Description
RunAccessReportRequest.Builder

This builder for chaining.

setMetricFilter(AccessFilterExpression value)

public RunAccessReportRequest.Builder setMetricFilter(AccessFilterExpression value)

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.v1beta.AccessFilterExpression metric_filter = 6;

Parameter
Name Description
value AccessFilterExpression
Returns
Type Description
RunAccessReportRequest.Builder

setMetricFilter(AccessFilterExpression.Builder builderForValue)

public RunAccessReportRequest.Builder setMetricFilter(AccessFilterExpression.Builder builderForValue)

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.v1beta.AccessFilterExpression metric_filter = 6;

Parameter
Name Description
builderForValue AccessFilterExpression.Builder
Returns
Type Description
RunAccessReportRequest.Builder

setMetrics(int index, AccessMetric value)

public RunAccessReportRequest.Builder setMetrics(int index, AccessMetric value)

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

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

Parameters
Name Description
index int
value AccessMetric
Returns
Type Description
RunAccessReportRequest.Builder

setMetrics(int index, AccessMetric.Builder builderForValue)

public RunAccessReportRequest.Builder setMetrics(int index, AccessMetric.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AccessMetric.Builder
Returns
Type Description
RunAccessReportRequest.Builder

setOffset(long value)

public RunAccessReportRequest.Builder setOffset(long value)

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;

Parameter
Name Description
value long

The offset to set.
Returns
Type Description
RunAccessReportRequest.Builder

This builder for chaining.

setOrderBys(int index, AccessOrderBy value)

public RunAccessReportRequest.Builder setOrderBys(int index, AccessOrderBy value)

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
value AccessOrderBy
Returns
Type Description
RunAccessReportRequest.Builder

setOrderBys(int index, AccessOrderBy.Builder builderForValue)

public RunAccessReportRequest.Builder setOrderBys(int index, AccessOrderBy.Builder builderForValue)

Specifies how rows are ordered in the response.

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

Parameters
Name Description
index int
builderForValue AccessOrderBy.Builder
Returns
Type Description
RunAccessReportRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunAccessReportRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

setReturnEntityQuota(boolean value)

public RunAccessReportRequest.Builder setReturnEntityQuota(boolean value)

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;

Parameter
Name Description
value boolean

The returnEntityQuota to set.
Returns
Type Description
RunAccessReportRequest.Builder

This builder for chaining.

setTimeZone(String value)

public RunAccessReportRequest.Builder setTimeZone(String value)

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;

Parameter
Name Description
value String

The timeZone to set.
Returns
Type Description
RunAccessReportRequest.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public RunAccessReportRequest.Builder setTimeZoneBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for timeZone to set.
Returns
Type Description
RunAccessReportRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunAccessReportRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunAccessReportRequest.Builder
Overrides