Package com.google.analytics.data.v1alpha

Interface ReportTask.ReportDefinitionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReportTask.ReportDefinition, ReportTask.ReportDefinition.Builder
Enclosing class:
ReportTask
public static interface ReportTask.ReportDefinitionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • 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 from Google Analytics Storage.
 The first row is counted as row 0.

 When creating a report task, the `offset` and `limit` parameters define
 the subset of data rows from Google Analytics storage to be included in
 the generated report. For example, if there are a total of 300,000 rows
 in Google Analytics storage, the initial report task may have the
 first 10,000 rows with a limit of 10,000 and an offset of 0.
 Subsequently, another report task could cover the next 10,000 rows with a
 limit of 10,000 and an offset of 10,000.
      int64 offset = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The offset.

    • getLimit

      long getLimit()
       Optional. The number of rows to return in the Report. 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.
      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)".
      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)".
      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)".
      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)".
      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)".
      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.
      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.
      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.
      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.
      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.
      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
 containing eventName: "purchase" and eventCount: 0.
      bool keep_empty_rows = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The keepEmptyRows.

    • hasSamplingLevel

      boolean hasSamplingLevel()
       Optional. The report's sampling level.
      optional .google.analytics.data.v1alpha.SamplingLevel sampling_level = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the samplingLevel field is set.

    • getSamplingLevelValue

      int getSamplingLevelValue()
       Optional. The report's sampling level.
      optional .google.analytics.data.v1alpha.SamplingLevel sampling_level = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for samplingLevel.

    • getSamplingLevel

      SamplingLevel getSamplingLevel()
       Optional. The report's sampling level.
      optional .google.analytics.data.v1alpha.SamplingLevel sampling_level = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The samplingLevel.