Class: Google::Analytics::Data::V1alpha::Filter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1alpha/data.rb

Overview

An expression to filter dimension or metric values.

Defined Under Namespace

Classes: BetweenFilter, InListFilter, NumericFilter, StringFilter

Instance Attribute Summary collapse

Instance Attribute Details

#between_filter ⇒ ::Google::Analytics::Data::V1alpha::Filter::BetweenFilter

Returns A filter for two values.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'proto_docs/google/analytics/data/v1alpha/data.rb', line 216

class Filter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The filter for string
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter::MatchType]
  #     The match type for this filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     The string value used for the matching.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type of a string filter
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression match with the string value.
      FULL_REGEXP = 5

      # Partial regular expression match with the string value.
      PARTIAL_REGEXP = 6
    end
  end

  # The result needs to be in a list of string values.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     The list of string values.
  #     Must be non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Filters for numeric or date values.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Data::V1alpha::Filter::NumericFilter::Operation]
  #     The operation type for this filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     A numeric value or a date value.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal
      EQUAL = 1

      # Less than
      LESS_THAN = 2

      # Less than or equal
      LESS_THAN_OR_EQUAL = 3

      # Greater than
      GREATER_THAN = 4

      # Greater than or equal
      GREATER_THAN_OR_EQUAL = 5
    end
  end

  # To express that the result needs to be between two numbers (inclusive).
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Begins with this number.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Ends with this number.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#field_name ⇒ ::String

Returns The dimension name or metric name. Must be a name defined in dimensions or metrics.

Returns:

  • (::String) —

    The dimension name or metric name. Must be a name defined in dimensions or metrics.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'proto_docs/google/analytics/data/v1alpha/data.rb', line 216

class Filter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The filter for string
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter::MatchType]
  #     The match type for this filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     The string value used for the matching.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type of a string filter
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression match with the string value.
      FULL_REGEXP = 5

      # Partial regular expression match with the string value.
      PARTIAL_REGEXP = 6
    end
  end

  # The result needs to be in a list of string values.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     The list of string values.
  #     Must be non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Filters for numeric or date values.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Data::V1alpha::Filter::NumericFilter::Operation]
  #     The operation type for this filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     A numeric value or a date value.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal
      EQUAL = 1

      # Less than
      LESS_THAN = 2

      # Less than or equal
      LESS_THAN_OR_EQUAL = 3

      # Greater than
      GREATER_THAN = 4

      # Greater than or equal
      GREATER_THAN_OR_EQUAL = 5
    end
  end

  # To express that the result needs to be between two numbers (inclusive).
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Begins with this number.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Ends with this number.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#in_list_filter ⇒ ::Google::Analytics::Data::V1alpha::Filter::InListFilter

Returns A filter for in list values.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'proto_docs/google/analytics/data/v1alpha/data.rb', line 216

class Filter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The filter for string
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter::MatchType]
  #     The match type for this filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     The string value used for the matching.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type of a string filter
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression match with the string value.
      FULL_REGEXP = 5

      # Partial regular expression match with the string value.
      PARTIAL_REGEXP = 6
    end
  end

  # The result needs to be in a list of string values.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     The list of string values.
  #     Must be non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Filters for numeric or date values.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Data::V1alpha::Filter::NumericFilter::Operation]
  #     The operation type for this filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     A numeric value or a date value.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal
      EQUAL = 1

      # Less than
      LESS_THAN = 2

      # Less than or equal
      LESS_THAN_OR_EQUAL = 3

      # Greater than
      GREATER_THAN = 4

      # Greater than or equal
      GREATER_THAN_OR_EQUAL = 5
    end
  end

  # To express that the result needs to be between two numbers (inclusive).
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Begins with this number.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Ends with this number.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#null_filter ⇒ ::Boolean

Returns A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.

Returns:

  • (::Boolean) —

    A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'proto_docs/google/analytics/data/v1alpha/data.rb', line 216

class Filter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The filter for string
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter::MatchType]
  #     The match type for this filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     The string value used for the matching.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type of a string filter
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression match with the string value.
      FULL_REGEXP = 5

      # Partial regular expression match with the string value.
      PARTIAL_REGEXP = 6
    end
  end

  # The result needs to be in a list of string values.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     The list of string values.
  #     Must be non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Filters for numeric or date values.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Data::V1alpha::Filter::NumericFilter::Operation]
  #     The operation type for this filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     A numeric value or a date value.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal
      EQUAL = 1

      # Less than
      LESS_THAN = 2

      # Less than or equal
      LESS_THAN_OR_EQUAL = 3

      # Greater than
      GREATER_THAN = 4

      # Greater than or equal
      GREATER_THAN_OR_EQUAL = 5
    end
  end

  # To express that the result needs to be between two numbers (inclusive).
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Begins with this number.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Ends with this number.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#numeric_filter ⇒ ::Google::Analytics::Data::V1alpha::Filter::NumericFilter

Returns A filter for numeric or date values.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'proto_docs/google/analytics/data/v1alpha/data.rb', line 216

class Filter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The filter for string
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter::MatchType]
  #     The match type for this filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     The string value used for the matching.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type of a string filter
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression match with the string value.
      FULL_REGEXP = 5

      # Partial regular expression match with the string value.
      PARTIAL_REGEXP = 6
    end
  end

  # The result needs to be in a list of string values.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     The list of string values.
  #     Must be non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Filters for numeric or date values.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Data::V1alpha::Filter::NumericFilter::Operation]
  #     The operation type for this filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     A numeric value or a date value.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal
      EQUAL = 1

      # Less than
      LESS_THAN = 2

      # Less than or equal
      LESS_THAN_OR_EQUAL = 3

      # Greater than
      GREATER_THAN = 4

      # Greater than or equal
      GREATER_THAN_OR_EQUAL = 5
    end
  end

  # To express that the result needs to be between two numbers (inclusive).
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Begins with this number.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Ends with this number.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#string_filter ⇒ ::Google::Analytics::Data::V1alpha::Filter::StringFilter

Returns Strings related filter.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'proto_docs/google/analytics/data/v1alpha/data.rb', line 216

class Filter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The filter for string
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Data::V1alpha::Filter::StringFilter::MatchType]
  #     The match type for this filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     The string value used for the matching.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type of a string filter
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression match with the string value.
      FULL_REGEXP = 5

      # Partial regular expression match with the string value.
      PARTIAL_REGEXP = 6
    end
  end

  # The result needs to be in a list of string values.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     The list of string values.
  #     Must be non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     If true, the string value is case sensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Filters for numeric or date values.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Data::V1alpha::Filter::NumericFilter::Operation]
  #     The operation type for this filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     A numeric value or a date value.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal
      EQUAL = 1

      # Less than
      LESS_THAN = 2

      # Less than or equal
      LESS_THAN_OR_EQUAL = 3

      # Greater than
      GREATER_THAN = 4

      # Greater than or equal
      GREATER_THAN_OR_EQUAL = 5
    end
  end

  # To express that the result needs to be between two numbers (inclusive).
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Begins with this number.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Data::V1alpha::NumericValue]
  #     Ends with this number.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end