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



841
842
843
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 841

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) 


839
840
841
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 839

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) 


833
834
835
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 833

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) 


820
821
822
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 820

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) 


814
815
816
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 814

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) 


828
829
830
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 828

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



846
847
848
849
850
851
852
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 846

def update!(**args)
  @operator = args[:operator] if args.key?(:operator)
  @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)
end