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



331
332
333
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 331

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) 


323
324
325
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 323

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) 


317
318
319
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 317

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) 


304
305
306
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 304

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) 


329
330
331
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 329

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) 


312
313
314
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 312

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



336
337
338
339
340
341
342
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 336

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