Package com.google.analytics.data.v1beta

Interface RunPivotReportRequestOrBuilder

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

  • Method Details

    • getProperty

      String getProperty()
       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;
      Returns:
      The property.

    • getPropertyBytes

      com.google.protobuf.ByteString getPropertyBytes()
       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;
      Returns:
      The bytes for property.

    • getDimensionsList

      List<Dimension> getDimensionsList()
       The dimensions requested. All defined dimensions must be used by one of the
 following: dimension_expression, dimension_filter, pivots, order_bys.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensions

      Dimension getDimensions(int index)
       The dimensions requested. All defined dimensions must be used by one of the
 following: dimension_expression, dimension_filter, pivots, order_bys.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensionsCount

      int getDimensionsCount()
       The dimensions requested. All defined dimensions must be used by one of the
 following: dimension_expression, dimension_filter, pivots, order_bys.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensionsOrBuilderList

      List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()
       The dimensions requested. All defined dimensions must be used by one of the
 following: dimension_expression, dimension_filter, pivots, order_bys.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensionsOrBuilder

      DimensionOrBuilder getDimensionsOrBuilder(int index)
       The dimensions requested. All defined dimensions must be used by one of the
 following: dimension_expression, dimension_filter, pivots, order_bys.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getMetricsList

      List<Metric> getMetricsList()
       The metrics requested, at least one metric needs to be specified. All
 defined metrics must be used by one of the following: metric_expression,
 metric_filter, order_bys.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetrics

      Metric getMetrics(int index)
       The metrics requested, at least one metric needs to be specified. All
 defined metrics must be used by one of the following: metric_expression,
 metric_filter, order_bys.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetricsCount

      int getMetricsCount()
       The metrics requested, at least one metric needs to be specified. All
 defined metrics must be used by one of the following: metric_expression,
 metric_filter, order_bys.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetricsOrBuilderList

      List<? extends MetricOrBuilder> getMetricsOrBuilderList()
       The metrics requested, at least one metric needs to be specified. All
 defined metrics must be used by one of the following: metric_expression,
 metric_filter, order_bys.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetricsOrBuilder

      MetricOrBuilder getMetricsOrBuilder(int index)
       The metrics requested, at least one metric needs to be specified. All
 defined metrics must be used by one of the following: metric_expression,
 metric_filter, order_bys.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getDateRangesList

      List<DateRange> getDateRangesList()
       The date range to retrieve event data for the report. If multiple date
 ranges are specified, event data from each date range is used in the
 report. A special dimension with field name "dateRange" can be included in
 a Pivot's field names; if included, the report compares between date
 ranges. In a cohort request, this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

    • getDateRanges

      DateRange getDateRanges(int index)
       The date range to retrieve event data for the report. If multiple date
 ranges are specified, event data from each date range is used in the
 report. A special dimension with field name "dateRange" can be included in
 a Pivot's field names; if included, the report compares between date
 ranges. In a cohort request, this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

    • getDateRangesCount

      int getDateRangesCount()
       The date range to retrieve event data for the report. If multiple date
 ranges are specified, event data from each date range is used in the
 report. A special dimension with field name "dateRange" can be included in
 a Pivot's field names; if included, the report compares between date
 ranges. In a cohort request, this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

    • getDateRangesOrBuilderList

      List<? extends DateRangeOrBuilder> getDateRangesOrBuilderList()
       The date range to retrieve event data for the report. If multiple date
 ranges are specified, event data from each date range is used in the
 report. A special dimension with field name "dateRange" can be included in
 a Pivot's field names; if included, the report compares between date
 ranges. In a cohort request, this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

    • getDateRangesOrBuilder

      DateRangeOrBuilder getDateRangesOrBuilder(int index)
       The date range to retrieve event data for the report. If multiple date
 ranges are specified, event data from each date range is used in the
 report. A special dimension with field name "dateRange" can be included in
 a Pivot's field names; if included, the report compares between date
 ranges. In a cohort request, this `dateRanges` must be unspecified.
      repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;

    • getPivotsList

      List<Pivot> getPivotsList()
       Describes the visual format of the report's dimensions in columns or rows.
 The union of the fieldNames (dimension names) in all pivots must be a
 subset of dimension names defined in Dimensions. No two pivots can share a
 dimension. A dimension is only visible if it appears in a pivot.
      repeated .google.analytics.data.v1beta.Pivot pivots = 5;

    • getPivots

      Pivot getPivots(int index)
       Describes the visual format of the report's dimensions in columns or rows.
 The union of the fieldNames (dimension names) in all pivots must be a
 subset of dimension names defined in Dimensions. No two pivots can share a
 dimension. A dimension is only visible if it appears in a pivot.
      repeated .google.analytics.data.v1beta.Pivot pivots = 5;

    • getPivotsCount

      int getPivotsCount()
       Describes the visual format of the report's dimensions in columns or rows.
 The union of the fieldNames (dimension names) in all pivots must be a
 subset of dimension names defined in Dimensions. No two pivots can share a
 dimension. A dimension is only visible if it appears in a pivot.
      repeated .google.analytics.data.v1beta.Pivot pivots = 5;

    • getPivotsOrBuilderList

      List<? extends PivotOrBuilder> getPivotsOrBuilderList()
       Describes the visual format of the report's dimensions in columns or rows.
 The union of the fieldNames (dimension names) in all pivots must be a
 subset of dimension names defined in Dimensions. No two pivots can share a
 dimension. A dimension is only visible if it appears in a pivot.
      repeated .google.analytics.data.v1beta.Pivot pivots = 5;

    • getPivotsOrBuilder

      PivotOrBuilder getPivotsOrBuilder(int index)
       Describes the visual format of the report's dimensions in columns or rows.
 The union of the fieldNames (dimension names) in all pivots must be a
 subset of dimension names defined in Dimensions. No two pivots can share a
 dimension. A dimension is only visible if it appears in a pivot.
      repeated .google.analytics.data.v1beta.Pivot pivots = 5;

    • hasDimensionFilter

      boolean hasDimensionFilter()
       The filter clause of dimensions. Dimensions must be requested to be used in
 this filter. Metrics cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression dimension_filter = 6;
      Returns:
      Whether the dimensionFilter field is set.

    • getDimensionFilter

      FilterExpression getDimensionFilter()
       The filter clause of dimensions. Dimensions must be requested to be used in
 this filter. Metrics cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression dimension_filter = 6;
      Returns:
      The dimensionFilter.

    • getDimensionFilterOrBuilder

      FilterExpressionOrBuilder getDimensionFilterOrBuilder()
       The filter clause of dimensions. Dimensions must be requested to be used in
 this filter. Metrics cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression dimension_filter = 6;

    • hasMetricFilter

      boolean hasMetricFilter()
       The filter clause of metrics. Applied at post aggregation phase, similar to
 SQL having-clause. Metrics must be requested to be used in this filter.
 Dimensions cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression metric_filter = 7;
      Returns:
      Whether the metricFilter field is set.

    • getMetricFilter

      FilterExpression getMetricFilter()
       The filter clause of metrics. Applied at post aggregation phase, similar to
 SQL having-clause. Metrics must be requested to be used in this filter.
 Dimensions cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression metric_filter = 7;
      Returns:
      The metricFilter.

    • getMetricFilterOrBuilder

      FilterExpressionOrBuilder getMetricFilterOrBuilder()
       The filter clause of metrics. Applied at post aggregation phase, similar to
 SQL having-clause. Metrics must be requested to be used in this filter.
 Dimensions cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression metric_filter = 7;

    • getCurrencyCode

      String getCurrencyCode()
       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 = 8;
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      com.google.protobuf.ByteString getCurrencyCodeBytes()
       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 = 8;
      Returns:
      The bytes for currencyCode.

    • hasCohortSpec

      boolean hasCohortSpec()
       Cohort group associated with this request. If there is a cohort group
 in the request the 'cohort' dimension must be present.
      .google.analytics.data.v1beta.CohortSpec cohort_spec = 9;
      Returns:
      Whether the cohortSpec field is set.

    • getCohortSpec

      CohortSpec getCohortSpec()
       Cohort group associated with this request. If there is a cohort group
 in the request the 'cohort' dimension must be present.
      .google.analytics.data.v1beta.CohortSpec cohort_spec = 9;
      Returns:
      The cohortSpec.

    • getCohortSpecOrBuilder

      CohortSpecOrBuilder getCohortSpecOrBuilder()
       Cohort group associated with this request. If there is a cohort group
 in the request the 'cohort' dimension must be present.
      .google.analytics.data.v1beta.CohortSpec cohort_spec = 9;

    • getKeepEmptyRows

      boolean getKeepEmptyRows()
       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 = 10;
      Returns:
      The keepEmptyRows.

    • getReturnPropertyQuota

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

    • getComparisonsList

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

    • getComparisons

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

    • getComparisonsCount

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

    • getComparisonsOrBuilderList

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

    • getComparisonsOrBuilder

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