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
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
Field Value
DIMENSION_FILTER_FIELD_NUMBER
public static final int DIMENSION_FILTER_FIELD_NUMBER
Field Value
ENTITY_FIELD_NUMBER
public static final int ENTITY_FIELD_NUMBER
Field Value
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
Field Value
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER
Field Value
METRIC_FILTER_FIELD_NUMBER
public static final int METRIC_FILTER_FIELD_NUMBER
Field Value
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value
ORDER_BYS_FIELD_NUMBER
public static final int ORDER_BYS_FIELD_NUMBER
Field Value
RETURN_ENTITY_QUOTA_FIELD_NUMBER
public static final int RETURN_ENTITY_QUOTA_FIELD_NUMBER
Field Value
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RunAccessReportRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RunAccessReportRequest.Builder newBuilder()
Returns
newBuilder(RunAccessReportRequest prototype)
public static RunAccessReportRequest.Builder newBuilder(RunAccessReportRequest prototype)
Parameter
Returns
public static RunAccessReportRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunAccessReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RunAccessReportRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunAccessReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RunAccessReportRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunAccessReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunAccessReportRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RunAccessReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunAccessReportRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunAccessReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RunAccessReportRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunAccessReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RunAccessReportRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.analytics.admin.v1alpha.AccessDateRangeOrBuilder> | |
getDefaultInstanceForType()
public RunAccessReportRequest getDefaultInstanceForType()
Returns
getDimensionFilter()
public AccessFilterExpression getDimensionFilter()
Dimension filters allow you to 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;
getDimensionFilterOrBuilder()
public AccessFilterExpressionOrBuilder getDimensionFilterOrBuilder()
Dimension filters allow you to 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;
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.analytics.admin.v1alpha.AccessDimensionOrBuilder> | |
getEntity()
public String getEntity()
The Data Access Report is requested for this property.
For example if "123" is your GA4 property ID, then entity should be
"properties/123".
string entity = 1;
| Type | Description |
| String | The entity.
|
getEntityBytes()
public ByteString getEntityBytes()
The Data Access Report is requested for this property.
For example if "123" is your GA4 property ID, then entity should be
"properties/123".
string entity = 1;
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;
| 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;
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;
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.analytics.admin.v1alpha.AccessMetricOrBuilder> | |
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;
| 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;
getOrderBysCount()
public int getOrderBysCount()
Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
getOrderBysList()
public List<AccessOrderBy> getOrderBysList()
Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
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;
getOrderBysOrBuilderList()
public List<? extends AccessOrderByOrBuilder> getOrderBysOrBuilderList()
Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Type | Description |
| List<? extends com.google.analytics.admin.v1alpha.AccessOrderByOrBuilder> | |
getParserForType()
public Parser<RunAccessReportRequest> getParserForType()
Returns
Overrides
getReturnEntityQuota()
public boolean getReturnEntityQuota()
Toggles whether to return the current state of this Analytics Property's
quota. Quota is returned in AccessQuota.
bool return_entity_quota = 11;
| Type | Description |
| boolean | The returnEntityQuota.
|
getSerializedSize()
public int getSerializedSize()
Returns
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;
| 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDimensionFilter()
public boolean hasDimensionFilter()
Dimension filters allow you to 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;
| 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;
| Type | Description |
| boolean | Whether the metricFilter field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RunAccessReportRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunAccessReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RunAccessReportRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
