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.


423
424
425
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 423

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

Instance Attribute Details

#case_sensitiveBoolean Also known as: case_sensitive?

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

Returns:

  • (Boolean)

395
396
397
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 395

def case_sensitive
  @case_sensitive
end

#dimension_nameString

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

Returns:

  • (String)

401
402
403
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 401

def dimension_name
  @dimension_name
end

#expressionsArray<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>)

409
410
411
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 409

def expressions
  @expressions
end

#notBoolean 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)

415
416
417
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 415

def not
  @not
end

#operatorString

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

Returns:

  • (String)

421
422
423
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 421

def operator
  @operator
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


428
429
430
431
432
433
434
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 428

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