Package com.google.analytics.data.v1beta

Class RunRealtimeReportRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1beta.RunRealtimeReportRequest
All Implemented Interfaces:
RunRealtimeReportRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RunRealtimeReportRequest extends com.google.protobuf.GeneratedMessage implements RunRealtimeReportRequestOrBuilder
 The request to generate a realtime report.
Protobuf type google.analytics.data.v1beta.RunRealtimeReportRequest
See Also:

  • Field Details

    • PROPERTY_FIELD_NUMBER

      public static final int PROPERTY_FIELD_NUMBER
      See Also:

    • DIMENSIONS_FIELD_NUMBER

      public static final int DIMENSIONS_FIELD_NUMBER
      See Also:

    • METRICS_FIELD_NUMBER

      public static final int METRICS_FIELD_NUMBER
      See Also:

    • DIMENSION_FILTER_FIELD_NUMBER

      public static final int DIMENSION_FILTER_FIELD_NUMBER
      See Also:

    • METRIC_FILTER_FIELD_NUMBER

      public static final int METRIC_FILTER_FIELD_NUMBER
      See Also:

    • LIMIT_FIELD_NUMBER

      public static final int LIMIT_FIELD_NUMBER
      See Also:

    • METRIC_AGGREGATIONS_FIELD_NUMBER

      public static final int METRIC_AGGREGATIONS_FIELD_NUMBER
      See Also:

    • ORDER_BYS_FIELD_NUMBER

      public static final int ORDER_BYS_FIELD_NUMBER
      See Also:

    • RETURN_PROPERTY_QUOTA_FIELD_NUMBER

      public static final int RETURN_PROPERTY_QUOTA_FIELD_NUMBER
      See Also:

    • MINUTE_RANGES_FIELD_NUMBER

      public static final int MINUTE_RANGES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getProperty

      public 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;
      Specified by:
      getProperty in interface RunRealtimeReportRequestOrBuilder
      Returns:
      The property.

    • getPropertyBytes

      public 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;
      Specified by:
      getPropertyBytes in interface RunRealtimeReportRequestOrBuilder
      Returns:
      The bytes for property.

    • getDimensionsList

      public List<Dimension> getDimensionsList()
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
      Specified by:
      getDimensionsList in interface RunRealtimeReportRequestOrBuilder

    • getDimensionsOrBuilderList

      public List<? extends DimensionOrBuilder> getDimensionsOrBuilderList()
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
      Specified by:
      getDimensionsOrBuilderList in interface RunRealtimeReportRequestOrBuilder

    • getDimensionsCount

      public int getDimensionsCount()
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
      Specified by:
      getDimensionsCount in interface RunRealtimeReportRequestOrBuilder

    • getDimensions

      public Dimension getDimensions(int index)
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
      Specified by:
      getDimensions in interface RunRealtimeReportRequestOrBuilder

    • getDimensionsOrBuilder

      public DimensionOrBuilder getDimensionsOrBuilder(int index)
       The dimensions requested and displayed.
      repeated .google.analytics.data.v1beta.Dimension dimensions = 2;
      Specified by:
      getDimensionsOrBuilder in interface RunRealtimeReportRequestOrBuilder

    • getMetricsList

      public List<Metric> getMetricsList()
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;
      Specified by:
      getMetricsList in interface RunRealtimeReportRequestOrBuilder

    • getMetricsOrBuilderList

      public List<? extends MetricOrBuilder> getMetricsOrBuilderList()
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;
      Specified by:
      getMetricsOrBuilderList in interface RunRealtimeReportRequestOrBuilder

    • getMetricsCount

      public int getMetricsCount()
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;
      Specified by:
      getMetricsCount in interface RunRealtimeReportRequestOrBuilder

    • getMetrics

      public Metric getMetrics(int index)
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;
      Specified by:
      getMetrics in interface RunRealtimeReportRequestOrBuilder

    • getMetricsOrBuilder

      public MetricOrBuilder getMetricsOrBuilder(int index)
       The metrics requested and displayed.
      repeated .google.analytics.data.v1beta.Metric metrics = 3;
      Specified by:
      getMetricsOrBuilder in interface RunRealtimeReportRequestOrBuilder

    • hasDimensionFilter

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

    • getDimensionFilter

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

    • getDimensionFilterOrBuilder

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

    • hasMetricFilter

      public 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;
      Specified by:
      hasMetricFilter in interface RunRealtimeReportRequestOrBuilder
      Returns:
      Whether the metricFilter field is set.

    • getMetricFilter

      public 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;
      Specified by:
      getMetricFilter in interface RunRealtimeReportRequestOrBuilder
      Returns:
      The metricFilter.

    • getMetricFilterOrBuilder

      public 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;
      Specified by:
      getMetricFilterOrBuilder in interface RunRealtimeReportRequestOrBuilder

    • getLimit

      public 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;
      Specified by:
      getLimit in interface RunRealtimeReportRequestOrBuilder
      Returns:
      The limit.

    • getMetricAggregationsList

      public 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;
      Specified by:
      getMetricAggregationsList in interface RunRealtimeReportRequestOrBuilder
      Returns:
      A list containing the metricAggregations.

    • getMetricAggregationsCount

      public 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;
      Specified by:
      getMetricAggregationsCount in interface RunRealtimeReportRequestOrBuilder
      Returns:
      The count of metricAggregations.

    • getMetricAggregations

      public 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;
      Specified by:
      getMetricAggregations in interface RunRealtimeReportRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The metricAggregations at the given index.

    • getMetricAggregationsValueList

      public 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;
      Specified by:
      getMetricAggregationsValueList in interface RunRealtimeReportRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for metricAggregations.

    • getMetricAggregationsValue

      public 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;
      Specified by:
      getMetricAggregationsValue in interface RunRealtimeReportRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of metricAggregations at the given index.

    • getOrderBysList

      public List<OrderBy> getOrderBysList()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 8;
      Specified by:
      getOrderBysList in interface RunRealtimeReportRequestOrBuilder

    • getOrderBysOrBuilderList

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

    • getOrderBysCount

      public int getOrderBysCount()
       Specifies how rows are ordered in the response.
      repeated .google.analytics.data.v1beta.OrderBy order_bys = 8;
      Specified by:
      getOrderBysCount in interface RunRealtimeReportRequestOrBuilder

    • getOrderBys

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

    • getOrderBysOrBuilder

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

    • getReturnPropertyQuota

      public 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;
      Specified by:
      getReturnPropertyQuota in interface RunRealtimeReportRequestOrBuilder
      Returns:
      The returnPropertyQuota.

    • getMinuteRangesList

      public 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;
      Specified by:
      getMinuteRangesList in interface RunRealtimeReportRequestOrBuilder

    • getMinuteRangesOrBuilderList

      public 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;
      Specified by:
      getMinuteRangesOrBuilderList in interface RunRealtimeReportRequestOrBuilder

    • getMinuteRangesCount

      public 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;
      Specified by:
      getMinuteRangesCount in interface RunRealtimeReportRequestOrBuilder

    • getMinuteRanges

      public 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;
      Specified by:
      getMinuteRanges in interface RunRealtimeReportRequestOrBuilder

    • getMinuteRangesOrBuilder

      public 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;
      Specified by:
      getMinuteRangesOrBuilder in interface RunRealtimeReportRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunRealtimeReportRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunRealtimeReportRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunRealtimeReportRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RunRealtimeReportRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RunRealtimeReportRequest.Builder newBuilder()

    • newBuilder

      public static RunRealtimeReportRequest.Builder newBuilder(RunRealtimeReportRequest prototype)

    • toBuilder

      public RunRealtimeReportRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RunRealtimeReportRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RunRealtimeReportRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RunRealtimeReportRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RunRealtimeReportRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RunRealtimeReportRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder