Class: Google::Apis::AnalyticsreportingV4::SegmentMetricFilter

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

Metric filter to be used in a segment filter clause.

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) ⇒ SegmentMetricFilter

Returns a new instance of SegmentMetricFilter



719
720
721
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 719

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

Instance Attribute Details

#comparison_value ⇒ String

The value to compare against. If the operator is BETWEEN, this value is treated as minimum comparison value. Corresponds to the JSON property comparisonValue

Returns:

  • (String) 


711
712
713
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 711

def comparison_value
  @comparison_value
end

#max_comparison_value ⇒ String

Max comparison value is only used for BETWEEN operator. Corresponds to the JSON property maxComparisonValue

Returns:

  • (String) 


705
706
707
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 705

def max_comparison_value
  @max_comparison_value
end

#metric_name ⇒ String

The metric that will be filtered on. A metricFilter must contain a metric name. Corresponds to the JSON property metricName

Returns:

  • (String) 


692
693
694
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 692

def metric_name
  @metric_name
end

#operator ⇒ String

Specifies is the operation to perform to compare the metric. The default is EQUAL. Corresponds to the JSON property operator

Returns:

  • (String) 


717
718
719
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 717

def operator
  @operator
end

#scope ⇒ String

Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions. Corresponds to the JSON property scope

Returns:

  • (String) 


700
701
702
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 700

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



724
725
726
727
728
729
730
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 724

def update!(**args)
  @metric_name = args[:metric_name] if args.key?(:metric_name)
  @scope = args[:scope] if args.key?(:scope)
  @max_comparison_value = args[:max_comparison_value] if args.key?(:max_comparison_value)
  @comparison_value = args[:comparison_value] if args.key?(:comparison_value)
  @operator = args[:operator] if args.key?(:operator)
end