Google Analytics Data V1beta API - Class Google::Analytics::Data::V1beta::Metric (v0.4.3)

Reference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::Metric.

The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#expression

def expression() -> ::String
Returns
  • (::String) — A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

#expression=

def expression=(value) -> ::String
Parameter
  • value (::String) — A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.
Returns
  • (::String) — A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

#invisible

def invisible() -> ::Boolean
Returns
  • (::Boolean) — 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.

#invisible=

def invisible=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#name

def name() -> ::String
Returns
  • (::String) — The name of the metric. See the API Metrics for the list of metric names.

    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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The name of the metric. See the API Metrics for the list of metric names.

    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.

Returns
  • (::String) — The name of the metric. See the API Metrics for the list of metric names.

    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.