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



1293
1294
1295
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1293

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) 


1265
1266
1267
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1265

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) 


1276
1277
1278
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1276

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


1284
1285
1286
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1284

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) 


1290
1291
1292
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1290

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) 


1271
1272
1273
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1271

def operator
  @operator
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1298
1299
1300
1301
1302
1303
1304
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1298

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