Class RunAccessReportRequest (0.54.0)

public final class RunAccessReportRequest extends GeneratedMessageV3 implements RunAccessReportRequestOrBuilder

The request for a Data Access Record Report.

Protobuf type google.analytics.admin.v1alpha.RunAccessReportRequest

Static Fields

DATE_RANGES_FIELD_NUMBER

public static final int DATE_RANGES_FIELD_NUMBER
Field Value
Type Description
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

DIMENSION_FILTER_FIELD_NUMBER

public static final int DIMENSION_FILTER_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_FIELD_NUMBER

public static final int ENTITY_FIELD_NUMBER
Field Value
Type Description
int

EXPAND_GROUPS_FIELD_NUMBER

public static final int EXPAND_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_ALL_USERS_FIELD_NUMBER

public static final int INCLUDE_ALL_USERS_FIELD_NUMBER
Field Value
Type Description
int

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

METRIC_FILTER_FIELD_NUMBER

public static final int METRIC_FILTER_FIELD_NUMBER
Field Value
Type Description
int

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BYS_FIELD_NUMBER

public static final int ORDER_BYS_FIELD_NUMBER
Field Value
Type Description
int

RETURN_ENTITY_QUOTA_FIELD_NUMBER

public static final int RETURN_ENTITY_QUOTA_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunAccessReportRequest getDefaultInstance()
Returns
Type Description
RunAccessReportRequest

getDescriptor()

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

newBuilder()

public static RunAccessReportRequest.Builder newBuilder()
Returns
Type Description
RunAccessReportRequest.Builder

newBuilder(RunAccessReportRequest prototype)

public static RunAccessReportRequest.Builder newBuilder(RunAccessReportRequest prototype)
Parameter
Name Description
prototype RunAccessReportRequest
Returns
Type Description
RunAccessReportRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunAccessReportRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAccessReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunAccessReportRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunAccessReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunAccessReportRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunAccessReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunAccessReportRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAccessReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunAccessReportRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunAccessReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunAccessReportRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunAccessReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAccessReportRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunAccessReportRequest> parser()
Returns
Type Description
Parser<RunAccessReportRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.v1alpha.AccessDateRange date_ranges = 4;

Parameter
Name Description
index int
Returns
Type Description
AccessDateRange

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

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

getDefaultInstanceForType()

public RunAccessReportRequest getDefaultInstanceForType()
Returns
Type Description
RunAccessReportRequest

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

Returns
Type Description
AccessFilterExpression

The dimensionFilter.

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.v1alpha.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.v1alpha.AccessDimension dimensions = 2;

Parameter
Name Description
index int
Returns
Type Description
AccessDimension

getDimensionsCount()

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

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.

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

Returns
Type Description
boolean

The expandGroups.

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.

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

Returns
Type Description
boolean

The includeAllUsers.

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

Returns
Type Description
AccessFilterExpression

The metricFilter.

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.v1alpha.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.v1alpha.AccessMetric metrics = 3;

Parameter
Name Description
index int
Returns
Type Description
AccessMetric

getMetricsCount()

public 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 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 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 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 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.v1alpha.AccessOrderBy order_bys = 10;

Parameter
Name Description
index int
Returns
Type Description
AccessOrderBy

getOrderBysCount()

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

getParserForType()

public Parser<RunAccessReportRequest> getParserForType()
Returns
Type Description
Parser<RunAccessReportRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Returns
Type Description
boolean

Whether the metricFilter field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunAccessReportRequest.Builder newBuilderForType()
Returns
Type Description
RunAccessReportRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunAccessReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunAccessReportRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RunAccessReportRequest.Builder toBuilder()
Returns
Type Description
RunAccessReportRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException