Class: Google::Apis::AnalyticsreportingV4::DimensionFilter

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

Dimension filter specifies the filtering options on a dimension.

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

Returns a new instance of DimensionFilter



589
590
591
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 589

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

Instance Attribute Details

#case_sensitive ⇒ Boolean Also known as: case_sensitive?

Should the match be case sensitive? Default is false. Corresponds to the JSON property caseSensitive

Returns:

  • (Boolean) 


586
587
588
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 586

def case_sensitive
  @case_sensitive
end

#dimension_name ⇒ String

The dimension to filter on. A DimensionFilter must contain a dimension. Corresponds to the JSON property dimensionName

Returns:

  • (String) 


561
562
563
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 561

def dimension_name
  @dimension_name
end

#expressions ⇒ Array<String>

Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is IN_LIST. If IN_LIST operator, then the entire list is used to filter the dimensions as explained in the description of the IN_LIST operator. Corresponds to the JSON property expressions

Returns:

  • (Array<String>) 


581
582
583
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 581

def expressions
  @expressions
end

#not ⇒ Boolean Also known as: not?

Logical NOT operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false. Corresponds to the JSON property not

Returns:

  • (Boolean) 


572
573
574
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 572

def not
  @not
end

#operator ⇒ String

How to match the dimension to the expression. The default is REGEXP. Corresponds to the JSON property operator

Returns:

  • (String) 


566
567
568
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 566

def operator
  @operator
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



594
595
596
597
598
599
600
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 594

def update!(**args)
  @dimension_name = args[:dimension_name] if args.key?(:dimension_name)
  @operator = args[:operator] if args.key?(:operator)
  @not = args[:not] if args.key?(:not)
  @expressions = args[:expressions] if args.key?(:expressions)
  @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
end