publicfinalclassRunAccessReportRequestextendsGeneratedMessageV3implementsRunAccessReportRequestOrBuilder
The request for a Data Access Record Report.
Protobuf type google.analytics.admin.v1beta.RunAccessReportRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATE_RANGES_FIELD_NUMBER
publicstaticfinalintDATE_RANGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIMENSIONS_FIELD_NUMBER
publicstaticfinalintDIMENSIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIMENSION_FILTER_FIELD_NUMBER
publicstaticfinalintDIMENSION_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENTITY_FIELD_NUMBER
publicstaticfinalintENTITY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXPAND_GROUPS_FIELD_NUMBER
publicstaticfinalintEXPAND_GROUPS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INCLUDE_ALL_USERS_FIELD_NUMBER
publicstaticfinalintINCLUDE_ALL_USERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LIMIT_FIELD_NUMBER
publicstaticfinalintLIMIT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRICS_FIELD_NUMBER
publicstaticfinalintMETRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_FILTER_FIELD_NUMBER
publicstaticfinalintMETRIC_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OFFSET_FIELD_NUMBER
publicstaticfinalintOFFSET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_BYS_FIELD_NUMBER
publicstaticfinalintORDER_BYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETURN_ENTITY_QUOTA_FIELD_NUMBER
publicstaticfinalintRETURN_ENTITY_QUOTA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIME_ZONE_FIELD_NUMBER
publicstaticfinalintTIME_ZONE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
publicstaticRunAccessReportRequestgetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticRunAccessReportRequest.BuildernewBuilder()
newBuilder(RunAccessReportRequest prototype)
publicstaticRunAccessReportRequest.BuildernewBuilder(RunAccessReportRequestprototype)
publicstaticRunAccessReportRequestparseDelimitedFrom(InputStreaminput)
publicstaticRunAccessReportRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticRunAccessReportRequestparseFrom(byte[]data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticRunAccessReportRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticRunAccessReportRequestparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticRunAccessReportRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticRunAccessReportRequestparseFrom(CodedInputStreaminput)
publicstaticRunAccessReportRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticRunAccessReportRequestparseFrom(InputStreaminput)
publicstaticRunAccessReportRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticRunAccessReportRequestparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticRunAccessReportRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<RunAccessReportRequest>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetDateRanges(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.v1beta.AccessDateRange date_ranges = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta.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.v1beta.AccessDateRange date_ranges = 4;
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.v1beta.AccessDateRange date_ranges = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta.AccessDateRange date_ranges = 4;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.admin.v1beta.AccessDateRangeOrBuilder> | |
getDefaultInstanceForType()
publicRunAccessReportRequestgetDefaultInstanceForType()
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.v1beta.AccessFilterExpression dimension_filter = 5;
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.v1beta.AccessFilterExpression dimension_filter = 5;
getDimensions(int index)
publicAccessDimensiongetDimensions(intindex)
The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getDimensionsCount()
publicintgetDimensionsCount()
The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;
| Returns |
|---|
| Type | Description |
int | |
getDimensionsList()
publicList<AccessDimension>getDimensionsList()
The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;
getDimensionsOrBuilder(int index)
publicAccessDimensionOrBuildergetDimensionsOrBuilder(intindex)
The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getDimensionsOrBuilderList()
publicList<?extendsAccessDimensionOrBuilder>getDimensionsOrBuilderList()
The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.admin.v1beta.AccessDimensionOrBuilder> | |
getEntity()
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()
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.v1beta.AccessFilterExpression metric_filter = 6;
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.v1beta.AccessFilterExpression metric_filter = 6;
getMetrics(int index)
publicAccessMetricgetMetrics(intindex)
The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getMetricsCount()
publicintgetMetricsCount()
The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;
| Returns |
|---|
| Type | Description |
int | |
getMetricsList()
publicList<AccessMetric>getMetricsList()
The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;
getMetricsOrBuilder(int index)
publicAccessMetricOrBuildergetMetricsOrBuilder(intindex)
The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getMetricsOrBuilderList()
publicList<?extendsAccessMetricOrBuilder>getMetricsOrBuilderList()
The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.admin.v1beta.AccessMetricOrBuilder> | |
getOffset()
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.v1beta.AccessOrderBy order_bys = 10;
| Parameter |
|---|
| Name | Description |
index | int
|
getOrderBysCount()
publicintgetOrderBysCount()
Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;
| Returns |
|---|
| Type | Description |
int | |
getOrderBysList()
publicList<AccessOrderBy>getOrderBysList()
Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;
getOrderBysOrBuilder(int index)
publicAccessOrderByOrBuildergetOrderBysOrBuilder(intindex)
Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;
| Parameter |
|---|
| Name | Description |
index | int
|
getOrderBysOrBuilderList()
publicList<?extendsAccessOrderByOrBuilder>getOrderBysOrBuilderList()
Specifies how rows are ordered in the response.
repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.admin.v1beta.AccessOrderByOrBuilder> | |
getParserForType()
publicParser<RunAccessReportRequest>getParserForType()
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. |
getSerializedSize()
publicintgetSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverridesgetTimeZone()
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.v1beta.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.v1beta.AccessFilterExpression metric_filter = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the metricFilter field is set. |
hashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
isInitialized()
publicfinalbooleanisInitialized()
newBuilderForType()
publicRunAccessReportRequest.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedRunAccessReportRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
toBuilder()
publicRunAccessReportRequest.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
