Package com.google.analytics.admin.v1alpha

Class RunAccessReportRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.admin.v1alpha.RunAccessReportRequest
All Implemented Interfaces:
RunAccessReportRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RunAccessReportRequest extends com.google.protobuf.GeneratedMessage implements RunAccessReportRequestOrBuilder
 The request for a Data Access Record Report.
Protobuf type google.analytics.admin.v1alpha.RunAccessReportRequest
See Also:

  • Field Details

    • ENTITY_FIELD_NUMBER

      public static final int ENTITY_FIELD_NUMBER
      See Also:

    • DIMENSIONS_FIELD_NUMBER

      public static final int DIMENSIONS_FIELD_NUMBER
      See Also:

    • METRICS_FIELD_NUMBER

      public static final int METRICS_FIELD_NUMBER
      See Also:

    • DATE_RANGES_FIELD_NUMBER

      public static final int DATE_RANGES_FIELD_NUMBER
      See Also:

    • DIMENSION_FILTER_FIELD_NUMBER

      public static final int DIMENSION_FILTER_FIELD_NUMBER
      See Also:

    • METRIC_FILTER_FIELD_NUMBER

      public static final int METRIC_FILTER_FIELD_NUMBER
      See Also:

    • OFFSET_FIELD_NUMBER

      public static final int OFFSET_FIELD_NUMBER
      See Also:

    • LIMIT_FIELD_NUMBER

      public static final int LIMIT_FIELD_NUMBER
      See Also:

    • TIME_ZONE_FIELD_NUMBER

      public static final int TIME_ZONE_FIELD_NUMBER
      See Also:

    • ORDER_BYS_FIELD_NUMBER

      public static final int ORDER_BYS_FIELD_NUMBER
      See Also:

    • RETURN_ENTITY_QUOTA_FIELD_NUMBER

      public static final int RETURN_ENTITY_QUOTA_FIELD_NUMBER
      See Also:

    • INCLUDE_ALL_USERS_FIELD_NUMBER

      public static final int INCLUDE_ALL_USERS_FIELD_NUMBER
      See Also:

    • EXPAND_GROUPS_FIELD_NUMBER

      public static final int EXPAND_GROUPS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getEntity

      public String getEntity()
       The Data Access Report supports requesting at the property level or account
 level. If requested at the account level, Data Access Reports include all
 access for all properties under that account.

 To request at the property level, entity should be for example
 'properties/123' if "123" is your 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;
      Specified by:
      getEntity in interface RunAccessReportRequestOrBuilder
      Returns:
      The entity.

    • getEntityBytes

      public com.google.protobuf.ByteString getEntityBytes()
       The Data Access Report supports requesting at the property level or account
 level. If requested at the account level, Data Access Reports include all
 access for all properties under that account.

 To request at the property level, entity should be for example
 'properties/123' if "123" is your 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;
      Specified by:
      getEntityBytes in interface RunAccessReportRequestOrBuilder
      Returns:
      The bytes for entity.

    • 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;
      Specified by:
      getDimensionsList in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getDimensionsOrBuilderList in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getDimensionsCount in interface RunAccessReportRequestOrBuilder

    • getDimensions

      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;
      Specified by:
      getDimensions in interface RunAccessReportRequestOrBuilder

    • getDimensionsOrBuilder

      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;
      Specified by:
      getDimensionsOrBuilder in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getMetricsList in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getMetricsOrBuilderList in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getMetricsCount in interface RunAccessReportRequestOrBuilder

    • getMetrics

      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;
      Specified by:
      getMetrics in interface RunAccessReportRequestOrBuilder

    • getMetricsOrBuilder

      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;
      Specified by:
      getMetricsOrBuilder in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getDateRangesList in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getDateRangesOrBuilderList in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      getDateRangesCount in interface RunAccessReportRequestOrBuilder

    • getDateRanges

      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;
      Specified by:
      getDateRanges in interface RunAccessReportRequestOrBuilder

    • getDateRangesOrBuilder

      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;
      Specified by:
      getDateRangesOrBuilder in interface RunAccessReportRequestOrBuilder

    • hasDimensionFilter

      public boolean hasDimensionFilter()
       Dimension filters let you restrict report response to specific
 dimension values which match the filter. For example, filtering on access
 records of a single user. To learn more, see [Fundamentals of Dimension
 Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
 for examples. Metrics cannot be used in this filter.
      .google.analytics.admin.v1alpha.AccessFilterExpression dimension_filter = 5;
      Specified by:
      hasDimensionFilter in interface RunAccessReportRequestOrBuilder
      Returns:
      Whether the dimensionFilter field is set.

    • getDimensionFilter

      public AccessFilterExpression getDimensionFilter()
       Dimension filters let you restrict report response to specific
 dimension values which match the filter. For example, filtering on access
 records of a single user. To learn more, see [Fundamentals of Dimension
 Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
 for examples. Metrics cannot be used in this filter.
      .google.analytics.admin.v1alpha.AccessFilterExpression dimension_filter = 5;
      Specified by:
      getDimensionFilter in interface RunAccessReportRequestOrBuilder
      Returns:
      The dimensionFilter.

    • getDimensionFilterOrBuilder

      public AccessFilterExpressionOrBuilder getDimensionFilterOrBuilder()
       Dimension filters let you restrict report response to specific
 dimension values which match the filter. For example, filtering on access
 records of a single user. To learn more, see [Fundamentals of Dimension
 Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
 for examples. Metrics cannot be used in this filter.
      .google.analytics.admin.v1alpha.AccessFilterExpression dimension_filter = 5;
      Specified by:
      getDimensionFilterOrBuilder in interface RunAccessReportRequestOrBuilder

    • 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;
      Specified by:
      hasMetricFilter in interface RunAccessReportRequestOrBuilder
      Returns:
      Whether the metricFilter field is set.

    • 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;
      Specified by:
      getMetricFilter in interface RunAccessReportRequestOrBuilder
      Returns:
      The metricFilter.

    • getMetricFilterOrBuilder

      public AccessFilterExpressionOrBuilder getMetricFilterOrBuilder()
       Metric filters allow you to restrict report response to specific metric
 values which match the filter. Metric filters are applied after aggregating
 the report's rows, similar to SQL having-clause. Dimensions cannot be used
 in this filter.
      .google.analytics.admin.v1alpha.AccessFilterExpression metric_filter = 6;
      Specified by:
      getMetricFilterOrBuilder in interface RunAccessReportRequestOrBuilder

    • getOffset

      public long getOffset()
       The row count of the start row. The first row is counted as row 0. If
 offset is unspecified, it is treated as 0. If offset is zero, then this
 method will return the first page of results with `limit` entries.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 offset = 7;
      Specified by:
      getOffset in interface RunAccessReportRequestOrBuilder
      Returns:
      The offset.

    • getLimit

      public long getLimit()
       The number of rows to return. If unspecified, 10,000 rows are returned. The
 API returns a maximum of 100,000 rows per request, no matter how many you
 ask for. `limit` must be positive.

 The API may return fewer rows than the requested `limit`, if there aren't
 as many remaining rows as the `limit`. For instance, there are fewer than
 300 possible values for the dimension `country`, so when reporting on only
 `country`, you can't get more than 300 rows, even if you set `limit` to a
 higher value.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 limit = 8;
      Specified by:
      getLimit in interface RunAccessReportRequestOrBuilder
      Returns:
      The limit.

    • 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;
      Specified by:
      getTimeZone in interface RunAccessReportRequestOrBuilder
      Returns:
      The timeZone.

    • getTimeZoneBytes

      public com.google.protobuf.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;
      Specified by:
      getTimeZoneBytes in interface RunAccessReportRequestOrBuilder
      Returns:
      The bytes for timeZone.

    • getOrderBysList

      public List<AccessOrderBy> getOrderBysList()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
      Specified by:
      getOrderBysList in interface RunAccessReportRequestOrBuilder

    • getOrderBysOrBuilderList

      public List<? extends AccessOrderByOrBuilder> getOrderBysOrBuilderList()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
      Specified by:
      getOrderBysOrBuilderList in interface RunAccessReportRequestOrBuilder

    • getOrderBysCount

      public int getOrderBysCount()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
      Specified by:
      getOrderBysCount in interface RunAccessReportRequestOrBuilder

    • getOrderBys

      public AccessOrderBy getOrderBys(int index)
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
      Specified by:
      getOrderBys in interface RunAccessReportRequestOrBuilder

    • getOrderBysOrBuilder

      public AccessOrderByOrBuilder getOrderBysOrBuilder(int index)
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1alpha.AccessOrderBy order_bys = 10;
      Specified by:
      getOrderBysOrBuilder in interface RunAccessReportRequestOrBuilder

    • getReturnEntityQuota

      public boolean getReturnEntityQuota()
       Toggles whether to return the current state of this Analytics Property's
 quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level
 requests, this field must be false.
      bool return_entity_quota = 11;
      Specified by:
      getReturnEntityQuota in interface RunAccessReportRequestOrBuilder
      Returns:
      The returnEntityQuota.

    • getIncludeAllUsers

      public boolean getIncludeAllUsers()
       Optional. Determines whether to include users who have never made an API
 call in the response. If true, all users with access to the specified
 property or account are included in the response, regardless of whether
 they have made an API call or not. If false, only the users who have made
 an API call will be included.
      bool include_all_users = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIncludeAllUsers in interface RunAccessReportRequestOrBuilder
      Returns:
      The includeAllUsers.

    • getExpandGroups

      public boolean getExpandGroups()
       Optional. Decides whether to return the users within user groups. This
 field works only when include_all_users is set to true. If true, it will
 return all users with access to the specified property or account.
 If false, only the users with direct access will be returned.
      bool expand_groups = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpandGroups in interface RunAccessReportRequestOrBuilder
      Returns:
      The expandGroups.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RunAccessReportRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAccessReportRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAccessReportRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAccessReportRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAccessReportRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAccessReportRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunAccessReportRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunAccessReportRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunAccessReportRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunAccessReportRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunAccessReportRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunAccessReportRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RunAccessReportRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RunAccessReportRequest.Builder newBuilder()

    • newBuilder

      public static RunAccessReportRequest.Builder newBuilder(RunAccessReportRequest prototype)

    • toBuilder

      public RunAccessReportRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RunAccessReportRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RunAccessReportRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RunAccessReportRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RunAccessReportRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RunAccessReportRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder