Package com.google.analytics.admin.v1beta

Interface RunAccessReportRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RunAccessReportRequest, RunAccessReportRequest.Builder
@Generated public interface RunAccessReportRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getEntity

      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;
      Returns:
      The entity.

    • getEntityBytes

      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;
      Returns:
      The bytes for entity.

    • getDimensionsList

      List<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;

    • getDimensions

      AccessDimension getDimensions(int index)
       The dimensions requested and displayed in the response. Requests are
 allowed up to 9 dimensions.
      repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;

    • getDimensionsCount

      int getDimensionsCount()
       The dimensions requested and displayed in the response. Requests are
 allowed up to 9 dimensions.
      repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;

    • getDimensionsOrBuilderList

      List<? extends AccessDimensionOrBuilder> getDimensionsOrBuilderList()
       The dimensions requested and displayed in the response. Requests are
 allowed up to 9 dimensions.
      repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;

    • getDimensionsOrBuilder

      AccessDimensionOrBuilder getDimensionsOrBuilder(int index)
       The dimensions requested and displayed in the response. Requests are
 allowed up to 9 dimensions.
      repeated .google.analytics.admin.v1beta.AccessDimension dimensions = 2;

    • getMetricsList

      List<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;

    • getMetrics

      AccessMetric getMetrics(int index)
       The metrics requested and displayed in the response. Requests are allowed
 up to 10 metrics.
      repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;

    • getMetricsCount

      int getMetricsCount()
       The metrics requested and displayed in the response. Requests are allowed
 up to 10 metrics.
      repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;

    • getMetricsOrBuilderList

      List<? extends AccessMetricOrBuilder> getMetricsOrBuilderList()
       The metrics requested and displayed in the response. Requests are allowed
 up to 10 metrics.
      repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;

    • getMetricsOrBuilder

      AccessMetricOrBuilder getMetricsOrBuilder(int index)
       The metrics requested and displayed in the response. Requests are allowed
 up to 10 metrics.
      repeated .google.analytics.admin.v1beta.AccessMetric metrics = 3;

    • getDateRangesList

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

    • getDateRanges

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

    • getDateRangesCount

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

    • getDateRangesOrBuilderList

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

    • getDateRangesOrBuilder

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

    • hasDimensionFilter

      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.v1beta.AccessFilterExpression dimension_filter = 5;
      Returns:
      Whether the dimensionFilter field is set.

    • getDimensionFilter

      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.v1beta.AccessFilterExpression dimension_filter = 5;
      Returns:
      The dimensionFilter.

    • getDimensionFilterOrBuilder

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

    • hasMetricFilter

      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.v1beta.AccessFilterExpression metric_filter = 6;
      Returns:
      Whether the metricFilter field is set.

    • getMetricFilter

      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.v1beta.AccessFilterExpression metric_filter = 6;
      Returns:
      The metricFilter.

    • getMetricFilterOrBuilder

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

    • getOffset

      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;
      Returns:
      The offset.

    • getLimit

      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;
      Returns:
      The limit.

    • getTimeZone

      String getTimeZone()
       This request's time zone if specified. If unspecified, the property's time
 zone is used. The request's time zone is used to interpret the start & end
 dates of the report.

 Formatted as strings from the IANA Time Zone database
 (https://www.iana.org/time-zones); for example "America/New_York" or
 "Asia/Tokyo".
      string time_zone = 9;
      Returns:
      The timeZone.

    • getTimeZoneBytes

      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;
      Returns:
      The bytes for timeZone.

    • getOrderBysList

      List<AccessOrderBy> getOrderBysList()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;

    • getOrderBys

      AccessOrderBy getOrderBys(int index)
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;

    • getOrderBysCount

      int getOrderBysCount()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;

    • getOrderBysOrBuilderList

      List<? extends AccessOrderByOrBuilder> getOrderBysOrBuilderList()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;

    • getOrderBysOrBuilder

      AccessOrderByOrBuilder getOrderBysOrBuilder(int index)
       Specifies how rows are ordered in the response.
      repeated .google.analytics.admin.v1beta.AccessOrderBy order_bys = 10;

    • getReturnEntityQuota

      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;
      Returns:
      The returnEntityQuota.

    • getIncludeAllUsers

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

    • getExpandGroups

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