Package com.google.analytics.data.v1beta

Interface RunRealtimeReportRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RunRealtimeReportRequest, RunRealtimeReportRequest.Builder
@Generated public interface RunRealtimeReportRequestOrBuilder 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).

 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).

 Example: properties/1234
      string property = 1;
      Returns:
      The bytes for property.

    • getDimensionsList

      List<Dimension> getDimensionsList()
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensions

      Dimension getDimensions(int index)
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensionsCount

      int getDimensionsCount()
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensionsOrBuilderList

      List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getDimensionsOrBuilder

      DimensionOrBuilder getDimensionsOrBuilder(int index)
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;

    • getMetricsList

      List<Metric> getMetricsList()
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetrics

      Metric getMetrics(int index)
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetricsCount

      int getMetricsCount()
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetricsOrBuilderList

      List<? extends MetricOrBuilder> getMetricsOrBuilderList()
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • getMetricsOrBuilder

      MetricOrBuilder getMetricsOrBuilder(int index)
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;

    • hasDimensionFilter

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

    • getDimensionFilter

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

    • getDimensionFilterOrBuilder

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

    • hasMetricFilter

      boolean hasMetricFilter()
       The filter clause of metrics. Applied at post aggregation phase, similar to
 SQL having-clause. Dimensions cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression metric_filter = 5;
      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. Dimensions cannot be used in this filter.
      .google.analytics.data.v1beta.FilterExpression metric_filter = 5;
      Returns:
      The metricFilter.

    • getMetricFilterOrBuilder

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

    • getLimit

      long getLimit()
       The 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.
      int64 limit = 6;
      Returns:
      The limit.

    • getMetricAggregationsList

      List<MetricAggregation> getMetricAggregationsList()
       Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 7;
      Returns:
      A list containing the metricAggregations.

    • getMetricAggregationsCount

      int getMetricAggregationsCount()
       Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 7;
      Returns:
      The count of metricAggregations.

    • getMetricAggregations

      MetricAggregation getMetricAggregations(int index)
       Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The metricAggregations at the given index.

    • getMetricAggregationsValueList

      List<Integer> getMetricAggregationsValueList()
       Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 7;
      Returns:
      A list containing the enum numeric values on the wire for metricAggregations.

    • getMetricAggregationsValue

      int getMetricAggregationsValue(int index)
       Aggregation of metrics. Aggregated metric values will be shown in rows
 where the dimension_values are set to "RESERVED_(MetricAggregation)".
      repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 7;
      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()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 8;

    • getOrderBys

      OrderBy getOrderBys(int index)
       Specifies how rows are ordered in the response.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 8;

    • getOrderBysCount

      int getOrderBysCount()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 8;

    • getOrderBysOrBuilderList

      List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 8;

    • getOrderBysOrBuilder

      OrderByOrBuilder getOrderBysOrBuilder(int index)
       Specifies how rows are ordered in the response.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 8;

    • getReturnPropertyQuota

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

    • getMinuteRangesList

      List<MinuteRange> getMinuteRangesList()
       The minute ranges of event data to read. If unspecified, one minute range
 for the last 30 minutes will be used. If multiple minute ranges are
 requested, each response row will contain a zero based minute range index.
 If two minute ranges overlap, the event data for the overlapping minutes is
 included in the response rows for both minute ranges.
      repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

    • getMinuteRanges

      MinuteRange getMinuteRanges(int index)
       The minute ranges of event data to read. If unspecified, one minute range
 for the last 30 minutes will be used. If multiple minute ranges are
 requested, each response row will contain a zero based minute range index.
 If two minute ranges overlap, the event data for the overlapping minutes is
 included in the response rows for both minute ranges.
      repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

    • getMinuteRangesCount

      int getMinuteRangesCount()
       The minute ranges of event data to read. If unspecified, one minute range
 for the last 30 minutes will be used. If multiple minute ranges are
 requested, each response row will contain a zero based minute range index.
 If two minute ranges overlap, the event data for the overlapping minutes is
 included in the response rows for both minute ranges.
      repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

    • getMinuteRangesOrBuilderList

      List<? extends MinuteRangeOrBuilder> getMinuteRangesOrBuilderList()
       The minute ranges of event data to read. If unspecified, one minute range
 for the last 30 minutes will be used. If multiple minute ranges are
 requested, each response row will contain a zero based minute range index.
 If two minute ranges overlap, the event data for the overlapping minutes is
 included in the response rows for both minute ranges.
      repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;

    • getMinuteRangesOrBuilder

      MinuteRangeOrBuilder getMinuteRangesOrBuilder(int index)
       The minute ranges of event data to read. If unspecified, one minute range
 for the last 30 minutes will be used. If multiple minute ranges are
 requested, each response row will contain a zero based minute range index.
 If two minute ranges overlap, the event data for the overlapping minutes is
 included in the response rows for both minute ranges.
      repeated .google.analytics.data.v1beta.MinuteRange minute_ranges = 10;