- 0.70.0 (latest)
- 0.69.0
- 0.68.0
- 0.67.0
- 0.66.0
- 0.65.0
- 0.64.0
- 0.63.0
- 0.62.0
- 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
publicstaticfinalclassRunAccessReportRequest.BuilderextendsGeneratedMessageV3.Builder<RunAccessReportRequest.Builder>implementsRunAccessReportRequestOrBuilderThe request for a Data Access Record Report.
Protobuf type google.analytics.admin.v1alpha.RunAccessReportRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunAccessReportRequest.BuilderImplements
RunAccessReportRequestOrBuilderStatic Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllDateRanges(Iterable<? extends AccessDateRange> values)
publicRunAccessReportRequest.BuilderaddAllDateRanges(Iterable<?extendsAccessDateRange>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.v1alpha.AccessDateRange date_ranges = 4;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.analytics.admin.v1alpha.AccessDateRange> |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addAllDimensions(Iterable<? extends AccessDimension> values)
publicRunAccessReportRequest.BuilderaddAllDimensions(Iterable<?extendsAccessDimension>values)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 |
values | Iterable<? extends com.google.analytics.admin.v1alpha.AccessDimension> |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addAllMetrics(Iterable<? extends AccessMetric> values)
publicRunAccessReportRequest.BuilderaddAllMetrics(Iterable<?extendsAccessMetric>values)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 |
values | Iterable<? extends com.google.analytics.admin.v1alpha.AccessMetric> |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addAllOrderBys(Iterable<? extends AccessOrderBy> values)
publicRunAccessReportRequest.BuilderaddAllOrderBys(Iterable<?extendsAccessOrderBy>values)Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.analytics.admin.v1alpha.AccessOrderBy> |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDateRanges(AccessDateRange value)
publicRunAccessReportRequest.BuilderaddDateRanges(AccessDateRangevalue)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 |
value | AccessDateRange |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDateRanges(AccessDateRange.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddDateRanges(AccessDateRange.BuilderbuilderForValue)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 |
builderForValue | AccessDateRange.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDateRanges(int index, AccessDateRange value)
publicRunAccessReportRequest.BuilderaddDateRanges(intindex,AccessDateRangevalue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessDateRange |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDateRanges(int index, AccessDateRange.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddDateRanges(intindex,AccessDateRange.BuilderbuilderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AccessDateRange.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDateRangesBuilder()
publicAccessDateRange.BuilderaddDateRangesBuilder()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 |
AccessDateRange.Builder | |
addDateRangesBuilder(int index)
publicAccessDateRange.BuilderaddDateRangesBuilder(intindex)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.Builder | |
addDimensions(AccessDimension value)
publicRunAccessReportRequest.BuilderaddDimensions(AccessDimensionvalue)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 |
value | AccessDimension |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDimensions(AccessDimension.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddDimensions(AccessDimension.BuilderbuilderForValue)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 |
builderForValue | AccessDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDimensions(int index, AccessDimension value)
publicRunAccessReportRequest.BuilderaddDimensions(intindex,AccessDimensionvalue)The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessDimension |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDimensions(int index, AccessDimension.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddDimensions(intindex,AccessDimension.BuilderbuilderForValue)The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AccessDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addDimensionsBuilder()
publicAccessDimension.BuilderaddDimensionsBuilder()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 |
AccessDimension.Builder | |
addDimensionsBuilder(int index)
publicAccessDimension.BuilderaddDimensionsBuilder(intindex)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.Builder | |
addMetrics(AccessMetric value)
publicRunAccessReportRequest.BuilderaddMetrics(AccessMetricvalue)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 |
value | AccessMetric |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addMetrics(AccessMetric.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddMetrics(AccessMetric.BuilderbuilderForValue)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 |
builderForValue | AccessMetric.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addMetrics(int index, AccessMetric value)
publicRunAccessReportRequest.BuilderaddMetrics(intindex,AccessMetricvalue)The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessMetric |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addMetrics(int index, AccessMetric.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddMetrics(intindex,AccessMetric.BuilderbuilderForValue)The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AccessMetric.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addMetricsBuilder()
publicAccessMetric.BuilderaddMetricsBuilder()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 |
AccessMetric.Builder | |
addMetricsBuilder(int index)
publicAccessMetric.BuilderaddMetricsBuilder(intindex)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.Builder | |
addOrderBys(AccessOrderBy value)
publicRunAccessReportRequest.BuilderaddOrderBys(AccessOrderByvalue)Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Parameter | |
|---|---|
| Name | Description |
value | AccessOrderBy |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addOrderBys(AccessOrderBy.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddOrderBys(AccessOrderBy.BuilderbuilderForValue)Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AccessOrderBy.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addOrderBys(int index, AccessOrderBy value)
publicRunAccessReportRequest.BuilderaddOrderBys(intindex,AccessOrderByvalue)Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessOrderBy |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addOrderBys(int index, AccessOrderBy.Builder builderForValue)
publicRunAccessReportRequest.BuilderaddOrderBys(intindex,AccessOrderBy.BuilderbuilderForValue)Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AccessOrderBy.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
addOrderBysBuilder()
publicAccessOrderBy.BuilderaddOrderBysBuilder()Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Returns | |
|---|---|
| Type | Description |
AccessOrderBy.Builder | |
addOrderBysBuilder(int index)
publicAccessOrderBy.BuilderaddOrderBysBuilder(intindex)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.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicRunAccessReportRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
build()
publicRunAccessReportRequestbuild()| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest | |
buildPartial()
publicRunAccessReportRequestbuildPartial()| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest | |
clear()
publicRunAccessReportRequest.Builderclear()| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
clearDateRanges()
publicRunAccessReportRequest.BuilderclearDateRanges()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 |
RunAccessReportRequest.Builder | |
clearDimensionFilter()
publicRunAccessReportRequest.BuilderclearDimensionFilter()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 |
RunAccessReportRequest.Builder | |
clearDimensions()
publicRunAccessReportRequest.BuilderclearDimensions()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 |
RunAccessReportRequest.Builder | |
clearEntity()
publicRunAccessReportRequest.BuilderclearEntity()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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID.
string entity = 1;
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
clearExpandGroups()
publicRunAccessReportRequest.BuilderclearExpandGroups()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 |
RunAccessReportRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
publicRunAccessReportRequest.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
clearIncludeAllUsers()
publicRunAccessReportRequest.BuilderclearIncludeAllUsers()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 |
RunAccessReportRequest.Builder | This builder for chaining. |
clearLimit()
publicRunAccessReportRequest.BuilderclearLimit() 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()
publicRunAccessReportRequest.BuilderclearMetricFilter()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 |
RunAccessReportRequest.Builder | |
clearMetrics()
publicRunAccessReportRequest.BuilderclearMetrics()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 |
RunAccessReportRequest.Builder | |
clearOffset()
publicRunAccessReportRequest.BuilderclearOffset() 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)
publicRunAccessReportRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
clearOrderBys()
publicRunAccessReportRequest.BuilderclearOrderBys()Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
clearReturnEntityQuota()
publicRunAccessReportRequest.BuilderclearReturnEntityQuota()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()
publicRunAccessReportRequest.BuilderclearTimeZone()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()
publicRunAccessReportRequest.Builderclone()| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
getDateRanges(int index)
publicAccessDateRangegetDateRanges(intindex)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 | |
getDateRangesBuilder(int index)
publicAccessDateRange.BuildergetDateRangesBuilder(intindex)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.Builder | |
getDateRangesBuilderList()
publicList<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.v1alpha.AccessDateRange date_ranges = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getDateRangesCount()
publicintgetDateRangesCount()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()
publicList<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)
publicAccessDateRangeOrBuildergetDateRangesOrBuilder(intindex)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()
publicList<?extendsAccessDateRangeOrBuilder>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()
publicRunAccessReportRequestgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest | |
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDimensionFilter()
publicAccessFilterExpressiongetDimensionFilter()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. |
getDimensionFilterBuilder()
publicAccessFilterExpression.BuildergetDimensionFilterBuilder()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.Builder | |
getDimensionFilterOrBuilder()
publicAccessFilterExpressionOrBuildergetDimensionFilterOrBuilder()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)
publicAccessDimensiongetDimensions(intindex)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 | |
getDimensionsBuilder(int index)
publicAccessDimension.BuildergetDimensionsBuilder(intindex)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.Builder | |
getDimensionsBuilderList()
publicList<AccessDimension.Builder>getDimensionsBuilderList()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<Builder> | |
getDimensionsCount()
publicintgetDimensionsCount()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()
publicList<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)
publicAccessDimensionOrBuildergetDimensionsOrBuilder(intindex)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()
publicList<?extendsAccessDimensionOrBuilder>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()
publicStringgetEntity()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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID.
string entity = 1;
| Returns | |
|---|---|
| Type | Description |
String | The entity. |
getEntityBytes()
publicByteStringgetEntityBytes()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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID.
string entity = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for entity. |
getExpandGroups()
publicbooleangetExpandGroups()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()
publicbooleangetIncludeAllUsers()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()
publiclonggetLimit() 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()
publicAccessFilterExpressiongetMetricFilter()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. |
getMetricFilterBuilder()
publicAccessFilterExpression.BuildergetMetricFilterBuilder()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.Builder | |
getMetricFilterOrBuilder()
publicAccessFilterExpressionOrBuildergetMetricFilterOrBuilder()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)
publicAccessMetricgetMetrics(intindex)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 | |
getMetricsBuilder(int index)
publicAccessMetric.BuildergetMetricsBuilder(intindex)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.Builder | |
getMetricsBuilderList()
publicList<AccessMetric.Builder>getMetricsBuilderList()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<Builder> | |
getMetricsCount()
publicintgetMetricsCount()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()
publicList<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)
publicAccessMetricOrBuildergetMetricsOrBuilder(intindex)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()
publicList<?extendsAccessMetricOrBuilder>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()
publiclonggetOffset() 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)
publicAccessOrderBygetOrderBys(intindex)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 | |
getOrderBysBuilder(int index)
publicAccessOrderBy.BuildergetOrderBysBuilder(intindex)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.Builder | |
getOrderBysBuilderList()
publicList<AccessOrderBy.Builder>getOrderBysBuilderList()Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getOrderBysCount()
publicintgetOrderBysCount()Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Returns | |
|---|---|
| Type | Description |
int | |
getOrderBysList()
publicList<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)
publicAccessOrderByOrBuildergetOrderBysOrBuilder(intindex)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()
publicList<?extendsAccessOrderByOrBuilder>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()
publicbooleangetReturnEntityQuota()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()
publicStringgetTimeZone()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()
publicByteStringgetTimeZoneBytes()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()
publicbooleanhasDimensionFilter()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()
publicbooleanhasMetricFilter()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. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeDimensionFilter(AccessFilterExpression value)
publicRunAccessReportRequest.BuildermergeDimensionFilter(AccessFilterExpressionvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value | AccessFilterExpression |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
mergeFrom(RunAccessReportRequest other)
publicRunAccessReportRequest.BuildermergeFrom(RunAccessReportRequestother)| Parameter | |
|---|---|
| Name | Description |
other | RunAccessReportRequest |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicRunAccessReportRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
publicRunAccessReportRequest.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
mergeMetricFilter(AccessFilterExpression value)
publicRunAccessReportRequest.BuildermergeMetricFilter(AccessFilterExpressionvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value | AccessFilterExpression |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalRunAccessReportRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
removeDateRanges(int index)
publicRunAccessReportRequest.BuilderremoveDateRanges(intindex)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 |
RunAccessReportRequest.Builder | |
removeDimensions(int index)
publicRunAccessReportRequest.BuilderremoveDimensions(intindex)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 |
RunAccessReportRequest.Builder | |
removeMetrics(int index)
publicRunAccessReportRequest.BuilderremoveMetrics(intindex)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 |
RunAccessReportRequest.Builder | |
removeOrderBys(int index)
publicRunAccessReportRequest.BuilderremoveOrderBys(intindex)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 |
RunAccessReportRequest.Builder | |
setDateRanges(int index, AccessDateRange value)
publicRunAccessReportRequest.BuildersetDateRanges(intindex,AccessDateRangevalue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessDateRange |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setDateRanges(int index, AccessDateRange.Builder builderForValue)
publicRunAccessReportRequest.BuildersetDateRanges(intindex,AccessDateRange.BuilderbuilderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AccessDateRange.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setDimensionFilter(AccessFilterExpression value)
publicRunAccessReportRequest.BuildersetDimensionFilter(AccessFilterExpressionvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value | AccessFilterExpression |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setDimensionFilter(AccessFilterExpression.Builder builderForValue)
publicRunAccessReportRequest.BuildersetDimensionFilter(AccessFilterExpression.BuilderbuilderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AccessFilterExpression.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setDimensions(int index, AccessDimension value)
publicRunAccessReportRequest.BuildersetDimensions(intindex,AccessDimensionvalue)The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessDimension |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setDimensions(int index, AccessDimension.Builder builderForValue)
publicRunAccessReportRequest.BuildersetDimensions(intindex,AccessDimension.BuilderbuilderForValue)The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1alpha.AccessDimension dimensions = 2;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AccessDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setEntity(String value)
publicRunAccessReportRequest.BuildersetEntity(Stringvalue)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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID.
string entity = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe entity to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setEntityBytes(ByteString value)
publicRunAccessReportRequest.BuildersetEntityBytes(ByteStringvalue)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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID.
string entity = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for entity to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setExpandGroups(boolean value)
publicRunAccessReportRequest.BuildersetExpandGroups(booleanvalue)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe expandGroups to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
publicRunAccessReportRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setIncludeAllUsers(boolean value)
publicRunAccessReportRequest.BuildersetIncludeAllUsers(booleanvalue)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe includeAllUsers to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setLimit(long value)
publicRunAccessReportRequest.BuildersetLimit(longvalue) 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 | longThe limit to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setMetricFilter(AccessFilterExpression value)
publicRunAccessReportRequest.BuildersetMetricFilter(AccessFilterExpressionvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value | AccessFilterExpression |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setMetricFilter(AccessFilterExpression.Builder builderForValue)
publicRunAccessReportRequest.BuildersetMetricFilter(AccessFilterExpression.BuilderbuilderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AccessFilterExpression.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setMetrics(int index, AccessMetric value)
publicRunAccessReportRequest.BuildersetMetrics(intindex,AccessMetricvalue)The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessMetric |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setMetrics(int index, AccessMetric.Builder builderForValue)
publicRunAccessReportRequest.BuildersetMetrics(intindex,AccessMetric.BuilderbuilderForValue)The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1alpha.AccessMetric metrics = 3;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AccessMetric.Builder |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setOffset(long value)
publicRunAccessReportRequest.BuildersetOffset(longvalue) 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 | longThe offset to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setOrderBys(int index, AccessOrderBy value)
publicRunAccessReportRequest.BuildersetOrderBys(intindex,AccessOrderByvalue)Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AccessOrderBy |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setOrderBys(int index, AccessOrderBy.Builder builderForValue)
publicRunAccessReportRequest.BuildersetOrderBys(intindex,AccessOrderBy.BuilderbuilderForValue)Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1alpha.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)
publicRunAccessReportRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
setReturnEntityQuota(boolean value)
publicRunAccessReportRequest.BuildersetReturnEntityQuota(booleanvalue)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 | booleanThe returnEntityQuota to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setTimeZone(String value)
publicRunAccessReportRequest.BuildersetTimeZone(Stringvalue)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 | StringThe timeZone to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setTimeZoneBytes(ByteString value)
publicRunAccessReportRequest.BuildersetTimeZoneBytes(ByteStringvalue)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 | ByteStringThe bytes for timeZone to set. |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalRunAccessReportRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RunAccessReportRequest.Builder | |
