Class: Google::Analytics::Data::V1beta::Metric

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1beta/data.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#expression ⇒ ::String

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



202
203
204
205
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 202

class Metric
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#invisible ⇒ ::Boolean

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



202
203
204
205
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 202

class Metric
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns The name of the metric. See the API Metrics for the list of metric names supported by core reporting methods such as runReport and batchRunReports. See Realtime Metrics for the list of metric names supported by the runRealtimeReport method. See Funnel 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.

Returns:

  • (::String) —

    The name of the metric. See the API Metrics for the list of metric names supported by core reporting methods such as runReport and batchRunReports. See Realtime Metrics for the list of metric names supported by the runRealtimeReport method. See Funnel 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.



202
203
204
205
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 202

class Metric
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end