Package com.google.analytics.data.v1alpha

Interface RunReportRequestOrBuilder

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

  • Method Details

    • getProperty

      String getProperty()
       Required. A Google Analytics property identifier whose events are tracked.
 Specified in the URL path and not the body. To learn more, see [where to
 find your Property
 ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
 Within a batch request, this property should either be unspecified or
 consistent with the batch-level property.

 Example: properties/1234
      string property = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The property.

    • getPropertyBytes

      com.google.protobuf.ByteString getPropertyBytes()
       Required. A Google Analytics property identifier whose events are tracked.
 Specified in the URL path and not the body. To learn more, see [where to
 find your Property
 ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
 Within a batch request, this property should either be unspecified or
 consistent with the batch-level property.

 Example: properties/1234
      string property = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for property.

    • getDimensionsList

      List<Dimension> getDimensionsList()
       Optional. The dimensions requested and displayed.
      repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDimensions

      Dimension getDimensions(int index)
       Optional. The dimensions requested and displayed.
      repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDimensionsCount

      int getDimensionsCount()
       Optional. The dimensions requested and displayed.
      repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDimensionsOrBuilderList

      List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()
       Optional. The dimensions requested and displayed.
      repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDimensionsOrBuilder

      DimensionOrBuilder getDimensionsOrBuilder(int index)
       Optional. The dimensions requested and displayed.
      repeated .google.analytics.data.v1alpha.Dimension dimensions = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getMetricsList

      List<Metric> getMetricsList()
       Optional. The metrics requested and displayed.
      repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getMetrics

      Metric getMetrics(int index)
       Optional. The metrics requested and displayed.
      repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getMetricsCount

      int getMetricsCount()
       Optional. The metrics requested and displayed.
      repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getMetricsOrBuilderList

      List<? extends MetricOrBuilder> getMetricsOrBuilderList()
       Optional. The metrics requested and displayed.
      repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getMetricsOrBuilder

      MetricOrBuilder getMetricsOrBuilder(int index)
       Optional. The metrics requested and displayed.
      repeated .google.analytics.data.v1alpha.Metric metrics = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getDateRangesList

      List<DateRange> getDateRangesList()
       Optional. Date ranges of data 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 event data for the overlapping days is
 included in the response rows for both date ranges. In a cohort request,
 this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDateRanges

      DateRange getDateRanges(int index)
       Optional. Date ranges of data 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 event data for the overlapping days is
 included in the response rows for both date ranges. In a cohort request,
 this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDateRangesCount

      int getDateRangesCount()
       Optional. Date ranges of data 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 event data for the overlapping days is
 included in the response rows for both date ranges. In a cohort request,
 this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDateRangesOrBuilderList

      List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()
       Optional. Date ranges of data 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 event data for the overlapping days is
 included in the response rows for both date ranges. In a cohort request,
 this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDateRangesOrBuilder

      DateRangeOrBuilder getDateRangesOrBuilder(int index)
       Optional. Date ranges of data 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 event data for the overlapping days is
 included in the response rows for both date ranges. In a cohort request,
 this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1alpha.DateRange date_ranges = 4 [(.google.api.field_behavior) = OPTIONAL];

    • hasDimensionFilter

      boolean hasDimensionFilter()
       Optional. Dimension filters let you ask for only specific dimension values
 in the report. 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.data.v1alpha.FilterExpression dimension_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the dimensionFilter field is set.

    • getDimensionFilter

      FilterExpression getDimensionFilter()
       Optional. Dimension filters let you ask for only specific dimension values
 in the report. 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.data.v1alpha.FilterExpression dimension_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The dimensionFilter.

    • getDimensionFilterOrBuilder

      FilterExpressionOrBuilder getDimensionFilterOrBuilder()
       Optional. Dimension filters let you ask for only specific dimension values
 in the report. 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.data.v1alpha.FilterExpression dimension_filter = 5 [(.google.api.field_behavior) = OPTIONAL];

    • hasMetricFilter

      boolean hasMetricFilter()
       Optional. The filter clause of metrics. Applied after aggregating the
 report's rows, similar to SQL having-clause. Dimensions cannot be used in
 this filter.
      .google.analytics.data.v1alpha.FilterExpression metric_filter = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the metricFilter field is set.

    • getMetricFilter

      FilterExpression getMetricFilter()
       Optional. The filter clause of metrics. Applied after aggregating the
 report's rows, similar to SQL having-clause. Dimensions cannot be used in
 this filter.
      .google.analytics.data.v1alpha.FilterExpression metric_filter = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The metricFilter.

    • getMetricFilterOrBuilder

      FilterExpressionOrBuilder getMetricFilterOrBuilder()
       Optional. The filter clause of metrics. Applied after aggregating the
 report's rows, similar to SQL having-clause. Dimensions cannot be used in
 this filter.
      .google.analytics.data.v1alpha.FilterExpression metric_filter = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getOffset

      long getOffset()
       Optional. The row count of the start row. The first row is counted as row
 0.

 When paging, the first request does not specify offset; or equivalently,
 sets offset to 0; the first request returns the first `limit` of rows. The
 second request sets offset to the `limit` of the first request; the second
 request returns the second `limit` of rows.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 offset = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The offset.

    • getLimit

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

 The API can also return fewer rows than the requested `limit`, if there
 aren't as many dimension values 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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The limit.

    • getMetricAggregationsList

      List<MetricAggregation> getMetricAggregationsList()
       Optional. Aggregation of metrics. Aggregated metric values will be shown in
 rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
 Aggregates including both comparisons and multiple date ranges will
 be aggregated based on the date ranges.
      repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the metricAggregations.

    • getMetricAggregationsCount

      int getMetricAggregationsCount()
       Optional. Aggregation of metrics. Aggregated metric values will be shown in
 rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
 Aggregates including both comparisons and multiple date ranges will
 be aggregated based on the date ranges.
      repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of metricAggregations.

    • getMetricAggregations

      MetricAggregation getMetricAggregations(int index)
       Optional. Aggregation of metrics. Aggregated metric values will be shown in
 rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
 Aggregates including both comparisons and multiple date ranges will
 be aggregated based on the date ranges.
      repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The metricAggregations at the given index.

    • getMetricAggregationsValueList

      List<Integer> getMetricAggregationsValueList()
       Optional. Aggregation of metrics. Aggregated metric values will be shown in
 rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
 Aggregates including both comparisons and multiple date ranges will
 be aggregated based on the date ranges.
      repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the enum numeric values on the wire for metricAggregations.

    • getMetricAggregationsValue

      int getMetricAggregationsValue(int index)
       Optional. Aggregation of metrics. Aggregated metric values will be shown in
 rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
 Aggregates including both comparisons and multiple date ranges will
 be aggregated based on the date ranges.
      repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 9 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of metricAggregations at the given index.

    • getOrderBysList

      List<OrderBy> getOrderBysList()
       Optional. Specifies how rows are ordered in the response.
 Requests including both comparisons and multiple date ranges will
 have order bys applied on the comparisons.
      repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getOrderBys

      OrderBy getOrderBys(int index)
       Optional. Specifies how rows are ordered in the response.
 Requests including both comparisons and multiple date ranges will
 have order bys applied on the comparisons.
      repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getOrderBysCount

      int getOrderBysCount()
       Optional. Specifies how rows are ordered in the response.
 Requests including both comparisons and multiple date ranges will
 have order bys applied on the comparisons.
      repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getOrderBysOrBuilderList

      List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()
       Optional. Specifies how rows are ordered in the response.
 Requests including both comparisons and multiple date ranges will
 have order bys applied on the comparisons.
      repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getOrderBysOrBuilder

      OrderByOrBuilder getOrderBysOrBuilder(int index)
       Optional. Specifies how rows are ordered in the response.
 Requests including both comparisons and multiple date ranges will
 have order bys applied on the comparisons.
      repeated .google.analytics.data.v1alpha.OrderBy order_bys = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getCurrencyCode

      String getCurrencyCode()
       Optional. A currency code in ISO4217 format, such as "AED", "USD", "JPY".
 If the field is empty, the report uses the property's default currency.
      string currency_code = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      com.google.protobuf.ByteString getCurrencyCodeBytes()
       Optional. A currency code in ISO4217 format, such as "AED", "USD", "JPY".
 If the field is empty, the report uses the property's default currency.
      string currency_code = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for currencyCode.

    • hasCohortSpec

      boolean hasCohortSpec()
       Optional. Cohort group associated with this request. If there is a cohort
 group in the request the 'cohort' dimension must be present.
      .google.analytics.data.v1alpha.CohortSpec cohort_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the cohortSpec field is set.

    • getCohortSpec

      CohortSpec getCohortSpec()
       Optional. Cohort group associated with this request. If there is a cohort
 group in the request the 'cohort' dimension must be present.
      .google.analytics.data.v1alpha.CohortSpec cohort_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The cohortSpec.

    • getCohortSpecOrBuilder

      CohortSpecOrBuilder getCohortSpecOrBuilder()
       Optional. Cohort group associated with this request. If there is a cohort
 group in the request the 'cohort' dimension must be present.
      .google.analytics.data.v1alpha.CohortSpec cohort_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getKeepEmptyRows

      boolean getKeepEmptyRows()
       Optional. If false or unspecified, each row with all metrics equal to 0
 will not be returned. If true, these rows will be returned if they are not
 separately removed by a filter.

 Regardless of this `keep_empty_rows` setting, only data recorded by the
 Google Analytics property can be displayed in a report.

 For example if a property never logs a `purchase` event, then a query for
 the `eventName` dimension and  `eventCount` metric will not have a row
 eventName: "purchase" and eventCount: 0.
      bool keep_empty_rows = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The keepEmptyRows.

    • getReturnPropertyQuota

      boolean getReturnPropertyQuota()
       Optional. Toggles whether to return the current state of this Google
 Analytics property's quota. Quota is returned in
 [PropertyQuota](#PropertyQuota).
      bool return_property_quota = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The returnPropertyQuota.

    • getComparisonsList

      List<Comparison> getComparisonsList()
       Optional. The configuration of comparisons requested and displayed. The
 request only requires a comparisons field in order to receive a comparison
 column in the response.
      repeated .google.analytics.data.v1alpha.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

    • getComparisons

      Comparison getComparisons(int index)
       Optional. The configuration of comparisons requested and displayed. The
 request only requires a comparisons field in order to receive a comparison
 column in the response.
      repeated .google.analytics.data.v1alpha.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

    • getComparisonsCount

      int getComparisonsCount()
       Optional. The configuration of comparisons requested and displayed. The
 request only requires a comparisons field in order to receive a comparison
 column in the response.
      repeated .google.analytics.data.v1alpha.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

    • getComparisonsOrBuilderList

      List<? extends ComparisonOrBuilder> getComparisonsOrBuilderList()
       Optional. The configuration of comparisons requested and displayed. The
 request only requires a comparisons field in order to receive a comparison
 column in the response.
      repeated .google.analytics.data.v1alpha.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

    • getComparisonsOrBuilder

      ComparisonOrBuilder getComparisonsOrBuilder(int index)
       Optional. The configuration of comparisons requested and displayed. The
 request only requires a comparisons field in order to receive a comparison
 column in the response.
      repeated .google.analytics.data.v1alpha.Comparison comparisons = 15 [(.google.api.field_behavior) = OPTIONAL];

    • hasConversionSpec

      boolean hasConversionSpec()
       Optional. Controls conversion reporting. This field is optional. If this
 field is set or any conversion metrics are requested, the report will be a
 conversion report.
      .google.analytics.data.v1alpha.ConversionSpec conversion_spec = 16 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the conversionSpec field is set.

    • getConversionSpec

      ConversionSpec getConversionSpec()
       Optional. Controls conversion reporting. This field is optional. If this
 field is set or any conversion metrics are requested, the report will be a
 conversion report.
      .google.analytics.data.v1alpha.ConversionSpec conversion_spec = 16 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The conversionSpec.

    • getConversionSpecOrBuilder

      ConversionSpecOrBuilder getConversionSpecOrBuilder()
       Optional. Controls conversion reporting. This field is optional. If this
 field is set or any conversion metrics are requested, the report will be a
 conversion report.
      .google.analytics.data.v1alpha.ConversionSpec conversion_spec = 16 [(.google.api.field_behavior) = OPTIONAL];