Class: Google::Apis::AnalyticsreportingV4::Metric

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analyticsreporting_v4/classes.rb,
generated/google/apis/analyticsreporting_v4/representations.rb,
generated/google/apis/analyticsreporting_v4/representations.rb

Overview

Metrics are the quantitative measurements. For example, the metric ga:users indicates the total number of users for the requested time period.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Metric

Returns a new instance of Metric.


759
760
761
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 759

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aliasString

An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header. Corresponds to the JSON property alias

Returns:

  • (String)

741
742
743
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 741

def alias
  @alias
end

#expressionString

A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example ga:totalRefunds/ga:users, in most cases the metric expression is just a single metric name like ga:users. Adding mixed MetricType (E.g., CURRENCY + PERCENTAGE) metrics will result in unexpected results. Corresponds to the JSON property expression

Returns:

  • (String)

752
753
754
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 752

def expression
  @expression
end

#formatting_typeString

Specifies how the metric expression should be formatted, for example INTEGER. Corresponds to the JSON property formattingType

Returns:

  • (String)

757
758
759
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 757

def formatting_type
  @formatting_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


764
765
766
767
768
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 764

def update!(**args)
  @alias = args[:alias] if args.key?(:alias)
  @expression = args[:expression] if args.key?(:expression)
  @formatting_type = args[:formatting_type] if args.key?(:formatting_type)
end