Package com.google.analytics.data.v1alpha

Interface MetricOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getExpression()
    A mathematical expression for derived metrics.
    com.google.protobuf.ByteString
    getExpressionBytes()
    A mathematical expression for derived metrics.
    boolean
    getInvisible()
    Indicates if a metric is invisible in the report response.
    String
    getName()
    The name of the metric.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the metric.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
 for the list of metric names supported by core reporting methods such
 as `runReport` and `batchRunReports`. See
 [Realtime
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics)
 for the list of metric names supported by the `runRealtimeReport`
 method. See
 [Funnel
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics)
 for the list of metric names supported by the `runFunnelReport`
 method.

 If `expression` is specified, `name` can be any string that you would like
 within the allowed character set. For example if `expression` is
 `screenPageViews/sessions`, you could call that metric's name =
 `viewsPerSession`. Metric names that you choose must match the regular
 expression `^[a-zA-Z0-9_]$`.

 Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
 `expression`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
 for the list of metric names supported by core reporting methods such
 as `runReport` and `batchRunReports`. See
 [Realtime
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics)
 for the list of metric names supported by the `runRealtimeReport`
 method. See
 [Funnel
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics)
 for the list of metric names supported by the `runFunnelReport`
 method.

 If `expression` is specified, `name` can be any string that you would like
 within the allowed character set. For example if `expression` is
 `screenPageViews/sessions`, you could call that metric's name =
 `viewsPerSession`. Metric names that you choose must match the regular
 expression `^[a-zA-Z0-9_]$`.

 Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
 `expression`.
      string name = 1;
      Returns:
      The bytes for name.

    • getExpression

      String getExpression()
       A mathematical expression for derived metrics. For example, the metric
 Event count per user is `eventCount/totalUsers`.
      string expression = 2;
      Returns:
      The expression.

    • getExpressionBytes

      com.google.protobuf.ByteString getExpressionBytes()
       A mathematical expression for derived metrics. For example, the metric
 Event count per user is `eventCount/totalUsers`.
      string expression = 2;
      Returns:
      The bytes for expression.

    • getInvisible

      boolean getInvisible()
       Indicates if a metric is invisible in the report response. If a metric is
 invisible, the metric will not produce a column in the response, but can be
 used in `metricFilter`, `orderBys`, or a metric `expression`.
      bool invisible = 3;
      Returns:
      The invisible.